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
| | ;;; quail.el --- provides simple input method for multilingual text -*- lexical-binding: t; -*-
;; Copyright (C) 1997-1998, 2000-2023 Free Software Foundation, Inc.
;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
;; 2005, 2006, 2007, 2008, 2009, 2010, 2011
;; National Institute of Advanced Industrial Science and Technology (AIST)
;; Registration Number H14PRO021
;; Author: Kenichi Handa <handa@gnu.org>
;; Naoto Takahashi <ntakahas@etl.go.jp>
;; Maintainer: emacs-devel@gnu.org
;; Keywords: mule, multilingual, input method, i18n
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;; In Quail minor mode, you can input multilingual text easily. By
;; defining a translation table (named Quail map) which maps ASCII key
;; string to multilingual character or string, you can input any text
;; from ASCII keyboard.
;;
;; We use words "translation" and "conversion" differently. The
;; former is done by Quail package itself, the latter is the further
;; process of converting a translated text to some more desirable
;; text. For instance, Quail package for Japanese (`quail-jp')
;; translates Roman text (transliteration of Japanese in Latin
;; alphabets) to Hiragana text, which is then converted to
;; Kanji-and-Kana mixed text or Katakana text by commands specified in
;; CONVERSION-KEYS argument of the Quail package.
;; [There was an input method for Mule 2.3 called `Tamago' from the
;; Japanese `TAkusan MAtasete GOmen-nasai', or `Sorry for having you
;; wait so long'; this couldn't be included in Emacs 20. `Tamago' is
;; Japanese for `egg' (implicitly a hen's egg). Handa-san made a
;; smaller and simpler system; the smaller quail egg is also eaten in
;; Japan. Maybe others will be egged on to write more sorts of input
;; methods.]
;;; Code:
(require 'help-mode)
(eval-when-compile (require 'cl-lib))
(defgroup quail nil
"Quail: multilingual input method."
:group 'leim)
;; Buffer local variables
(defvar-local quail-current-package nil
"The current Quail package, which depends on the current input method.
See the documentation of `quail-package-alist' for the format.")
(put 'quail-current-package 'permanent-local t)
;; Quail uses the following variables to assist users.
;; A string containing available key sequences or translation list.
(defvar-local quail-guidance-str nil)
;; A buffer to show completion list of the current key sequence.
(defvar quail-completion-buf nil)
;; We may display the guidance string in a buffer on a one-line frame.
(defvar quail-guidance-buf nil)
(defvar quail-guidance-frame nil)
;; Each buffer in which Quail is activated should use different
;; guidance string.
(put 'quail-guidance-str 'permanent-local t)
(defvar-local quail-overlay nil
"Overlay which covers the current translation region of Quail.")
(defvar-local quail-conv-overlay nil
"Overlay which covers the text to be converted in Quail mode.")
(defvar-local quail-current-key nil
"Current key for translation in Quail mode.")
(defvar-local quail-current-str nil
"Currently selected translation of the current key.")
(defvar-local quail-current-translations nil
"Cons of indices and vector of possible translations of the current key.
Indices is a list of (CURRENT START END BLOCK BLOCKS), where
CURRENT is an index of the current translation,
START and END are indices of the start and end of the current block,
BLOCK is the current block index,
BLOCKS is a number of blocks of translation.")
(defvar-local quail-current-data nil
"Any Lisp object holding information of current translation status.
When a key sequence is mapped to TRANS and TRANS is a cons
of actual translation and some Lisp object to be referred
for translating the longer key sequence, this variable is set
to that Lisp object.")
;; Quail package handlers.
(defvar quail-package-alist nil
"List of Quail packages.
A Quail package is a list of these elements:
NAME, TITLE, QUAIL-MAP, GUIDANCE, DOCSTRING, TRANSLATION-KEYS,
FORGET-LAST-SELECTION, DETERMINISTIC, KBD-TRANSLATE, SHOW-LAYOUT,
DECODE-MAP, MAXIMUM-SHORTEST, OVERLAY-PLIST, UPDATE-TRANSLATION-FUNCTION,
CONVERSION-KEYS, SIMPLE.
QUAIL-MAP is a data structure to map key strings to translations. For
the format, see the documentation of `quail-map-p'.
DECODE-MAP is an alist of translations and corresponding keys.
See the documentation of `quail-define-package' for the other elements.")
;; Return various slots in the current quail-package.
(defsubst quail-name ()
"Return the name of the current Quail package."
(nth 0 quail-current-package))
(defun quail-indent-to (col)
(indent-to col)
(let ((end (point)))
(save-excursion
(unless (zerop (skip-chars-backward "\t "))
(put-text-property (point) end 'display (list 'space :align-to col))))))
;;;###autoload
(defun quail-title ()
"Return the title of the current Quail package."
(let ((title (nth 1 quail-current-package)))
;; TITLE may be a string or a list. If it is a list, each element
;; is a string or the form (VAR STR1 STR2), and the interpretation
;; of the list is the same as that of mode-line-format.
(if (stringp title)
title
(condition-case nil
(mapconcat
(lambda (x)
(cond ((stringp x) x)
((and (listp x) (symbolp (car x)) (= (length x) 3))
(if (symbol-value (car x))
(nth 1 x) (nth 2 x)))
(t "")))
title "")
(error "")))))
(defsubst quail-map ()
"Return the translation map of the current Quail package."
(nth 2 quail-current-package))
(defsubst quail-guidance ()
"Return an object used for `guidance' feature of the current Quail package.
See also the documentation of `quail-define-package'."
(nth 3 quail-current-package))
(defsubst quail-docstring ()
"Return the documentation string of the current Quail package."
(nth 4 quail-current-package))
(defsubst quail-translation-keymap ()
"Return translation keymap in the current Quail package.
Translation keymap is a keymap used while translation region is active."
(nth 5 quail-current-package))
(defsubst quail-forget-last-selection ()
"Return `forget-last-selection' flag of the current Quail package.
See also the documentation of `quail-define-package'."
(nth 6 quail-current-package))
(defsubst quail-deterministic ()
"Return `deterministic' flag of the current Quail package.
See also the documentation of `quail-define-package'."
(nth 7 quail-current-package))
(defsubst quail-kbd-translate ()
"Return `kbd-translate' flag of the current Quail package.
See also the documentation of `quail-define-package'."
(nth 8 quail-current-package))
(defsubst quail-show-layout ()
"Return `show-layout' flag of the current Quail package.
See also the documentation of `quail-define-package'."
(nth 9 quail-current-package))
(defsubst quail-decode-map ()
"Return decode map of the current Quail package.
It is an alist of translations and corresponding keys."
(nth 10 quail-current-package))
(defsubst quail-maximum-shortest ()
"Return `maximum-shortest' flag of the current Quail package.
See also the documentation of `quail-define-package'."
(nth 11 quail-current-package))
(defsubst quail-overlay-plist ()
"Return property list of an overlay used in the current Quail package."
(nth 12 quail-current-package))
(defsubst quail-update-translation-function ()
"Return a function for updating translation in the current Quail package."
(nth 13 quail-current-package))
(defsubst quail-conversion-keymap ()
"Return conversion keymap in the current Quail package.
Conversion keymap is a keymap used while conversion region is active
but translation region is not active."
(nth 14 quail-current-package))
(defsubst quail-simple ()
"Return t if the current Quail package is simple."
(nth 15 quail-current-package))
(defsubst quail-package (name)
"Return Quail package named NAME."
(assoc name quail-package-alist))
(defun quail-add-package (package)
"Add Quail package PACKAGE to `quail-package-alist'."
(let ((pac (quail-package (car package))))
(if pac
(setcdr pac (cdr package))
(setq quail-package-alist (cons package quail-package-alist)))))
(defun quail-select-package (name)
"Select Quail package named NAME as the current Quail package."
(let ((package (quail-package name)))
(if (null package)
(error "No Quail package `%s'" name))
(setq quail-current-package package)
(setq-default quail-current-package package)
name))
;;;###autoload
(defun quail-use-package (package-name &rest libraries)
"Start using Quail package PACKAGE-NAME.
The remaining arguments are LIBRARIES to be loaded before using the package.
This activates input method defined by PACKAGE-NAME by running
`quail-activate', which see."
(let ((package (quail-package package-name)))
(if (null package)
;; Perhaps we have not yet loaded necessary libraries.
(while libraries
(if (not (load (car libraries) t))
(progn
(with-output-to-temp-buffer "*Help*"
(princ "Quail package \"")
(princ package-name)
(princ (substitute-command-keys
"\" can't be activated\n because library \""))
(princ (car libraries))
(princ (substitute-command-keys "\" is not in `load-path'.
This might indicate a problem with your Emacs installation, as
LEIM (Libraries of Emacs Input Method) should normally always be
installed together with Emacs.")))
(error "Can't use the Quail package `%s'" package-name))
(setq libraries (cdr libraries))))))
(quail-select-package package-name)
(setq current-input-method-title (quail-title))
(quail-activate)
;; Hide all '... loaded' message.
(message nil))
(defvar quail-translation-keymap
(let ((map (make-keymap))
(i 0))
(while (< i ?\ )
(define-key map (char-to-string i) 'quail-other-command)
(setq i (1+ i)))
(while (< i 127)
(define-key map (char-to-string i) 'quail-self-insert-command)
(setq i (1+ i)))
(setq i 128)
(while (< i 256)
(define-key map (vector i) 'quail-self-insert-command)
(setq i (1+ i)))
(define-key map "\177" 'quail-delete-last-char)
(define-key map "\C-f" 'quail-next-translation)
(define-key map "\C-b" 'quail-prev-translation)
(define-key map "\C-n" 'quail-next-translation-block)
(define-key map "\C-p" 'quail-prev-translation-block)
(define-key map [right] 'quail-next-translation)
(define-key map [left] 'quail-prev-translation)
(define-key map [down] 'quail-next-translation-block)
(define-key map [up] 'quail-prev-translation-block)
(define-key map "\C-i" 'quail-completion)
(define-key map "\C-@" 'quail-select-current)
;; Following simple.el, Enter key on numeric keypad selects the
;; current translation just like `C-SPC', and `mouse-2' chooses
;; any completion visible in the *Quail Completions* buffer.
(define-key map [kp-enter] 'quail-select-current)
(define-key map [mouse-2] 'quail-mouse-choose-completion)
(define-key map [down-mouse-2] nil)
(define-key map "\C-h" 'quail-translation-help)
(define-key map [?\C- ] 'quail-select-current)
(define-key map [tab] 'quail-completion)
(define-key map [delete] 'quail-delete-last-char)
(define-key map [backspace] 'quail-delete-last-char)
map)
"Keymap used processing translation in complex Quail modes.
Only a few especially complex input methods use this map;
most use `quail-simple-translation-keymap' instead.
This map is activated while translation region is active.")
(defvar quail-translation-docstring
"When you type keys, the echo area shows the possible characters
which correspond to that key sequence, each preceded by a digit. You
can select one of the characters shown by typing the corresponding
digit. Alternatively, you can use C-f and C-b to move through the
line to select the character you want, then type a letter to begin
entering another Chinese character or type a space or punctuation
character.
If there are more than ten possible characters for the given spelling,
the echo area shows ten characters at a time; you can use C-n to move
to the next group of ten, and C-p to move back to the previous group
of ten.")
;; Categorize each Quail commands to make the output of quail-help
;; concise. This is done by putting `quail-help' property. The value
;; is:
;; hide -- never show this command
;; non-deterministic -- show only for non-deterministic input method
(let ((l '((quail-other-command . hide)
(quail-self-insert-command . hide)
(quail-delete-last-char . hide)
(quail-next-translation . non-deterministic)
(quail-prev-translation . non-deterministic)
(quail-next-translation-block . non-deterministic)
(quail-prev-translation-block . non-deterministic))))
(while l
(put (car (car l)) 'quail-help (cdr (car l)))
(setq l (cdr l))))
(defvar quail-simple-translation-keymap
(let ((map (make-keymap))
(i 0))
(while (< i ?\ )
(define-key map (char-to-string i) 'quail-other-command)
(setq i (1+ i)))
(while (< i 127)
(define-key map (char-to-string i) 'quail-self-insert-command)
(setq i (1+ i)))
(setq i 128)
(while (< i 256)
(define-key map (vector i) 'quail-self-insert-command)
(setq i (1+ i)))
(define-key map "\177" 'quail-delete-last-char)
(define-key map [delete] 'quail-delete-last-char)
(define-key map [backspace] 'quail-delete-last-char)
;;(let ((meta-map (make-sparse-keymap)))
;;(define-key map (char-to-string meta-prefix-char) meta-map)
;;(define-key map [escape] meta-map))
map)
"Keymap used while processing translation in simple Quail modes.
A few especially complex input methods use `quail-translation-keymap' instead.
This map is activated while translation region is active.")
(defvar quail-conversion-keymap
(let ((map (make-keymap))
(i ?\ ))
(while (< i 127)
(define-key map (char-to-string i) 'quail-self-insert-command)
(setq i (1+ i)))
(setq i 128)
(while (< i 256)
(define-key map (vector i) 'quail-self-insert-command)
(setq i (1+ i)))
(define-key map "\C-b" 'quail-conversion-backward-char)
(define-key map "\C-f" 'quail-conversion-forward-char)
(define-key map "\C-a" 'quail-conversion-beginning-of-region)
(define-key map "\C-e" 'quail-conversion-end-of-region)
(define-key map "\C-d" 'quail-conversion-delete-char)
(define-key map "\C-k" 'quail-conversion-delete-tail)
(define-key map "\C-h" 'quail-translation-help)
(define-key map "\177" 'quail-conversion-backward-delete-char)
(define-key map [delete] 'quail-conversion-backward-delete-char)
(define-key map [backspace] 'quail-conversion-backward-delete-char)
map)
"Keymap used for processing conversion in Quail mode.
This map is activated while conversion region is active but translation
region is not active.")
;; Just a dummy definition.
(defun quail-other-command ()
(interactive)
)
;;;###autoload
(defun quail-define-package (name language title
&optional guidance docstring translation-keys
forget-last-selection deterministic
kbd-translate show-layout create-decode-map
maximum-shortest overlay-plist
update-translation-function
conversion-keys simple)
"Define NAME as a new Quail package for input LANGUAGE.
TITLE is a string to be displayed at mode-line to indicate this package.
Optional arguments are GUIDANCE, DOCSTRING, TRANSLATION-KEYS,
FORGET-LAST-SELECTION, DETERMINISTIC, KBD-TRANSLATE, SHOW-LAYOUT,
CREATE-DECODE-MAP, MAXIMUM-SHORTEST, OVERLAY-PLIST,
UPDATE-TRANSLATION-FUNCTION, CONVERSION-KEYS and SIMPLE.
GUIDANCE specifies how a guidance string is shown in echo area.
If it is t, list of all possible translations for the current key is shown
with the currently selected translation being highlighted.
If it is an alist, the element has the form (CHAR . STRING). Each character
in the current key is searched in the list and the corresponding string is
shown.
If it is nil, the current key is shown.
DOCSTRING is the documentation string of this package. The command
`describe-input-method' shows this string while replacing the form
\\=\\=\\=\\<VAR> in the string by the value of VAR. That value should be a
string. For instance, the form \\=\\=\\=\\<quail-translation-docstring> is
replaced by a description about how to select a translation from a
list of candidates.
TRANSLATION-KEYS specifies additional key bindings used while translation
region is active. It is an alist of single key character vs. corresponding
command to be called.
FORGET-LAST-SELECTION non-nil means a selected translation is not kept
for the future to translate the same key. If this flag is nil, a
translation selected for a key is remembered so that it can be the
first candidate when the same key is entered later.
DETERMINISTIC non-nil means the first candidate of translation is
selected automatically without allowing users to select another
translation for a key. In this case, unselected translations are of
no use for an interactive use of Quail but can be used by some other
programs. If this flag is non-nil, FORGET-LAST-SELECTION is also set
to t.
KBD-TRANSLATE non-nil means input characters are translated from a
user's keyboard layout to the standard keyboard layout. See the
documentation of `quail-keyboard-layout' and
`quail-keyboard-layout-standard' for more detail.
SHOW-LAYOUT non-nil means the function `quail-help' (as used by
the command `describe-input-method') should show the user's keyboard
layout visually with translated characters. If KBD-TRANSLATE is
set, it is desirable to also set this flag, unless this package
defines no translations for single character keys.
CREATE-DECODE-MAP non-nil means decode map is also created. A decode
map is an alist of translations and corresponding original keys.
Although this map is not used by Quail itself, it can be used by some
other programs. For instance, Vietnamese supporting needs this map to
convert Vietnamese text to VIQR format which uses only ASCII
characters to represent Vietnamese characters.
MAXIMUM-SHORTEST non-nil means break key sequence to get maximum
length of the shortest sequence. When we don't have a translation of
key \"..ABCD\" but have translations of \"..AB\" and \"CD..\", break
the key at \"..AB\" and start translation of \"CD..\". Hangul
packages, for instance, use this facility. If this flag is nil, we
break the key just at \"..ABC\" and start translation of \"D..\".
OVERLAY-PLIST if non-nil is a property list put on an overlay which
covers Quail translation region.
UPDATE-TRANSLATION-FUNCTION if non-nil is a function to call to update
the current translation region according to a new translation data. By
default, a translated text or a user's key sequence (if no translation
for it) is inserted.
CONVERSION-KEYS specifies additional key bindings used while
conversion region is active. It is an alist of single key character
vs. corresponding command to be called.
If SIMPLE is non-nil, then we do not alter the meanings of
commands such as \\[forward-char], \\[backward-char], \\[next-line], \
\\[previous-line] and \\[indent-for-tab-command]; they are treated as
non-Quail commands."
(let (translation-keymap conversion-keymap)
(if deterministic (setq forget-last-selection t))
(if translation-keys
(progn
(setq translation-keymap (copy-keymap
(if simple quail-simple-translation-keymap
quail-translation-keymap)))
(dolist (trans translation-keys)
(define-key translation-keymap (car trans) (cdr trans))))
(setq translation-keymap
(if simple quail-simple-translation-keymap
quail-translation-keymap)))
(when conversion-keys
(setq conversion-keymap (copy-keymap quail-conversion-keymap))
(dolist (conv conversion-keys)
(define-key conversion-keymap (car conv) (cdr conv))))
(quail-add-package
(list name title (list nil) guidance (or docstring "")
translation-keymap
forget-last-selection deterministic kbd-translate show-layout
(if create-decode-map (list 'decode-map) nil)
maximum-shortest overlay-plist update-translation-function
conversion-keymap simple))
;; Update input-method-alist.
(let ((slot (assoc name input-method-alist))
(val (list language 'quail-use-package title docstring)))
(if slot (setcdr slot val)
(setq input-method-alist (cons (cons name val) input-method-alist)))))
(quail-select-package name))
;; Quail minor mode handlers.
;; Setup overlays used in Quail mode.
(defun quail-setup-overlays (conversion-mode)
(let ((pos (point)))
(if (overlayp quail-overlay)
(move-overlay quail-overlay pos pos)
(setq quail-overlay (make-overlay pos pos))
(if input-method-highlight-flag
(overlay-put quail-overlay 'face 'underline))
(let ((l (quail-overlay-plist)))
(while l
(overlay-put quail-overlay (car l) (car (cdr l)))
(setq l (cdr (cdr l))))))
(if conversion-mode
(if (overlayp quail-conv-overlay)
(if (not (overlay-start quail-conv-overlay))
(move-overlay quail-conv-overlay pos pos))
(setq quail-conv-overlay (make-overlay pos pos))
(if input-method-highlight-flag
(overlay-put quail-conv-overlay 'face 'underline))))))
;; Delete overlays used in Quail mode.
(defun quail-delete-overlays ()
(if (and (overlayp quail-overlay) (overlay-start quail-overlay))
(delete-overlay quail-overlay))
(if (and (overlayp quail-conv-overlay) (overlay-start quail-conv-overlay))
(delete-overlay quail-conv-overlay)))
(defun quail-deactivate ()
"Deactivate Quail input method.
This function runs the normal hook `quail-deactivate-hook'."
(interactive)
(quail-activate -1))
(defun quail-activate (&optional arg)
"Activate Quail input method.
With ARG, activate Quail input method if and only if arg is positive.
This function runs `quail-activate-hook' if it activates the input
method, `quail-deactivate-hook' if it deactivates it.
While this input method is active, the variable
`input-method-function' is bound to the function `quail-input-method'."
(if (and arg
(< (prefix-numeric-value arg) 0))
;; Let's deactivate Quail input method.
(unwind-protect
(progn
(quail-delete-overlays)
(setq describe-current-input-method-function nil)
(quail-hide-guidance)
(remove-hook 'post-command-hook #'quail-show-guidance t)
(run-hooks 'quail-deactivate-hook))
(kill-local-variable 'input-method-function))
;; Let's activate Quail input method.
(if (null quail-current-package)
;; Quail package is not yet selected. Select one now.
(let (name)
(if quail-package-alist
(setq name (car (car quail-package-alist)))
(error "No Quail package loaded"))
(quail-select-package name)))
(setq deactivate-current-input-method-function #'quail-deactivate)
(setq describe-current-input-method-function #'quail-help)
(quail-delete-overlays)
(setq quail-guidance-str "")
(quail-show-guidance)
;; If we are in minibuffer, turn off the current input method
;; before exiting.
(when (eq (selected-window) (minibuffer-window))
(add-hook 'minibuffer-exit-hook #'quail-exit-from-minibuffer)
(add-hook 'post-command-hook #'quail-show-guidance nil t))
(run-hooks 'quail-activate-hook)
(setq-local input-method-function #'quail-input-method)))
(defun quail-exit-from-minibuffer ()
(deactivate-input-method)
(if (<= (minibuffer-depth) 1)
(remove-hook 'minibuffer-exit-hook 'quail-exit-from-minibuffer)))
;; Keyboard layout translation handlers.
;; Some Quail packages provide localized keyboard simulation which
;; requires a particular keyboard layout. In this case, what we need
;; is locations of keys the user entered, not character codes
;; generated by those keys. However, for the moment, there's no
;; common way to get such information. So, we ask a user to give
;; information of his own keyboard layout, then translate it to the
;; standard layout which we defined so that all Quail packages depend
;; just on it.
(defconst quail-keyboard-layout-standard
"\
\
1!2@3#4$5%6^7&8*9(0)-_=+`~ \
qQwWeErRtTyYuUiIoOpP[{]} \
aAsSdDfFgGhHjJkKlL;:'\"\\| \
zZxXcCvVbBnNmM,<.>/? \
"
"Standard keyboard layout of printable characters Quail assumes.
See the documentation of `quail-keyboard-layout' for this format.
This layout is almost the same as that of VT100,
but the location of key \\ (backslash) is just right of key \\=' (single-quote),
not right of RETURN key.")
(defconst quail-keyboard-layout-len 180)
;; Here we provide several examples of famous keyboard layouts.
;; This is a candidate for a language environment-dependent setting.
(defvar quail-keyboard-layout-alist
(list
(cons "standard" quail-keyboard-layout-standard)
'("sun-type3" . "\
\
1!2@3#4$5%6^7&8*9(0)-_=+\\|`~\
qQwWeErRtTyYuUiIoOpP[{]} \
aAsSdDfFgGhHjJkKlL;:'\" \
zZxXcCvVbBnNmM,<.>/? \
")
'("atari-german" . "\
\
1!2\"3\2474$5%6&7/8(9)0=\337?'`#^ \
qQwWeErRtTzZuUiIoOpP\374\334+* \
aAsSdDfFgGhHjJkKlL\366\326\344\304~| \
<>yYxXcCvVbBnNmM,;.:-_ \
")
'("pc102-de" . "\
\
^\2601!2\"3\2474$5%6&7/8(9)0=\337?\264`#' \
qQwWeErRtTzZuUiIoOpP\374\334+* \
aAsSdDfFgGhHjJkKlL\366\326\344\304 \
<>yYxXcCvVbBnNmM,;.:-_ \
")
'("jp106" . "\
\
1!2\"3#4$5%6&7'8(9)0~-=^~\\| \
qQwWeErRtTyYuUiIoOpP@`[{ \
aAsSdDfFgGhHjJkKlL;+:*]} \
zZxXcCvVbBnNmM,<.>/?\\_ \
")
'("pc105-uk" . "\
\
`\2541!2\"3\2434$5%6^7&8*9(0)-_=+ \
qQwWeErRtTyYuUiIoOpP[{]} \
aAsSdDfFgGhHjJkKlL;:'@#~ \
\\|zZxXcCvVbBnNmM,<.>/? \
")
)
"Alist of keyboard names and corresponding layout strings.
See the documentation of `quail-keyboard-layout' for the format of
the layout string.")
(defcustom quail-keyboard-layout quail-keyboard-layout-standard
"A string which represents physical key layout of a particular keyboard.
We assume there are six rows and each row has 15 keys (columns),
the first row is above the `1' - `0' row,
the first column of the second row is left of key `1',
the first column of the third row is left of key `q',
the first column of the fourth row is left of key `a',
the first column of the fifth row is left of key `z',
the sixth row is below the `z' - `/' row.
Nth (N is even) and (N+1)th characters in the string are non-shifted
and shifted characters respectively at the same location.
The location of Nth character is row (N / 30) and column ((N mod 30) / 2).
The command `quail-set-keyboard-layout' usually sets this variable."
:group 'quail
:type `(choice
,@(mapcar (lambda (pair)
(list 'const :tag (car pair) (cdr pair)))
quail-keyboard-layout-alist)
(string :tag "Other")))
;; A non-standard keyboard layout may miss some key locations of the
;; standard layout while having additional key locations not in the
;; standard layout. This alist maps those additional key locations to
;; the missing locations. The value is updated automatically by
;; quail-set-keyboard-layout.
(defvar quail-keyboard-layout-substitution nil)
(defun quail-update-keyboard-layout (kbd-type)
(let ((layout (assoc kbd-type quail-keyboard-layout-alist)))
(if (null layout)
;; Here, we had better ask a user to define his own keyboard
;; layout interactively.
(error "Unknown keyboard type `%s'" kbd-type))
(setq quail-keyboard-layout (cdr layout))
(let ((i quail-keyboard-layout-len)
subst-list missing-list)
;; Sum up additional key locations not in the standard layout in
;; subst-list, and missing key locations in missing-list.
(while (> i 0)
(setq i (1- i))
(if (= (aref quail-keyboard-layout i) ? )
(if (/= (aref quail-keyboard-layout-standard i) ? )
(setq missing-list (cons i missing-list)))
(if (= (aref quail-keyboard-layout-standard i) ? )
(setq subst-list (cons (cons i nil) subst-list)))))
(setq quail-keyboard-layout-substitution subst-list)
;; If there are additional key locations, map them to missing
;; key locations.
(dolist (missing missing-list)
(while (and subst-list (cdr (car subst-list)))
(setq subst-list (cdr subst-list)))
(if subst-list
(setcdr (car subst-list) missing))))))
(defcustom quail-keyboard-layout-type "standard"
"Type of keyboard layout used in Quail base input method.
Available types are listed in the variable `quail-keyboard-layout-alist'."
:group 'quail
:type (cons 'choice (mapcar (lambda (elt)
(list 'const (car elt)))
quail-keyboard-layout-alist))
:set (lambda (symbol value)
(quail-update-keyboard-layout value)
(set symbol value)))
;;;###autoload
(defun quail-set-keyboard-layout (kbd-type)
"Set the current keyboard layout to the same as keyboard KBD-TYPE.
Since some Quail packages depends on a physical layout of keys (not
characters generated by them), those are created by assuming the
standard layout defined in `quail-keyboard-layout-standard'. This
function tells Quail system the layout of your keyboard so that what
you type is correctly handled."
(interactive
(let* ((completion-ignore-case t)
(type (completing-read "Keyboard type: "
quail-keyboard-layout-alist)))
(list type)))
(quail-update-keyboard-layout kbd-type)
(setq quail-keyboard-layout-type kbd-type))
(defun quail-keyboard-translate (char)
"Translate CHAR to the one in the standard keyboard layout."
(if (eq quail-keyboard-layout quail-keyboard-layout-standard)
;; All Quail packages are designed based on
;; `quail-keyboard-layout-standard'.
char
(let ((i 0))
;; Find the key location on the current keyboard layout.
(while (and (< i quail-keyboard-layout-len)
(/= char (aref quail-keyboard-layout i)))
(setq i (1+ i)))
(if (= i quail-keyboard-layout-len)
;; CHAR is not in quail-keyboard-layout, which means that a
;; user typed a key which generated a character code to be
;; handled out of Quail. Just return CHAR and make
;; quail-execute-non-quail-command handle it correctly.
char
(let ((ch (aref quail-keyboard-layout-standard i)))
(if (= ch ?\ )
;; This location not available in the standard keyboard
;; layout. Check if the location is used to substitute
;; for the other location of the standard layout.
(if (setq i (cdr (assq i quail-keyboard-layout-substitution)))
(aref quail-keyboard-layout-standard i)
;; Just return CHAR as well as above.
char)
ch))))))
(defun quail-keyseq-translate (keyseq)
(apply 'string
(mapcar (lambda (x) (quail-keyboard-translate x))
keyseq)))
(defun quail-insert-kbd-layout (kbd-layout)
"Insert the visual keyboard layout table according to KBD-LAYOUT.
The format of KBD-LAYOUT is the same as `quail-keyboard-layout'."
(let (done-list layout i ch)
(setq bidi-paragraph-direction 'left-to-right)
;; At first, convert KBD-LAYOUT to the same size vector that
;; contains translated character or string.
(setq layout (string-to-vector kbd-layout)
i 0)
(while (< i quail-keyboard-layout-len)
(setq ch (aref kbd-layout i))
(if (quail-kbd-translate)
(setq ch (quail-keyboard-translate ch)))
(let* ((map (cdr (assq ch (cdr (quail-map)))))
(translation (and map (quail-get-translation
(car map) (char-to-string ch) 1))))
(if translation
(progn
(if (consp translation)
(setq translation
(if (> (length (cdr translation)) 0)
(aref (cdr translation) 0)
" ")))
(setq done-list (cons translation done-list)))
(setq translation (aref kbd-layout i)))
(aset layout i translation))
(setq i (1+ i)))
(let ((pos (point))
(bar (propertize "|" 'face 'bold))
lower upper row)
;; Make table without horizontal lines. Each column for a key
;; has the form "| LU |" where L is for lower key and U is
;; for a upper key. If width of L (U) is greater than 1,
;; preceding (following) space is not inserted.
(setq i 0)
(while (< i quail-keyboard-layout-len)
(when (= (% i 30) 0)
(setq row (/ i 30))
(if (> row 1)
(insert-char 32 (+ row (/ (- row 2) 2)))))
(setq lower (aref layout i)
upper (aref layout (1+ i)))
(insert bar)
(if (< (if (stringp lower) (string-width lower) (char-width lower)) 2)
(insert " "))
(if (characterp lower)
(setq lower
(if (eq (get-char-code-property lower 'general-category) 'Mn)
;; Pad the left and right of non-spacing characters.
(compose-string (string lower) 0 1
(format "\t%c\t" lower))
(string lower))))
(if (characterp upper)
(setq upper
(if (eq (get-char-code-property upper 'general-category) 'Mn)
;; Pad the left and right of non-spacing characters.
(compose-string (string upper) 0 1
(format "\t%c\t" upper))
(string upper))))
(insert (bidi-string-mark-left-to-right lower)
(propertize " " 'invisible t)
(bidi-string-mark-left-to-right upper))
(if (< (string-width upper) 2)
(insert " "))
(setq i (+ i 2))
(if (= (% i 30) 0)
(insert bar "\n")))
;; Insert horizontal lines while deleting blank key columns at the
;; beginning and end of each line.
(save-restriction
(narrow-to-region pos (point))
(goto-char pos)
;;(while (looking-at "[| ]*$")
;;(forward-line 1)
;;(delete-region pos (point)))
(let ((from1 100) (to1 0) from2 to2)
(while (not (eobp))
(if (looking-at "[| \u202c\u202d]*$")
;; The entire row is blank.
(delete-region (point) (match-end 0))
;; Delete blank key columns at the head.
(if (looking-at "\u202d? *\\(| \\)+")
(subst-char-in-region (point) (match-end 0) ?| ? ))
;; Delete blank key columns at the tail.
(if (re-search-forward "\\( |\\)+\u202c?$"
(line-end-position) t)
(delete-region (match-beginning 0) (point)))
(beginning-of-line))
;; Calculate the start and end columns of a horizontal line.
(if (eolp)
(setq from2 from1 to2 to1)
(skip-chars-forward " \u202d")
(setq from2 (current-column))
(end-of-line)
(setq to2 (current-column))
(if (< from2 from1)
(setq from1 from2))
(if (> to2 to1)
(setq to1 to2))
(beginning-of-line))
;; If the previous or the current line has at least one key
;; column, insert a horizontal line.
(when (> to1 0)
(insert-char 32 from1)
(setq pos (point))
(insert "+")
(insert-char ?- (- (- to1 from1) 2))
(insert "+")
(put-text-property pos (point) 'face 'bold)
(insert "\n"))
(setq from1 from2 to1 to2)
(forward-line 1)))
;; Insert "space bar" box.
(forward-line -1)
(setq pos (point))
(insert
" +-----------------------------+
| space bar |
+-----------------------------+
")
(put-text-property pos (point) 'face 'bold)
(insert ?\n)))
done-list))
;;;###autoload
(defun quail-show-keyboard-layout (&optional keyboard-type)
"Show the physical layout of the keyboard type KEYBOARD-TYPE.
The variable `quail-keyboard-layout-type' holds the currently selected
keyboard type."
(interactive
(list (completing-read (format-prompt "Keyboard type" "current choice")
quail-keyboard-layout-alist
nil t)))
(or (and keyboard-type (> (length keyboard-type) 0))
(setq keyboard-type quail-keyboard-layout-type))
(let ((layout (assoc keyboard-type quail-keyboard-layout-alist)))
(or layout
(error "Unknown keyboard type: %s" keyboard-type))
(with-output-to-temp-buffer "*Help*"
(with-current-buffer standard-output
(insert "Keyboard layout (keyboard type: "
keyboard-type
")\n")
(quail-insert-kbd-layout (cdr layout))))))
;; Quail map
(defsubst quail-map-p (object)
"Return t if OBJECT is a Quail map.
A Quail map holds information how a particular key should be translated.
Its format is (TRANSLATION . ALIST).
TRANSLATION is either a character, or a cons (INDEX . VECTOR).
In the latter case, each element of VECTOR is a candidate for the translation,
and INDEX points the currently selected translation.
ALIST is normally a list of elements that look like (CHAR . DEFN),
where DEFN is another Quail map for a longer key (CHAR added to the
current key). It may also be a symbol of a function which returns an
alist of the above format.
Just after a Quail package is read, TRANSLATION may be a string or a
vector. Then each element of the string or vector is a candidate for
the translation. These objects are transformed to cons cells in the
format \(INDEX . VECTOR), as described above."
(and (consp object)
(let ((translation (car object)))
(or (integerp translation) (null translation)
(vectorp translation) (stringp translation)
(symbolp translation)
(and (consp translation) (not (vectorp (cdr translation))))))
(let ((alist (cdr object)))
(or (and (listp alist) (consp (car alist)))
(symbolp alist)))))
;;;###autoload
(defmacro quail-define-rules (&rest rules)
"Define translation rules of the current Quail package.
Each argument is a list of KEY and TRANSLATION.
KEY is a string meaning a sequence of keystrokes to be translated.
TRANSLATION is a character, a string, a vector, a Quail map, or a function.
If it is a character, it is the sole translation of KEY.
If it is a string, each character is a candidate for the translation.
If it is a vector, each element (string or character) is a candidate
for the translation.
In these cases, a key specific Quail map is generated and assigned to KEY.
If TRANSLATION is a Quail map or a function symbol which returns a Quail map,
it is used to handle KEY.
The first argument may be an alist of annotations for the following
rules. Each element has the form (ANNOTATION . VALUE), where
ANNOTATION is a symbol indicating the annotation type. Currently
the following annotation types are supported.
append -- the value non-nil means that the following rules should
be appended to the rules of the current Quail package.
face -- the value is a face to use for displaying TRANSLATIONs in
candidate list.
advice -- the value is a function to call after one of RULES is
selected. The function is called with one argument, the
selected TRANSLATION string, after the TRANSLATION is
inserted.
no-decode-map --- the value non-nil means that decoding map is not
generated for the following translations."
(let ((l rules)
append no-decode-map props)
;; If the first argument is an alist of annotations, handle them.
(if (consp (car (car l)))
(let ((annotations (car l)))
(setq append (assq 'append annotations))
(if append
(setq annotations (delete append annotations)
append (cdr append)))
(setq no-decode-map (assq 'no-decode-map annotations))
(if no-decode-map
(setq annotations (delete no-decode-map annotations)
no-decode-map (cdr no-decode-map)))
;; Convert the remaining annotations to property list PROPS.
(dolist (annotation annotations)
(setq props
(cons (car annotation)
(cons (cdr annotation)
props))))
(setq l (cdr l))))
;; Process the remaining arguments one by one.
(if append
;; There's no way to add new rules at compiling time.
`(let ((tail ',l)
(map (quail-map))
(decode-map (and (quail-decode-map) (not ,no-decode-map)))
(properties ',props)
key trans)
(while tail
(setq key (car (car tail)) trans (car (cdr (car tail)))
tail (cdr tail))
(quail-defrule-internal key trans map t decode-map properties)))
;; We can build up quail map and decode map at compiling time.
(let ((map (list nil))
(decode-map (if (not no-decode-map) (list 'decode-map)))
key trans)
(dolist (el l)
(setq key (car el) trans (car (cdr el)))
(quail-defrule-internal key trans map t decode-map props))
`(if (prog1 (quail-decode-map)
(quail-install-map ',map))
(quail-install-decode-map ',decode-map))))))
;;;###autoload
(defun quail-install-map (map &optional _name)
"Install the Quail map MAP in the current Quail package.
Optional 2nd arg NAME, if non-nil, is a name of Quail package for
which to install MAP.
The installed map can be referred by the function `quail-map'."
(if (null quail-current-package)
(error "No current Quail package"))
(if (null (quail-map-p map))
(error "Invalid Quail map `%s'" map))
(setcar (cdr (cdr quail-current-package)) map))
;;;###autoload
(defun quail-install-decode-map (decode-map &optional _name)
"Install the Quail decode map DECODE-MAP in the current Quail package.
Optional 2nd arg NAME, if non-nil, is a name of Quail package for
which to install MAP.
The installed decode map can be referred by the function `quail-decode-map'."
(if (null quail-current-package)
(error "No current Quail package"))
(if (if (consp decode-map)
(eq (car decode-map) 'decode-map)
(if (char-table-p decode-map)
(eq (char-table-subtype decode-map) 'quail-decode-map)))
(setcar (nthcdr 10 quail-current-package) decode-map)
(error "Invalid Quail decode map `%s'" decode-map)))
;;;###autoload
(defun quail-defrule (key translation &optional name append)
"Add one translation rule, KEY to TRANSLATION, in the current Quail package.
KEY is a string meaning a sequence of keystrokes to be translated.
TRANSLATION is a character, a string, a vector, a Quail map,
a function, or a cons.
If it is a character, it is the sole translation of KEY.
If it is a string, each character is a candidate for the translation.
If it is a vector, each element (string or character) is a candidate
for the translation.
If it is a cons, the car is one of the above and the cdr is a function
to call when translating KEY (the return value is assigned to the
variable `quail-current-data'). If the cdr part is not a function,
the value itself is assigned to `quail-current-data'.
In these cases, a key specific Quail map is generated and assigned to KEY.
If TRANSLATION is a Quail map or a function symbol which returns a Quail map,
it is used to handle KEY.
Optional 3rd argument NAME, if specified, says which Quail package
to define this translation rule in. The default is to define it in the
current Quail package.
Optional 4th argument APPEND, if non-nil, appends TRANSLATION
to the current translations for KEY instead of replacing them."
(if name
(let ((package (quail-package name)))
(if (null package)
(error "No Quail package `%s'" name))
(setq quail-current-package package)))
(quail-defrule-internal key translation (quail-map) append))
(defun quail-vunion (v1 v2)
(apply 'vector
;; No idea why this was here, but it seems to cause the
;; incorrect ordering, according to Nils Anders Danielsson.
;; (nreverse
(delete-dups (nconc (append v1 ()) (append v2 ()))))) ;; )
;;;###autoload
(defun quail-defrule-internal (key trans map &optional append decode-map props)
"Define KEY as TRANS in a Quail map MAP.
If Optional 4th arg APPEND is non-nil, TRANS is appended to the
current translations for KEY instead of replacing them.
Optional 5th arg DECODE-MAP is a Quail decode map.
Optional 6th arg PROPS is a property list annotating TRANS. See the
function `quail-define-rules' for the detail."
(if (not (or (stringp key) (vectorp key)))
(error "Invalid Quail key `%s'" key))
(if (not (or (numberp trans) (stringp trans) (vectorp trans)
(consp trans)
(symbolp trans)
(quail-map-p trans)))
(error "Invalid Quail translation `%s'" trans))
(if (null (quail-map-p map))
(error "Invalid Quail map `%s'" map))
(let ((len (length key))
(idx 0)
ch entry)
;; Make a map for registering TRANS if necessary.
(while (< idx len)
(if (null (consp map))
;; We come here, for example, when we try to define a rule
;; for "ABC" but a rule for "AB" is already defined as a
;; symbol.
(error "Quail key %s is too long" key))
(setq ch (aref key idx)
entry (assq ch (cdr map)))
(if (null entry)
(progn
(setq entry (cons ch (list nil)))
(setcdr map (cons entry (cdr map)))))
(setq map (cdr entry))
(setq idx (1+ idx)))
(if (symbolp trans)
(if (cdr map)
;; We come here, for example, when we try to define a rule
;; for "AB" as a symbol but a rule for "ABC" is already
;; defined.
(error "Quail key %s is too short" key)
(setcdr entry trans))
(if (quail-map-p trans)
(if (not (listp (cdr map)))
;; We come here, for example, when we try to define a rule
;; for "AB" as a symbol but a rule for "ABC" is already
;; defined.
(error "Quail key %s is too short" key)
(if (not (listp (cdr trans)))
(if (cdr map)
;; We come here, for example, when we try to
;; define a rule for "AB" as a symbol but a rule
;; for "ABC" is already defined.
(error "Quail key %s is too short" key)
(setcdr entry trans))
(setcdr entry (append trans (cdr map)))))
;; If PROPS is non-nil or DECODE-MAP is non-nil, convert TRANS
;; to a vector of strings, add PROPS to each string and record
;; this rule in DECODE-MAP.
(when (and (or props decode-map)
(not (consp trans)) (not (symbolp trans)))
(if (integerp trans)
(setq trans (vector trans))
(if (stringp trans)
(setq trans (string-to-vector trans))))
(let ((len (length trans))
elt)
(while (> len 0)
(setq len (1- len))
(setq elt (aref trans len))
(if (integerp elt)
(setq elt (char-to-string elt)))
(aset trans len elt)
(if props
(add-text-properties 0 (length elt) props elt))
(if decode-map
(setcdr decode-map
(cons (cons elt key) (cdr decode-map)))))))
(if (and (car map) append)
(let* ((prev (quail-get-translation (car map) key len))
(prevchars (if (integerp prev)
(vector prev)
(cdr prev))))
(if (integerp trans)
(setq trans (vector trans))
(if (stringp trans)
(setq trans (string-to-vector trans))))
(let ((new (quail-vunion prevchars trans)))
(setq trans
(if (equal new prevchars)
;; Nothing to change, get back to orig value.
prev
(cons (list 0 0 0 0 nil) new))))))
(setcar map trans)))))
(defun quail-get-translation (def key len)
"Return the translation specified as DEF for KEY of length LEN.
The translation is either a character or a cons of the form (INDEX . VECTOR),
where VECTOR is a vector of candidates (character or string) for
the translation, and INDEX points into VECTOR to specify the currently
selected translation."
(if (and def (symbolp def))
;; DEF is a symbol of a function which returns valid translation.
(setq def (if (functionp def) (funcall def key len))))
(if (and (consp def) (not (vectorp (cdr def))))
(setq def (car def)))
(cond
((or (integerp def) (consp def))
def)
((null def)
;; No translation.
nil)
((stringp def)
;; If the length is 1, we don't need vector but a single candidate
;; as the translation.
(if (= (length def) 1)
(aref def 0)
;; Each character in DEF is a candidate of translation. Reform
;; it as (INDICES . VECTOR).
(cons (list 0 0 0 0 nil) (string-to-vector def))))
((vectorp def)
;; If the length is 1, and the length of element string is 1, we
;; don't need vector but a single candidate as the translation.
(if (and (= (length def) 1)
(= (length (aref def 0)) 1))
(aref (aref def 0) 0)
;; Each element (string or character) in DEF is a candidate of
;; translation. Reform it as (INDICES . VECTOR).
(cons (list 0 0 0 0 nil) def)))
(t
(error "Invalid object in Quail map: %s" def))))
(defun quail-lookup-key (key &optional len not-reset-indices)
"Lookup KEY of length LEN in the current Quail map and return the definition.
The returned value is a Quail map specific to KEY."
(or len
(setq len (length key)))
(let ((idx 0)
(map (quail-map))
(kbd-translate (quail-kbd-translate))
slot ch translation def)
(while (and map (< idx len))
(setq ch (if kbd-translate (quail-keyboard-translate (aref key idx))
(aref key idx)))
(setq idx (1+ idx))
(if (and (cdr map) (symbolp (cdr map)))
(setcdr map (funcall (cdr map) key idx)))
(setq slot (assq ch (cdr map)))
(if (and (cdr slot) (symbolp (cdr slot)))
(setcdr slot (funcall (cdr slot) key idx)))
(setq map (cdr slot)))
(setq def (car map))
(setq quail-current-translations nil)
(if (and map (setq translation (quail-get-translation def key len)))
(progn
(if (and (consp def) (not (vectorp (cdr def))))
(progn
(if (not (equal (car def) translation))
;; We must reflect TRANSLATION to car part of DEF.
(setcar def translation))
(setq quail-current-data
(if (functionp (cdr def))
(funcall (cdr def))
(cdr def))))
(if (not (equal def translation))
;; We must reflect TRANSLATION to car part of MAP.
(setcar map translation)))
(if (and (consp translation) (vectorp (cdr translation)))
(progn
(setq quail-current-translations translation)
(if (and (not not-reset-indices) (quail-forget-last-selection))
(setcar (car quail-current-translations) 0))))))
;; We may have to reform cdr part of MAP.
(if (and (cdr map) (functionp (cdr map)))
(setcdr map (funcall (cdr map) key len)))
map))
(define-error 'quail-error nil)
(defun quail-error (&rest args)
(signal 'quail-error (apply #'format-message args)))
(defun quail-input-string-to-events (str)
"Convert input string STR to a list of events.
If STR has `advice' text property, append the following special event:
\(quail-advice STR)"
(let ((events (mapcar
(lambda (c)
(or
;; Avoid "obsolete" warnings for translation-table-for-input.
(with-no-warnings
(and translation-table-for-input
(aref translation-table-for-input c)))
c))
str)))
(if (or (get-text-property 0 'advice str)
(next-single-property-change 0 'advice str))
(setq events
(nconc events (list (list 'quail-advice str)))))
events))
(defvar quail-translating nil)
(defvar quail-converting nil)
(defvar quail-conversion-str nil)
(defun quail-input-method (key)
(if (or (and (or buffer-read-only
(and (get-char-property (point) 'read-only)
(get-char-property (point) 'front-sticky)))
(not (or inhibit-read-only
(get-char-property (point) 'inhibit-read-only))))
(and overriding-terminal-local-map
;; If the overriding map is `universal-argument-map', that
;; must mean the user has pressed 'C-u KEY'. If KEY has a
;; binding in `universal-argument-map' just return
;; (list KEY), otherwise act as if there was no
;; overriding map.
(or (not (eq (cadr overriding-terminal-local-map)
universal-argument-map))
(lookup-key overriding-terminal-local-map (vector key))))
overriding-local-map)
(list key)
(quail-setup-overlays (quail-conversion-keymap))
(with-silent-modifications
(unwind-protect
(let ((input-string (if (quail-conversion-keymap)
(quail-start-conversion key)
(quail-start-translation key))))
(setq quail-guidance-str "")
(when (and (stringp input-string)
(> (length input-string) 0))
(if input-method-exit-on-first-char
(list (aref input-string 0))
(quail-input-string-to-events input-string))))
(quail-delete-overlays)
;; Run this hook only when the current input method doesn't require
;; conversion. When conversion is required, the conversion function
;; should run this hook at a proper timing.
(unless (quail-conversion-keymap)
(run-hooks 'input-method-after-insert-chunk-hook))))))
(defun quail-overlay-region-events (overlay)
(let ((start (overlay-start overlay))
(end (overlay-end overlay)))
(if (< start end)
(string-to-list (delete-and-extract-region start end)))))
(defsubst quail-delete-region ()
"Delete the text in the current translation region of Quail."
(if (overlay-start quail-overlay)
(delete-region (overlay-start quail-overlay)
(overlay-end quail-overlay))))
;; Quail puts keys back in `unread-command-events' to be re-read
;; again, but these keys have already been recorded in recent-keys and
;; in the keyboard macro, if one is being defined, which means that
;; recording them again creates duplicates. This function is a
;; wrapper around adding input events to `unread-command-events', but
;; it makes sure these events will not be recorded a second time.
(defun quail-add-unread-command-events (key &optional reset)
"Add KEY to `unread-command-events', but avoid recording it a second time.
If KEY is a character, it is prepended to `unread-command-events' as
a cons cell of the form (no-record . KEY).
If KEY is a vector of events, the events in the vector are prepended
to `unread-command-events', after converting each event to a cons cell
of the form (no-record . EVENT).
If KEY is an event, it is prepended to `unread-command-events' as a cons
cell of the form (no-record . EVENT).
If RESET is non-nil, the events in `unread-command-events' are first
discarded, i.e. in this case KEY will end up being the only key
in `unread-command-events'."
(if reset (setq unread-command-events nil))
(setq unread-command-events
(if (characterp key)
(cons (cons 'no-record key) unread-command-events)
(append (mapcan (lambda (e) (list (cons 'no-record e)))
(append (if (vectorp key) key (vector key)) nil))
unread-command-events))))
(defun quail-start-translation (key)
"Start translation of the typed character KEY by the current Quail package.
Return the input string."
;; Check the possibility of translating KEY.
;; If KEY is nil, we can anyway start translation.
(if (or (and (integerp key)
(assq (if (quail-kbd-translate)
(quail-keyboard-translate key) key)
(cdr (quail-map))))
(null key))
;; OK, we can start translation.
(let* ((echo-keystrokes 0)
(help-char nil)
(overriding-terminal-local-map (quail-translation-keymap))
;; (generated-events nil) ;FIXME: What is this?
(input-method-function nil)
(modified-p (buffer-modified-p))
last-command-event last-command this-command)
(setq quail-current-key ""
quail-current-str ""
quail-translating t)
(if key (quail-add-unread-command-events key))
(while quail-translating
(set-buffer-modified-p modified-p)
(quail-show-guidance)
(let* ((prompt (if input-method-use-echo-area
(format "%s%s %s"
(or input-method-previous-message "")
quail-current-str
quail-guidance-str)))
(keyseq (read-key-sequence prompt nil nil t))
(cmd (lookup-key (quail-translation-keymap) keyseq)))
(if (if key
(and (commandp cmd) (not (eq cmd 'quail-other-command)))
(eq cmd 'quail-self-insert-command))
(progn
(setq last-command-event (aref keyseq (1- (length keyseq)))
last-command this-command
this-command cmd)
(setq key t)
(condition-case err
(call-interactively cmd)
(quail-error (message "%s" (cdr err)) (beep))))
;; KEYSEQ is not defined in the translation keymap.
;; Let's return the event(s) to the caller.
(quail-add-unread-command-events (this-single-command-raw-keys))
(setq quail-translating nil))))
(quail-delete-region)
quail-current-str)
;; Since KEY doesn't start any translation, just return it.
;; But translate KEY if necessary.
(if (quail-kbd-translate)
(setq key (quail-keyboard-translate key)))
(char-to-string key)))
(defun quail-start-conversion (key)
"Start conversion of the typed character KEY by the current Quail package.
Return the input string."
;; Check the possibility of translating KEY.
;; If KEY is nil, we can anyway start translation.
(if (or (and (integerp key)
(assq (if (quail-kbd-translate)
(quail-keyboard-translate key) key)
(cdr (quail-map))))
(null key))
;; Ok, we can start translation and conversion.
(let* ((echo-keystrokes 0)
(help-char nil)
(overriding-terminal-local-map (quail-conversion-keymap))
;; (generated-events nil) ;FIXME: What is this?
(input-method-function nil)
(modified-p (buffer-modified-p))
last-command-event last-command this-command)
(setq quail-current-key ""
quail-current-str ""
quail-translating t
quail-converting t
quail-conversion-str "")
(if key (quail-add-unread-command-events key))
(while quail-converting
(set-buffer-modified-p modified-p)
(or quail-translating
(progn
(setq quail-current-key ""
quail-current-str ""
quail-translating t)
(quail-setup-overlays nil)))
(quail-show-guidance)
(let* ((prompt (if input-method-use-echo-area
(format "%s%s%s %s"
(or input-method-previous-message "")
quail-conversion-str
quail-current-str
quail-guidance-str)))
(keyseq (read-key-sequence prompt nil nil t))
(cmd (lookup-key (quail-conversion-keymap) keyseq)))
(if (if key (commandp cmd) (eq cmd 'quail-self-insert-command))
(progn
(setq last-command-event (aref keyseq (1- (length keyseq)))
last-command this-command
this-command cmd)
(setq key t)
(condition-case err
(call-interactively cmd)
(quail-error (message "%s" (cdr err)) (beep)))
(or quail-translating
(progn
(if quail-current-str
(setq quail-conversion-str
(concat quail-conversion-str
(if (stringp quail-current-str)
quail-current-str
(char-to-string quail-current-str)))))
(if (or input-method-exit-on-first-char
(= (length quail-conversion-str) 0))
(setq quail-converting nil)))))
;; KEYSEQ is not defined in the conversion keymap.
;; Let's return the event(s) to the caller.
(quail-add-unread-command-events (this-single-command-raw-keys))
(setq quail-converting nil))))
(setq quail-translating nil)
(if (overlay-start quail-conv-overlay)
(delete-region (overlay-start quail-conv-overlay)
(overlay-end quail-conv-overlay)))
(if (> (length quail-conversion-str) 0)
quail-conversion-str))
;; Since KEY doesn't start any translation, just return it.
;; But translate KEY if necessary.
(if (quail-kbd-translate)
(setq key (quail-keyboard-translate key)))
(char-to-string key)))
(defun quail-terminate-translation ()
"Terminate the translation of the current key."
(setq quail-translating nil)
(setq quail-guidance-str " "))
(defun quail-select-current ()
"Accept the currently selected translation."
(interactive)
(quail-terminate-translation))
(defun quail-update-translation (control-flag)
"Update the current translation status according to CONTROL-FLAG.
If CONTROL-FLAG is integer value, it is the number of keys in the
head `quail-current-key' which can be translated. The remaining keys
are put back to `unread-command-events' to be handled again. If
CONTROL-FLAG is t, terminate the translation for the whole keys in
`quail-current-key'. If CONTROL-FLAG is nil, proceed the translation
with more keys."
(let ((func (quail-update-translation-function)))
(if func
(setq control-flag (funcall func control-flag))
(cond ((numberp control-flag)
(let ((len (length quail-current-key)))
(if (= control-flag 0)
(setq quail-current-str
(if (quail-kbd-translate)
(quail-keyseq-translate quail-current-key)
quail-current-key)))
(or input-method-exit-on-first-char
(while (> len control-flag)
(setq len (1- len))
(quail-add-unread-command-events
(aref quail-current-key len))))))
((null control-flag)
(unless quail-current-str
(setq quail-current-str
(if (quail-kbd-translate)
(quail-keyseq-translate quail-current-key)
quail-current-key))
(if (and input-method-exit-on-first-char
(quail-simple))
(setq control-flag t)))))))
(or input-method-use-echo-area
(let (pos)
(quail-delete-region)
(setq pos (point))
(or enable-multibyte-characters
(let (char)
(if (stringp quail-current-str)
(catch 'tag
(mapc (lambda (ch)
(when (/= (unibyte-char-to-multibyte
(multibyte-char-to-unibyte ch))
ch)
(setq char ch)
(throw 'tag nil)))
quail-current-str))
(if (/= (unibyte-char-to-multibyte
(multibyte-char-to-unibyte quail-current-str))
quail-current-str)
(setq char quail-current-str)))
(when char
(message "Can't input %c in the current unibyte buffer" char)
(ding)
(sit-for 2)
(message nil)
(setq quail-current-str nil)
(throw 'quail-tag nil))))
(insert quail-current-str)
(move-overlay quail-overlay pos (point))
(if (overlayp quail-conv-overlay)
(if (not (overlay-start quail-conv-overlay))
(move-overlay quail-conv-overlay pos (point))
(if (< (overlay-end quail-conv-overlay) (point))
(move-overlay quail-conv-overlay
(overlay-start quail-conv-overlay)
(point)))))))
(let (quail-current-str)
(quail-update-guidance))
(or (stringp quail-current-str)
(setq quail-current-str (char-to-string quail-current-str)))
(if control-flag
(quail-terminate-translation)))
(defun quail-self-insert-command ()
"Translate the typed key by the current Quail map, and insert."
(interactive "*")
(setq quail-current-key
(concat quail-current-key (char-to-string last-command-event)))
(or (catch 'quail-tag
(quail-update-translation (quail-translate-key))
t)
;; If someone throws for `quail-tag' by value nil, we exit from
;; translation mode.
(setq quail-translating nil)))
(defun quail-map-definition (map)
"Return the actual definition part of Quail map MAP."
(let ((def (car map)))
(if (and (consp def) (not (vectorp (cdr def))))
(setq def (car def)))
(if (eq def t)
(setq def nil))
def))
(defun quail-get-current-str (len def)
"Return string to be shown as current translation of key sequence.
LEN is the length of the sequence. DEF is a definition part of the
Quail map for the sequence."
(or (and (consp def)
(if (> (length (cdr def)) (car (car def)))
(aref (cdr def) (car (car def)))
""))
def
(and (> len 1)
(let* ((str (quail-get-current-str
(1- len)
(quail-map-definition (quail-lookup-key
quail-current-key (1- len)))))
(substr1 (substring quail-current-key (1- len) len))
(str1 (and (quail-deterministic)
(quail-get-current-str
1
(quail-map-definition (quail-lookup-key
substr1 1))))))
(if str
(concat (if (stringp str) str (char-to-string str))
(if str1
(if (stringp str1) str1 (char-to-string str1))
substr1)))))))
(defvar quail-guidance-translations-starting-column 20)
(defun quail-update-current-translations (&optional relative-index)
"Update `quail-current-translations'.
Make RELATIVE-INDEX the current translation."
(let* ((indices (car quail-current-translations))
(cur (car indices))
(start (nth 1 indices))
(end (nth 2 indices)))
;; Validate the index number of current translation.
(if (< cur 0)
(setcar indices (setq cur 0))
(if (>= cur (length (cdr quail-current-translations)))
(setcar indices
(setq cur (1- (length (cdr quail-current-translations)))))))
(if (or (null end) ; We have not yet calculated END.
(< cur start) ; We moved to the previous block.
(>= cur end)) ; We moved to the next block.
(let ((len (length (cdr quail-current-translations)))
(maxcol (- (window-width)
quail-guidance-translations-starting-column))
(block (nth 3 indices))
col idx width trans num-items)
(if (< cur start)
;; We must calculate from the head.
(setq start 0 block 0)
(if end ; i.e. (>= cur end)
(setq start end)))
(setq idx start col 0 end start num-items 0)
;; Loop until we hit the tail, or reach the block of CUR.
(while (and (< idx len) (>= cur end))
(if (= num-items 0)
(setq start idx col 0 block (1+ block)))
(setq trans (aref (cdr quail-current-translations) idx))
(setq width (if (integerp trans) (char-width trans)
(string-width trans)))
(setq col (+ col width 3) num-items (1+ num-items))
(if (and (> num-items 0)
(or (>= col maxcol) (> num-items 10)))
(setq end idx num-items 0)
(setq idx (1+ idx))))
(setcar (nthcdr 3 indices) block)
(if (>= idx len)
(progn
;; We hit the tail before reaching MAXCOL.
(setq end idx)
(setcar (nthcdr 4 indices) block)))
(setcar (cdr indices) start)
(setcar (nthcdr 2 indices) end)))
(if relative-index
(if (>= (+ start relative-index) end)
(setcar indices (1- end))
(setcar indices (+ start relative-index))))
(setq quail-current-str
(aref (cdr quail-current-translations) (car indices)))
(or (stringp quail-current-str)
(setq quail-current-str (char-to-string quail-current-str)))))
(defun quail-translate-key ()
"Translate the current key sequence according to the current Quail map.
Return t if we can terminate the translation.
Return nil if the current key sequence may be followed by more keys.
Return number if we can't find any translation for the current key
sequence. The number is the count of valid keys in the current
sequence counting from the head."
(let* ((len (length quail-current-key))
(map (quail-lookup-key quail-current-key len))
def ch)
(if map
(let ((def (quail-map-definition map)))
(setq quail-current-str (quail-get-current-str len def))
;; Return t only if we can terminate the current translation.
(and
;; No alternative translations.
(or (null (consp def)) (= (length (cdr def)) 1))
;; No translation for the longer key.
(null (cdr map))
;; No shorter breaking point.
(or (null (quail-maximum-shortest))
(< len 3)
(null (quail-lookup-key quail-current-key (1- len)))
(null (quail-lookup-key
(substring quail-current-key -2 -1) 1)))))
;; There's no translation for the current key sequence. Before
;; giving up, we must check two possibilities.
(cond ((and
(quail-maximum-shortest)
(>= len 3)
(setq def (quail-map-definition
(quail-lookup-key quail-current-key (- len 2))))
(quail-lookup-key (substring quail-current-key -2) 2))
;; Now the sequence is "...ABCD", which can be split into
;; "...AB" and "CD..." to get valid translation.
;; At first, get translation of "...AB".
(setq quail-current-str (quail-get-current-str (- len 2) def))
;; Then, return the length of "...AB".
(- len 2))
((and (> len 0)
(quail-lookup-key (substring quail-current-key 0 -1))
quail-current-translations
(not (quail-deterministic))
(setq ch (aref quail-current-key (1- len)))
(>= ch ?0) (<= ch ?9))
;; A numeric key is entered to select a desirable translation.
(setq quail-current-key (substring quail-current-key 0 -1))
;; We treat key 1,2..,9,0 as specifying 0,1,..8,9.
(setq ch (if (= ch ?0) 9 (- ch ?1)))
(quail-update-current-translations ch)
;; And, we can terminate the current translation.
t)
((quail-deterministic)
;; No way to handle the last character in this context.
;; Commit the longest successfully translated characters, and
;; handle the remaining characters in a new loop.
(setq def nil)
(while (and (not def) (> len 1))
(setq len (1- len))
(setq def (quail-map-definition
(quail-lookup-key quail-current-key len))))
(if def (setq quail-current-str
(quail-get-current-str len def))
(setq quail-current-str (aref quail-current-key 0)))
len)
(t
;; No way to handle the last character in this context.
(setq def (quail-map-definition
(quail-lookup-key quail-current-key (1- len))))
(if def (setq quail-current-str
(quail-get-current-str (1- len) def)))
(1- len))))))
(defun quail-next-translation ()
"Select next translation in the current batch of candidates."
(interactive)
(if quail-current-translations
(let ((indices (car quail-current-translations)))
(if (= (1+ (car indices)) (length (cdr quail-current-translations)))
;; We are already at the tail.
(beep)
(setcar indices (1+ (car indices)))
(quail-update-current-translations)
(quail-update-translation nil)))
(quail-add-unread-command-events last-command-event)
(quail-terminate-translation)))
(defun quail-prev-translation ()
"Select previous translation in the current batch of candidates."
(interactive)
(if quail-current-translations
(let ((indices (car quail-current-translations)))
(if (= (car indices) 0)
;; We are already at the head.
(beep)
(setcar indices (1- (car indices)))
(quail-update-current-translations)
(quail-update-translation nil)))
(quail-add-unread-command-events last-command-event)
(quail-terminate-translation)))
(defun quail-next-translation-block ()
"Select from the next block of translations."
(interactive)
(if quail-current-translations
(let* ((indices (car quail-current-translations))
(offset (- (car indices) (nth 1 indices))))
(if (>= (nth 2 indices) (length (cdr quail-current-translations)))
;; We are already at the last block.
(beep)
(setcar indices (+ (nth 2 indices) offset))
(quail-update-current-translations)
(quail-update-translation nil)))
(quail-add-unread-command-events last-command-event)
(quail-terminate-translation)))
(defun quail-prev-translation-block ()
"Select the previous batch of 10 translation candidates."
(interactive)
(if quail-current-translations
(let* ((indices (car quail-current-translations))
(offset (- (car indices) (nth 1 indices))))
(if (= (nth 1 indices) 0)
;; We are already at the first block.
(beep)
(setcar indices (1- (nth 1 indices)))
(quail-update-current-translations)
(if (< (+ (nth 1 indices) offset) (nth 2 indices))
(progn
(setcar indices (+ (nth 1 indices) offset))
(quail-update-current-translations)))
(quail-update-translation nil)))
(quail-add-unread-command-events last-command-event)
(quail-terminate-translation)))
(defun quail-abort-translation ()
"Abort translation and delete the current Quail key sequence."
(interactive)
(quail-delete-region)
(setq quail-current-str nil)
(quail-terminate-translation))
(defun quail-delete-last-char ()
"Delete the last input character from the current Quail key sequence."
(interactive)
(if (= (length quail-current-key) 1)
(quail-abort-translation)
(setq quail-current-key (substring quail-current-key 0 -1))
(quail-delete-region)
(quail-update-translation (quail-translate-key))))
;; For conversion mode.
(defsubst quail-point-in-conversion-region ()
"Return non-nil value if the point is in conversion region of Quail mode."
(let (start pos)
(and (setq start (overlay-start quail-conv-overlay))
(>= (setq pos (point)) start)
(<= pos (overlay-end quail-conv-overlay)))))
(defun quail-conversion-backward-char ()
(interactive)
(if (<= (point) (overlay-start quail-conv-overlay))
(quail-error "Beginning of conversion region"))
(setq quail-translating nil)
(forward-char -1))
(defun quail-conversion-forward-char ()
(interactive)
(if (>= (point) (overlay-end quail-conv-overlay))
(quail-error "End of conversion region"))
(setq quail-translating nil)
(forward-char 1))
(defun quail-conversion-beginning-of-region ()
(interactive)
(setq quail-translating nil)
(goto-char (overlay-start quail-conv-overlay)))
(defun quail-conversion-end-of-region ()
(interactive)
(setq quail-translating nil)
(goto-char (overlay-end quail-conv-overlay)))
(defun quail-conversion-delete-char ()
(interactive)
(setq quail-translating nil)
(if (>= (point) (overlay-end quail-conv-overlay))
(quail-error "End of conversion region"))
(delete-char 1)
(let ((start (overlay-start quail-conv-overlay))
(end (overlay-end quail-conv-overlay)))
(setq quail-conversion-str (buffer-substring start end))
(if (= start end)
(setq quail-converting nil))))
(defun quail-conversion-delete-tail ()
(interactive)
(if (>= (point) (overlay-end quail-conv-overlay))
(quail-error "End of conversion region"))
(delete-region (point) (overlay-end quail-conv-overlay))
(let ((start (overlay-start quail-conv-overlay))
(end (overlay-end quail-conv-overlay)))
(setq quail-conversion-str (buffer-substring start end))
(if (= start end)
(setq quail-converting nil))))
(defun quail-conversion-backward-delete-char ()
(interactive)
(if (> (length quail-current-key) 0)
(quail-delete-last-char)
(if (<= (point) (overlay-start quail-conv-overlay))
(quail-error "Beginning of conversion region"))
(delete-char -1)
(let ((start (overlay-start quail-conv-overlay))
(end (overlay-end quail-conv-overlay)))
(setq quail-conversion-str (buffer-substring start end))
(if (= start end)
(setq quail-converting nil)))))
(defun quail-do-conversion (func &rest args)
"Call FUNC to convert text in the current conversion region of Quail.
Remaining args are for FUNC."
(delete-overlay quail-overlay)
(apply func args))
(defun quail-no-conversion ()
"Do no conversion of the current conversion region of Quail."
(interactive)
(setq quail-converting nil))
;; Guidance, Completion, and Help buffer handlers.
(defun quail-make-guidance-frame ()
"Make a new one-line frame for Quail guidance."
(let* ((fparam (frame-parameters))
(top (cdr (assq 'top fparam)))
(border (cdr (assq 'border-width fparam)))
(internal-border (cdr (assq 'internal-border-width fparam)))
(newtop (- top
(frame-char-height) (* internal-border 2) (* border 2))))
(if (< newtop 0)
(setq newtop (+ top (frame-pixel-height) internal-border border)))
;; If I leave the `parent-id' parameter, my frame ends up with 13 lines
;; rather than just 1. Not sure what is really going on, but
;; clearly this parameter is not needed. --Stef
(setq fparam (delq (assoc 'parent-id fparam) fparam))
(make-frame (append '((user-position . t) (height . 1)
(minibuffer)
(menu-bar-lines . 0) (tool-bar-lines . 0))
(cons (cons 'top newtop) fparam)))))
(defun quail-setup-completion-buf ()
"Setup Quail completion buffer."
(unless (buffer-live-p quail-completion-buf)
(let ((mb enable-multibyte-characters))
(setq quail-completion-buf (get-buffer-create "*Quail Completions*"))
(with-current-buffer quail-completion-buf
(set-buffer-multibyte mb)
(setq buffer-read-only t)
(setq quail-overlay (make-overlay (point-min) (point-min)))
(overlay-put quail-overlay 'face 'highlight)))))
(defun quail-require-guidance-buf ()
"Return t if the current Quail package requires showing guidance buffer."
(and input-method-verbose-flag
(if (eq input-method-verbose-flag 'default)
(not (and (eq (selected-window) (minibuffer-window))
(quail-simple)))
(if (eq input-method-verbose-flag 'complex-only)
(not (quail-simple))
t))))
;; Quail specific version of minibuffer-message. It displays STRING
;; with timeout 1000000 seconds instead of two seconds.
(defun quail-minibuffer-message (string)
(message nil)
(let ((point-max (point-max))
(inhibit-quit t)
(deactivate-mark nil))
(save-excursion
(goto-char point-max)
(insert string))
(sit-for 1000000)
(delete-region point-max (point-max))
(when quit-flag
(setq quit-flag nil)
(quail-add-unread-command-events 7 t))))
(defun quail-show-guidance ()
"Display a guidance for Quail input method in some window.
The guidance is normally displayed at the echo area,
or in a newly created frame (if the current buffer is a
minibuffer and the selected frame has no other windows)."
;; At first, setup a buffer for completion.
(quail-setup-completion-buf)
(bury-buffer quail-completion-buf)
;; Then, show the guidance.
(when (and
;; Don't try to display guidance on an expired minibuffer. This
;; would go into an infinite wait rather than executing the user's
;; command. Bug #45792.
(not (eq major-mode 'minibuffer-inactive-mode))
(quail-require-guidance-buf)
(not input-method-use-echo-area)
(null unread-command-events)
(null unread-post-input-method-events))
(if (minibufferp)
(if (eq (minibuffer-window) (frame-root-window))
;; Use another frame. It is sure that we are using some
;; window system.
(let ((guidance quail-guidance-str))
(or (frame-live-p quail-guidance-frame)
(setq quail-guidance-frame
(quail-make-guidance-frame)))
(or (buffer-live-p quail-guidance-buf)
(setq quail-guidance-buf
(get-buffer-create " *Quail-guidance*")))
(with-current-buffer quail-guidance-buf
(erase-buffer)
(setq cursor-type nil)
(insert guidance))
(let ((win (frame-root-window quail-guidance-frame)))
(set-window-buffer win quail-guidance-buf)
(set-window-dedicated-p win t))
(quail-minibuffer-message
(format " [%s]" current-input-method-title)))
;; Show the guidance in the next line of the current
;; minibuffer.
(quail-minibuffer-message
(format " [%s]\n%s"
current-input-method-title quail-guidance-str)))
;; Show the guidance in echo area without logging.
(let ((message-log-max nil))
(message "%s" quail-guidance-str)))))
(defun quail-hide-guidance ()
"Hide the Quail guidance."
(when (and (quail-require-guidance-buf)
(or (eq (selected-window) (minibuffer-window))
input-method-use-echo-area)
(eq (minibuffer-window) (frame-root-window)))
;; We are using another frame for the guidance.
(if (frame-live-p quail-guidance-frame)
(delete-frame quail-guidance-frame))
(if (buffer-live-p quail-guidance-buf)
(kill-buffer quail-guidance-buf))))
(defun quail-update-guidance ()
"Update the Quail guidance buffer and completion buffer (if displayed now)."
;; Update the guidance string.
(when (quail-require-guidance-buf)
(let ((guidance (quail-guidance)))
(cond ((or (eq guidance t)
(consp guidance))
;; Show the current possible translations.
(setq quail-guidance-str
(quail-get-translations)))
((null guidance)
;; Show the current input keys.
(let ((key quail-current-key))
(if (quail-kbd-translate)
(setq key (quail-keyseq-translate key)))
(setq quail-guidance-str (if (stringp key) key (string key)))))
(t
(setq quail-guidance-str " ")))))
;; Update completion buffer if displayed now. We highlight the
;; selected candidate string in *Completion* buffer if any.
(let ((win (get-buffer-window quail-completion-buf))
key str pos)
(if win
(save-excursion
(setq str (if (stringp quail-current-str)
quail-current-str
(if (numberp quail-current-str)
(char-to-string quail-current-str)))
key quail-current-key)
(set-buffer quail-completion-buf)
(goto-char (point-min))
(if (null (search-forward (concat " " key ":") nil t))
(delete-overlay quail-overlay)
(setq pos (point))
(if (and str (search-forward (concat "." str) nil t))
(move-overlay quail-overlay (1+ (match-beginning 0)) (point))
(move-overlay quail-overlay (match-beginning 0) (point)))
;; Now POS points end of KEY and (point) points end of STR.
(if (pos-visible-in-window-p (point) win)
;; STR is already visible.
nil
;; We want to make both KEY and STR visible, but if the
;; window is too short, make at least STR visible.
(setq pos (progn (point) (goto-char pos)))
(beginning-of-line)
(set-window-start win (point))
(if (not (pos-visible-in-window-p pos win))
(set-window-start win pos))
))))))
(defun quail-get-translations ()
"Return a string containing the current possible translations."
(or (multibyte-string-p quail-current-key)
(setq quail-current-key (string-to-multibyte quail-current-key)))
(let ((map (quail-lookup-key quail-current-key nil t))
(str (copy-sequence quail-current-key)))
(if quail-current-translations
(quail-update-current-translations))
;; Show the current key.
(let ((guidance (quail-guidance)))
(if (listp guidance)
;; We must replace the typed key with the specified PROMPT-KEY.
(dotimes (i (length str))
(let ((prompt-key (cdr (assoc (aref str i) guidance))))
(if prompt-key
(aset str i (aref prompt-key 0)))))))
;; Show followable keys.
(if (and (> (length quail-current-key) 0) (cdr map))
(setq str
(format "%s[%s]"
str
(concat (sort (mapcar (lambda (x) (car x))
(cdr map))
'<)))))
;; Show list of translations.
(if (and quail-current-translations
(not (quail-deterministic)))
(let* ((indices (car quail-current-translations))
(cur (car indices))
(start (nth 1 indices))
(end (nth 2 indices))
(idx start))
(if (< (string-width str)
(- quail-guidance-translations-starting-column 7))
(setq str
(concat str
(make-string
(- quail-guidance-translations-starting-column
7 (string-width str))
32))))
(setq str (format "%s(%02d/%s)"
str (nth 3 indices)
(if (nth 4 indices)
(format "%02d" (nth 4 indices))
"??")))
(while (< idx end)
(let ((len (length str))
(trans (aref (cdr quail-current-translations) idx)))
(or (stringp trans)
(setq trans (string trans)))
(setq str (format "%s %d.%s"
str
(if (= (- idx start) 9) 0
(1+ (- idx start)))
trans))
(if (= idx cur)
(put-text-property (+ len 3) (length str)
'face 'highlight str))
(setq idx (1+ idx))))))
str))
(defvar quail-completion-max-depth 5
"The maximum depth of Quail completion list.")
(defun quail-completion ()
"List all completions for the current key.
All possible translations of the current key and whole possible longer keys
are shown (at most to the depth specified `quail-completion-max-depth')."
(interactive)
(quail-setup-completion-buf)
(let ((win (get-buffer-window quail-completion-buf 'visible))
(key quail-current-key)
(map (quail-lookup-key quail-current-key nil t))
(require-update nil))
(with-current-buffer quail-completion-buf
(if (and win
(equal key quail-current-key)
(eq last-command 'quail-completion))
;; The window for Quail completion buffer has already been
;; shown. We just scroll it appropriately.
(if (pos-visible-in-window-p (point-max) win)
(set-window-start win (point-min))
(let ((other-window-scroll-buffer quail-completion-buf)
;; This nil binding is necessary to surely scroll
;; quail-completion-buf.
(minibuffer-scroll-window nil))
(scroll-other-window)))
(setq quail-current-key key)
(let ((inhibit-read-only t))
(erase-buffer)
(insert "Possible completion and corresponding characters are:\n")
(quail-completion-1 key map 1)
(set-buffer-modified-p nil))
(goto-char (point-min))
(display-buffer (current-buffer))
(setq require-update t)))
(if require-update
(quail-update-guidance)))
(setq this-command 'quail-completion))
(defun quail-completion-1 (key map indent)
"List all completions of KEY in MAP with indentation INDENT."
(let ((len (length key)))
(quail-indent-to indent)
(insert key ":")
(if (and (symbolp map) (fboundp map))
(setq map (funcall map key len)))
(if (car map)
(quail-completion-list-translations map key (+ indent len 1))
(insert " -\n"))
(setq indent (+ indent 2))
(if (and (cdr map) (< (/ (1- indent) 2) quail-completion-max-depth))
(let ((l (cdr map)))
(if (functionp l)
(setq l (funcall l)))
(dolist (elt (reverse l)) ; L = ((CHAR . DEFN) ....) ;
(quail-completion-1 (concat key (string (car elt)))
(cdr elt) indent))))))
(defun quail-completion-list-translations (map key indent)
"List all possible translations of KEY in Quail MAP with indentation INDENT."
(let (beg (translations
(quail-get-translation (car map) key (length key))))
(if (integerp translations)
(progn
(insert "(1/1) 1.")
;; Endow the character `translations' with `mouse-face' text
;; property to enable `mouse-2' completion.
(setq beg (point))
(insert translations)
(put-text-property beg (point) 'mouse-face 'highlight)
(insert "\n"))
;; We need only vector part.
(setq translations (cdr translations))
;; Insert every 10 elements with indices in a line.
(let ((len (length translations))
(i 0))
(while (< i len)
(when (zerop (% i 10))
(when (>= i 10)
(insert "\n")
(quail-indent-to indent))
(insert (format "(%d/%d)" (1+ (/ i 10)) (1+ (/ len 10)))))
;; We show the last digit of FROM while converting
;; 0,1,..,9 to 1,2,..,0.
(insert (format " %d." (% (1+ i) 10)))
(setq beg (point))
(insert (aref translations i))
;; Passing the mouse over a character will highlight.
(put-text-property beg (point) 'mouse-face 'highlight)
(setq i (1+ i)))
(insert "\n")))))
(defun quail-mouse-choose-completion (event)
"Click on an alternative in the `*Quail Completions*' buffer to choose it."
;; This function is an exact copy of the mouse.el function
;; `mouse-choose-completion' except that we:
;; 2) don't bury *Quail Completions* buffer, so comment a section, and
;; 3) delete/terminate the current quail selection here.
;; FIXME: Consolidate with `choose-completion'. The point number
;; 1 has been done, already. The point number 3 should be fairly
;; easy to move to a choose-completion-string-function. So all
;; that's left is point number 2.
(interactive "e")
;; Give temporary modes such as isearch a chance to turn off.
(run-hooks 'mouse-leave-buffer-hook)
(let ((buffer (window-buffer))
choice)
(with-current-buffer (window-buffer (posn-window (event-start event)))
(if completion-reference-buffer
(setq buffer completion-reference-buffer))
(save-excursion
(goto-char (posn-point (event-start event)))
(let (beg end)
(if (and (not (eobp)) (get-text-property (point) 'mouse-face))
(setq end (point) beg (1+ (point))))
(if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
(setq end (1- (point)) beg (point)))
(if (null beg)
(quail-error "No completion here"))
(setq beg (previous-single-property-change beg 'mouse-face))
(setq end (or (next-single-property-change end 'mouse-face)
(point-max)))
(setq choice (buffer-substring beg end)))))
;; (let ((owindow (selected-window)))
;; (select-window (posn-window (event-start event)))
;; (if (and (one-window-p t 'selected-frame)
;; (window-dedicated-p (selected-window)))
;; ;; This is a special buffer's frame
;; (iconify-frame (selected-frame))
;; (or (window-dedicated-p (selected-window))
;; (bury-buffer)))
;; (select-window owindow))
(quail-delete-region)
(setq quail-current-str choice)
;; FIXME: We need to pass `base-position' here.
;; FIXME: why do we need choose-completion-string with all its
;; completion-specific logic?
(choose-completion-string choice buffer)
(quail-terminate-translation)))
(defun quail-build-decode-map (map-list key decode-map num
&optional maxnum ignores)
"Build a decoding map.
Accumulate in the cdr part of DECODE-MAP all pairs of key sequences
vs the corresponding translations defined in the Quail map
specified by the first element MAP-LIST. Each pair has the form
\(KEYSEQ . TRANSLATION). DECODE-MAP should have the form
\(decode-map . ALIST), where ALIST is an alist of length NUM. KEY
is a key sequence to reach MAP.
Optional 5th arg MAXNUM limits the number of accumulated pairs.
Optional 6th arg IGNORES is a list of translations to ignore."
(let* ((map (car map-list))
(translation (quail-get-translation (car map) key (length key)))
elt)
(cond ((integerp translation)
;; Accept only non-ASCII chars not listed in IGNORES.
(when (and (> translation 127) (not (memq translation ignores)))
(setcdr decode-map
(cons (cons key translation) (cdr decode-map)))
(setq num (1+ num))))
((consp translation)
(setq translation (cdr translation))
(let ((multibyte nil))
(mapc (lambda (x)
;; Accept only non-ASCII chars not
;; listed in IGNORES.
(if (and (if (integerp x) (> x 127)
(string-match-p "[^[:ascii:]]" x))
(not (member x ignores)))
(setq multibyte t)))
translation)
(when multibyte
(setcdr decode-map
(cons (cons key translation) (cdr decode-map)))
(setq num (+ num (length translation)))))))
(if (and maxnum (> num maxnum))
(- num)
(setq map (cdr map))
;; Recursively check the deeper map.
(while (and map (>= num 0))
(setq elt (car map) map (cdr map))
(when (and (integerp (car elt)) (consp (cdr elt))
(not (memq (cdr elt) map-list)))
(setq num (quail-build-decode-map (cons (cdr elt) map-list)
(format "%s%c" key (car elt))
decode-map num maxnum ignores))))
num)))
(defun quail-insert-decode-map (decode-map)
"Insert pairs of key sequences vs the corresponding translations.
These are stored in DECODE-MAP using the concise format. DECODE-MAP
should be made by `quail-build-decode-map' (which see)."
(setq decode-map
(sort (cdr decode-map)
(lambda (x y)
(setq x (car x) y (car y))
(or (> (length x) (length y))
(and (= (length x) (length y))
(not (string< x y)))))))
(let ((window-width (window-width (get-buffer-window
(current-buffer) 'visible)))
(single-trans-width 4)
(single-list nil)
(multiple-list nil)
trans)
;; Divide the elements of decoding map into single ones (i.e. the
;; one that has single translation) and multiple ones (i.e. the
;; one that has multiple translations).
(dolist (elt decode-map)
(setq trans (cdr elt))
(if (and (vectorp trans) (= (length trans) 1))
(setq trans (aref trans 0)))
(if (vectorp trans)
(push elt multiple-list)
(push (cons (car elt) trans) single-list)
(let ((width (if (stringp trans) (string-width trans)
(char-width trans))))
(if (> width single-trans-width)
(setq single-trans-width width)))))
(when single-list
;; Figure out how many columns can fit.
(let* ((len (length single-list))
;; The longest key is at the end, by virtue of the above `sort'.
(max-key-width (max 3 (length (caar (last single-list)))))
;; Starting point: worst case.
(col-width (+ max-key-width 1 single-trans-width 1))
(cols (/ window-width col-width))
rows)
;; Now, let's see if we can pack in a few more columns since
;; the first columns can often be made narrower thanks to the
;; length-sorting.
(while (let ((newrows (/ (+ len cols) (1+ cols))) ;Round up.
(width 0))
(dotimes (col (1+ cols))
(let ((last-col-elt (or (nth (1- (* (1+ col) newrows))
single-list)
(car (last single-list)))))
(cl-incf width (+ (max 3 (length (car last-col-elt)))
1 single-trans-width 1))))
(< width window-width))
(cl-incf cols))
(setq rows (/ (+ len cols -1) cols)) ;Round up.
(let ((key-width (max 3 (length (car (nth (1- rows) single-list))))))
(insert "key")
(quail-indent-to (1+ key-width))
(insert "char")
(quail-indent-to (+ 1 key-width 1 single-trans-width 1)))
(insert "[type a key sequence to insert the corresponding character]\n")
(let ((pos (point))
(col 0))
(insert-char ?\n (+ rows 2))
(while single-list
(goto-char pos)
(let* ((key-width (max 3 (length
(car (or (nth (1- rows) single-list)
(car (last single-list)))))))
(col-width (+ key-width 1 single-trans-width 1)))
;; Insert the header-line.
(move-to-column col)
(quail-indent-to col)
(insert-char ?- key-width)
(insert ?\s)
(insert-char ?- single-trans-width)
(forward-line 1)
;; Insert the key-tran pairs.
(dotimes (_ rows)
(let ((elt (pop single-list)))
(when elt
(move-to-column col)
(quail-indent-to col)
(insert (propertize (car elt)
'face 'font-lock-comment-face))
(quail-indent-to (+ col key-width 1))
(insert (cdr elt))
(forward-line 1))))
(setq col (+ col col-width)))))
(goto-char (point-max))))
(when multiple-list
;; Since decode-map is sorted, we known the longest key is at the end.
(let ((max-key-width (max 3 (length (caar (last multiple-list))))))
(insert "key")
(quail-indent-to (1+ max-key-width))
(insert "character(s) [type a key (sequence) and select one from the list]\n")
(insert-char ?- max-key-width)
(insert " ------------\n")
(dolist (elt multiple-list)
(insert (propertize (car elt)
'face 'font-lock-comment-face))
(quail-indent-to max-key-width)
(if (vectorp (cdr elt))
(mapc (lambda (x)
(let ((width (if (integerp x) (char-width x)
(string-width x))))
(when (> (+ (current-column) 1 width) window-width)
(insert "\n")
(quail-indent-to max-key-width))
(insert " " x)))
(cdr elt))
(insert " " (cdr elt)))
(insert ?\n))
(insert ?\n)))))
(define-button-type 'quail-keyboard-layout-button
:supertype 'help-xref
'help-function (lambda (layout)
(help-setup-xref `(quail-keyboard-layout-button ,layout)
nil)
(quail-show-keyboard-layout layout))
'help-echo (purecopy "mouse-2, RET: show keyboard layout"))
(define-button-type 'quail-keyboard-customize-button
:supertype 'help-customize-variable
'help-echo (purecopy "mouse-2, RET: customize keyboard layout"))
(defun quail-help (&optional package)
"Show brief description of the current Quail package.
Optional arg PACKAGE specifies the name of alternative Quail
package to describe."
(require 'help-mode)
(let ((help-xref-mule-regexp help-xref-mule-regexp-template)
(mb enable-multibyte-characters)
(package-def
(if package
(assoc package quail-package-alist)
quail-current-package)))
;; At first, make sure that the help buffer has window.
(let ((temp-buffer-show-hook nil))
(with-output-to-temp-buffer (help-buffer)
(with-current-buffer standard-output
(set-buffer-multibyte mb)
(setq quail-current-package package-def))))
;; Then, insert text in the help buffer while paying attention to
;; the width of the window in which the buffer displayed.
(with-current-buffer (help-buffer)
(setq buffer-read-only nil)
;; Without this, a keyboard layout with R2L characters might be
;; displayed reversed, right to left. See the thread starting at
;; https://lists.gnu.org/r/emacs-devel/2012-03/msg00062.html
;; for a description of one such situation.
(setq bidi-paragraph-direction 'left-to-right)
(insert "Input method: " (quail-name)
" (mode line indicator:"
(quail-title)
")\n\n")
(save-restriction
(narrow-to-region (point) (point))
(insert (substitute-command-keys (quail-docstring)))
(goto-char (point-min))
(with-syntax-table emacs-lisp-mode-syntax-table
(while (re-search-forward "\\\\<\\sw\\(\\sw\\|\\s_\\)+>" nil t)
(let ((sym (intern-soft
(buffer-substring (+ (match-beginning 0) 2)
(1- (point))))))
(if (and (boundp sym)
(stringp (symbol-value sym)))
(replace-match (symbol-value sym) t t)))))
(goto-char (point-max)))
(or (bolp)
(insert "\n"))
(insert "\n")
(let ((done-list nil))
;; Show keyboard layout if the current package requests it..
(when (quail-show-layout)
(insert (substitute-command-keys "
KEYBOARD LAYOUT
---------------
This input method works by translating individual input characters.
Assuming that your actual keyboard has the `"))
(help-insert-xref-button
quail-keyboard-layout-type
'quail-keyboard-layout-button
quail-keyboard-layout-type)
(insert (substitute-command-keys "' layout,
translation results in the following \"virtual\" keyboard layout
\(the labels on the keys indicate what character will be produced
by each key, with and without holding Shift):
"))
(setq done-list
(quail-insert-kbd-layout quail-keyboard-layout))
(insert (substitute-command-keys "\
If your keyboard has a different layout, rearranged from
`"))
(help-insert-xref-button
"standard"
'quail-keyboard-layout-button "standard")
(insert (substitute-command-keys "\
', the \"virtual\" keyboard you get with this input method
will be rearranged in the same way.
You can set the variable `quail-keyboard-layout-type' to specify
the physical layout of your keyboard; the tables shown in
documentation of input methods including this one are based on the
physical keyboard layout as specified with that variable.
"))
(help-insert-xref-button
"[customize keyboard layout]"
'quail-keyboard-customize-button 'quail-keyboard-layout-type)
(insert "\n"))
;; Show key sequences.
(let* ((decode-map (list 'decode-map))
(num (quail-build-decode-map (list (quail-map)) "" decode-map
;; We used to use 512 here, but
;; TeX has more than 1000 and
;; it's good to see the list.
0 5120 done-list)))
(when (> num 0)
(insert "
KEY SEQUENCE
------------
")
(if (quail-show-layout)
(insert "You can also input more characters")
(insert "You can input characters"))
(insert " by the following key sequences:\n")
(quail-insert-decode-map decode-map))))
(quail-help-insert-keymap-description
(quail-translation-keymap)
"\
KEY BINDINGS FOR TRANSLATION
----------------------------\n")
(insert ?\n)
(if (quail-conversion-keymap)
(quail-help-insert-keymap-description
(quail-conversion-keymap)
"\
KEY BINDINGS FOR CONVERSION
---------------------------\n"))
(setq quail-current-package nil)
;; Resize the help window again, now that it has all its contents.
(save-selected-window
(select-window (get-buffer-window (current-buffer) t))
(run-hooks 'temp-buffer-show-hook)))))
(defun quail-help-insert-keymap-description (keymap &optional header)
(defvar the-keymap)
(let ((pos1 (point))
(the-keymap keymap)
pos2)
(if header
(insert header))
(save-excursion
(insert (substitute-command-keys "\\{the-keymap}")))
;; Skip headers "key bindings", etc.
(forward-line 3)
(setq pos2 (point))
(with-syntax-table emacs-lisp-mode-syntax-table
(while (re-search-forward "\\sw\\(\\sw\\|\\s_\\)+" nil t)
(let ((sym (intern-soft (buffer-substring (match-beginning 0)
(point)))))
(if (and sym (fboundp sym)
(or (eq (get sym 'quail-help) 'hide)
(and (quail-deterministic)
(eq (get sym 'quail-help) 'non-deterministic))))
(delete-region (line-beginning-position)
(1+ (line-end-position)))))))
(goto-char pos2)
(while (not (eobp))
(if (looking-at "[ \t]*$")
(delete-region (point) (1+ (line-end-position)))
(forward-line 1)))
(goto-char pos2)
(if (eobp)
(delete-region pos1 (point)))
(goto-char (point-max))))
(defun quail-translation-help ()
"Show help message while translating in Quail input method."
(interactive)
(if (not (eq this-command last-command))
(let (state-msg keymap)
(if (and quail-converting (= (length quail-current-key) 0))
(setq state-msg
(format "Converting string %S by input method %S.\n"
quail-conversion-str (quail-name))
keymap (quail-conversion-keymap))
(setq state-msg
(format "Translating key sequence %S by input method %S.\n"
quail-current-key (quail-name))
keymap (quail-translation-keymap)))
(with-output-to-temp-buffer "*Help*"
(with-current-buffer standard-output
(insert state-msg)
(quail-help-insert-keymap-description
keymap
"-----------------------\n")
;; Isn't this redundant ? -stef
(help-mode)))))
(let (scroll-help)
(save-selected-window
(select-window (get-buffer-window "*Help*"))
(if (eq this-command last-command)
(if (< (window-end) (point-max))
(scroll-up)
(if (> (window-start) (point-min))
(set-window-start (selected-window) (point-min)))))
(setq scroll-help
(if (< (window-end (selected-window) 'up-to-date) (point-max))
"Type \\[quail-translation-help] to scroll up the help"
(if (> (window-start) (point-min))
"Type \\[quail-translation-help] to see the head of help"))))
(if scroll-help
(progn
(message "%s" (substitute-command-keys scroll-help))
(sit-for 1)
(message nil)
(quail-update-guidance)
))))
\f
;; Add KEY (string) to the element of TABLE (char-table) for CHAR if
;; it is not yet stored. As a result, the element is a string or a
;; list of strings.
(defun quail-store-decode-map-key (table char key)
(let ((elt (aref table char)))
(if elt
(if (consp elt)
(or (member key elt)
(aset table char (cons key elt)))
(or (string= key elt)
(aset table char (list key elt))))
(aset table char key))
;; Avoid "obsolete" warnings for translation-table-for-input.
(with-no-warnings
(if (and translation-table-for-input
(setq char (aref translation-table-for-input char)))
(let ((translation-table-for-input nil))
(quail-store-decode-map-key table char key))))))
;; Helper function for quail-gen-decode-map. Store key strings to
;; type each character under MAP in TABLE (char-table). MAP is an
;; element of the current Quail map reached by typing keys in KEY
;; (string).
(defun quail-gen-decode-map1 (map key table)
(when (and (consp map) (listp (cdr map)))
(let ((trans (car map)))
(cond ((integerp trans)
(quail-store-decode-map-key table trans key))
((stringp trans)
(dotimes (i (length trans))
(quail-store-decode-map-key table (aref trans i) key)))
((or (vectorp trans)
(and (consp trans)
(setq trans (cdr trans))))
(dotimes (i (length trans))
(let ((elt (aref trans i)))
(if (stringp elt)
(if (= (length elt) 1)
(quail-store-decode-map-key table (aref elt 0) key))
(quail-store-decode-map-key table elt key)))))))
(if (> (length key) 1)
(dolist (elt (cdr map))
(quail-gen-decode-map1 (cdr elt) key table))
(dolist (elt (cdr map))
(quail-gen-decode-map1 (cdr elt) (format "%s%c" key (car elt))
table)))))
(put 'quail-decode-map 'char-table-extra-slots 0)
;; Generate a half-cooked decode map (char-table) for the current
;; Quail map. An element for a character C is a key string or a list
;; of a key strings to type to input C. The length of key string is at
;; most 2. If it is 2, more keys may be required to input C.
(defun quail-gen-decode-map ()
(let ((table (make-char-table 'quail-decode-map nil)))
(dolist (elt (cdr (quail-map)))
(quail-gen-decode-map1 (cdr elt) (string (car elt)) table))
table))
;; Check if CHAR equals to TARGET while also trying to translate CHAR
;; by translation-table-for-input.
(defsubst quail-char-equal-p (char target)
(or (= char target)
;; Avoid "obsolete" warnings for translation-table-for-input.
(with-no-warnings
(and translation-table-for-input
(setq char (aref translation-table-for-input char))
(= char target)))))
;; Helper function for quail-find-key. Prepend key strings to type
;; for inputting CHAR by the current input method to KEY-LIST and
;; return the result. MAP is an element of the current Quail map
;; reached by typing keys in KEY.
(defun quail-find-key1 (map key char key-list)
(let ((trans (car map))
(found-here nil))
(cond ((stringp trans)
(setq found-here
(and (= (length trans) 1)
(quail-char-equal-p (aref trans 0) char))))
((or (vectorp trans) (consp trans))
(if (consp trans)
(setq trans (cdr trans)))
(setq found-here
(catch 'tag
(dotimes (i (length trans))
(let ((target (aref trans i)))
(if (integerp target)
(if (quail-char-equal-p target char)
(throw 'tag t))
(if (and (= (length target) 1)
(quail-char-equal-p (aref target 0) char))
(throw 'tag t))))))))
((integerp trans)
(setq found-here (quail-char-equal-p trans char))))
(if found-here
(setq key-list (cons key key-list)))
(if (> (length key) 1)
(dolist (elt (cdr map))
(setq key-list
(quail-find-key1 (cdr elt) (format "%s%c" key (car elt))
char key-list))))
key-list))
;; If non-nil, the value has the form (QUAIL-MAP . CODING-SYSTEM)
;; where QUAIL-MAP is a quail-map of which decode map was generated
;; while buffer-file-coding-system was CODING-SYSTEM.
(defvar quail-decode-map-generated nil)
(defun quail-find-key (char)
"Return a list of keys to type to input CHAR in the current input method.
If CHAR is an ASCII character and can be input by typing itself, return t."
(let ((decode-map (or (and (or (not quail-decode-map-generated)
(and (eq (car quail-decode-map-generated) (quail-map))
(eq (cdr quail-decode-map-generated)
(or buffer-file-coding-system t))))
(quail-decode-map))
(let ((map (quail-gen-decode-map)))
(setq quail-decode-map-generated
(cons (quail-map) (or buffer-file-coding-system t)))
(setcar (nthcdr 10 quail-current-package) map)
map)))
(key-list nil))
(if (consp decode-map)
(let ((str (string char)))
(mapc (lambda (elt)
(if (string= str (car elt))
(setq key-list (cons (cdr elt) key-list))))
(cdr decode-map)))
(let ((key-head (aref decode-map char)))
(if (stringp key-head)
(setq key-list (quail-find-key1
(quail-lookup-key key-head nil t)
key-head char nil))
(mapc (lambda (elt)
(setq key-list
(quail-find-key1
(quail-lookup-key elt nil t) elt char key-list)))
key-head))))
(or key-list
(and (< char 128)
(not (quail-lookup-key (string char) 1))))))
(defun quail-show-key ()
"Show a list of key strings to type for inputting a character at point."
(interactive)
(or current-input-method
(error "No input method is activated"))
(or (assoc current-input-method quail-package-alist)
(error "The current input method does not use Quail"))
(let* ((char (following-char))
(key-list (quail-find-key char)))
(cond ((consp key-list)
(message "To input `%c', type \"%s\""
char
(mapconcat 'identity key-list "\", \"")))
((eq key-list t)
(message "To input `%s', just type it"
(single-key-description char)))
(t
(message "%c can't be input by the current input method" char)))))
\f
;; Quail map generator from state transition table.
(defun quail-map-from-table (table)
"Make quail map from state transition table TABLE.
TABLE is an alist, the form is:
((STATE-0 TRANSITION-0-1 TRANSITION-0-2 ...) (STATE-1 ...) ...)
STATE-n are symbols to denote state. STATE-0 is the initial state.
TRANSITION-n-m are transition rules from STATE-n, and have the form
\(RULES . STATE-x) or RULES, where STATE-x is one of STATE-n above,
RULES is a symbol whose value is an alist of keys \(string) vs the
corresponding characters or strings. The format of the symbol value of
RULES is the same as arguments to `quail-define-rules'.
If TRANSITION-n-m has the form (RULES . STATE-x), it means that
STATE-n transits to STATE-x when keys in RULES are input. Recursive
transition is allowed, i.e. STATE-x may be STATE-n.
If TRANSITION-n-m has the form RULES, the transition terminates
when keys in RULES are input.
The generated map can be set for the current Quail package by the
function `quail-install-map' (which see)."
(let ((state-alist (mapcar (lambda (x) (list (car x))) table))
tail elt)
;; STATE-ALIST is an alist of states vs the corresponding sub Quail
;; map. It is now initialized to ((STATE-0) (STATE-1) ...).
;; Set key sequence mapping rules in cdr part of each element.
(while table
(quail-map-from-table-1 state-alist (car table))
(setq table (cdr table)))
;; Now STATE-ALIST has the form ((STATE-0 MAPPING-RULES) ...).
;; Elements of MAPPING-RULES may have the form (STATE-x). Replace
;; them with MAPPING-RULES of STATE-x to make elements of
;; STATE-ALIST valid Quail maps.
(setq tail state-alist)
(while tail
(setq elt (car tail) tail (cdr tail))
(quail-map-from-table-2 state-alist elt))
;; Return the Quail map for the initial state.
(car state-alist)))
;; STATE-INFO has the form (STATE TRANSITION ...). Set key sequence
;; mapping rules in the element of STATE-ALIST that corresponds to
;; STATE according to TRANSITION ...
(defun quail-map-from-table-1 (state-alist state-info)
(let* ((state (car state-info))
(map (assq state state-alist))
(transitions (cdr state-info))
elt)
(while transitions
(setq elt (car transitions) transitions (cdr transitions))
(let (rules dst-state key trans)
;; ELT has the form (RULES-SYMBOL . STATE-x) or RULES-SYMBOL.
;; STATE-x is one of car parts of STATE-ALIST's elements.
(if (consp elt)
(setq rules (symbol-value (car elt))
;; Set (STATE-x) as branches for all keys in RULES.
;; It is replaced with actual branches for STATE-x
;; later in `quail-map-from-table-2'.
dst-state (list (cdr elt)))
(setq rules (symbol-value elt)))
(while rules
(setq key (car (car rules)) trans (cdr (car rules))
rules (cdr rules))
(if (stringp trans)
(if (= (length trans) 1)
(setq trans (aref trans 0))
(setq trans (string-to-vector trans))))
(set-nested-alist key trans map nil dst-state))))))
;; ELEMENT is one element of STATE-ALIST. ELEMENT is a nested alist;
;; the form is:
;; (STATE (CHAR NESTED-ALIST) ...)
;; NESTED-ALIST is a nested alist; the form is:
;; (TRANS (CHAR NESTED-ALIST) ...)
;; or
;; (TRANS (CHAR NESTED-ALIST) ... . (STATE-x))
;; Here, the task is to replace all occurrences of (STATE-x) with:
;; (cdr (assq STATE-x STATE-ALIST))
(defun quail-map-from-table-2 (state-alist element)
(let ((prev element)
(tail (cdr element))
elt)
(while (cdr tail)
(setq elt (car tail) prev tail tail (cdr tail))
(quail-map-from-table-2 state-alist (cdr elt)))
(setq elt (car tail))
(if (consp elt)
(quail-map-from-table-2 state-alist (cdr elt))
(setcdr prev (cdr (assq elt state-alist))))))
;; Concatenate translations for all heading substrings of KEY in the
;; current Quail map. Here, `heading substring' means (substring KEY
;; 0 LEN), where LEN is 1, 2, ... (length KEY).
(defun quail-lookup-map-and-concat (key)
(let* ((len (length key))
(translation-list nil)
map)
(while (> len 0)
(setq map (quail-lookup-key key len t)
len (1- len))
(if map
(let* ((def (quail-map-definition map))
(trans (if (consp def) (aref (cdr def) (car (car def)))
def)))
(if (integerp trans)
(setq trans (char-to-string trans)))
(setq translation-list (cons trans translation-list)))))
(apply 'concat translation-list)))
\f
(defvar quail-directory-name "quail"
"Name of Quail directory which contains Quail packages.
This is a sub-directory of LEIM directory.")
;;;###autoload
(defun quail-update-leim-list-file (dirname &rest dirnames)
"Update entries for Quail packages in `LEIM' list file in directory DIRNAME.
DIRNAME is a directory containing Emacs input methods;
normally, it should specify the `leim' subdirectory
of the Emacs source tree.
It searches for Quail packages under `quail' subdirectory of DIRNAME,
and update the file \"leim-list.el\" in DIRNAME.
When called from a program, the remaining arguments are additional
directory names to search for Quail packages under `quail' subdirectory
of each directory."
(interactive "FDirectory of LEIM: ")
(setq dirname (expand-file-name dirname))
(let ((leim-list (expand-file-name leim-list-file-name dirname))
quail-dirs list-buf pkg-list pos)
(if (not (file-writable-p leim-list))
(error "Can't write to file \"%s\"" leim-list))
(or noninteractive (message "Updating %s ..." leim-list))
(setq list-buf (find-file-noselect leim-list))
;; At first, clean up the file.
(with-current-buffer list-buf
(goto-char (point-min))
;; Insert the correct header.
(if (looking-at (regexp-quote leim-list-header))
(goto-char (match-end 0))
(insert leim-list-header))
(setq pos (point))
(if (not (re-search-forward leim-list-entry-regexp nil t))
nil
;; Remove garbage after the header.
(goto-char (match-beginning 0))
(if (< pos (point))
(delete-region pos (point)))
;; Remove all entries for Quail.
(while (re-search-forward leim-list-entry-regexp nil 'move)
(goto-char (match-beginning 0))
(setq pos (point))
(condition-case nil
(let ((form (read list-buf)))
(when (equal (nth 3 form) ''quail-use-package)
(if (eolp) (forward-line 1))
(delete-region pos (point))))
(error
;; Delete the remaining contents because it seems that
;; this file is broken.
(message "Garbage in %s deleted" leim-list)
(delete-region pos (point-max)))))))
;; Search for `quail' subdirectory under each DIRNAMES.
(setq dirnames (cons dirname dirnames))
(let ((l dirnames))
(while l
(setcar l (expand-file-name (car l)))
(setq dirname (expand-file-name quail-directory-name (car l)))
(if (file-readable-p dirname)
(setq quail-dirs (cons dirname quail-dirs))
(message "%s doesn't have `%s' subdirectory, just ignored"
(car l) quail-directory-name)
(setq quail-dirs (cons nil quail-dirs)))
(setq l (cdr l)))
(setq quail-dirs (nreverse quail-dirs)))
;; Insert input method registering forms.
(while quail-dirs
(setq dirname (car quail-dirs))
(when dirname
(setq pkg-list (directory-files dirname 'full "\\.el\\'"))
(while pkg-list
(with-temp-buffer
(insert-file-contents (car pkg-list))
(goto-char (point-min))
;; Don't get fooled by commented-out code.
(while (re-search-forward "^[ \t]*(quail-define-package" nil t)
(goto-char (match-beginning 0))
(let (form)
(condition-case err
(progn
(setq form (read (current-buffer)))
(with-current-buffer list-buf
(insert
(format "(register-input-method
%S %S '%s
%S %S
%S)\n"
(nth 1 form) ; PACKAGE-NAME
(nth 2 form) ; LANGUAGE
'quail-use-package ; ACTIVATE-FUNC
(nth 3 form) ; PACKAGE-TITLE
(progn ; PACKAGE-DESCRIPTION (one line)
(string-match ".*" (nth 5 form))
(match-string 0 (nth 5 form)))
(file-relative-name ; PACKAGE-FILENAME
(file-name-sans-extension (car pkg-list))
(car dirnames))))))
(error
;; Ignore the remaining contents of this file.
(goto-char (point-max))
(message "Some part of \"%s\" is broken: %s in %s"
(car pkg-list) err form))))))
(setq pkg-list (cdr pkg-list)))
(setq quail-dirs (cdr quail-dirs) dirnames (cdr dirnames))))
;; At last, write out LEIM list file.
(with-current-buffer list-buf
(let ((coding-system-for-write 'utf-8))
(save-buffer 0)))
(kill-buffer list-buf)
(or noninteractive (message "Updating %s ... done" leim-list))))
\f
(defun quail-advice (args)
"Advise users about the characters input by the current Quail package.
The argument is a parameterized event of the form:
(quail-advice STRING)
where STRING is a string containing the input characters.
If STRING has property `advice' and the value is a function,
call it with one argument STRING."
(interactive "e")
(let* ((string (nth 1 args))
(func (get-text-property 0 'advice string)))
(if (functionp func)
(funcall func string))))
(global-set-key [quail-advice] 'quail-advice)
;;
(provide 'quail)
;;; quail.el ends here
|