1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
| | ;;; rcirc.el --- default, simple IRC client -*- lexical-binding: t; -*-
;; Copyright (C) 2005-2024 Free Software Foundation, Inc.
;; Author: Ryan Yeske <rcyeske@gmail.com>
;; Maintainers: Ryan Yeske <rcyeske@gmail.com>,
;; Leo Liu <sdl.web@gmail.com>,
;; Philip Kaludercic <philipk@posteo.net>
;; Keywords: comm
;; 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:
;; Internet Relay Chat (IRC) is a form of instant communication over
;; the Internet. It is mainly designed for group (many-to-many)
;; communication in discussion forums called channels, but also allows
;; one-to-one communication.
;; Rcirc has simple defaults and clear and consistent behavior.
;; Message arrival timestamps, activity notification on the mode line,
;; message filling, nick completion, and keepalive pings are all
;; enabled by default, but can easily be adjusted or turned off. Each
;; discussion takes place in its own buffer and there is a single
;; server buffer per connection.
;; Open a new irc connection with:
;; M-x irc RET
;;; Code:
(require 'cl-lib)
(require 'ring)
(require 'time-date)
(require 'auth-source)
(require 'parse-time)
(eval-when-compile (require 'subr-x))
(eval-when-compile (require 'rx))
(defconst rcirc-id-string (concat "rcirc on GNU Emacs " emacs-version))
(defgroup rcirc nil
"Simple IRC client."
:version "22.1"
:prefix "rcirc-"
:link '(custom-manual "(rcirc)")
:group 'applications)
(defcustom rcirc-server-alist
(if (gnutls-available-p)
'(("irc.libera.chat" :channels ("#emacs" "#rcirc")
:port 6697 :encryption tls))
'(("irc.libera.chat" :channels ("#emacs" "#rcirc"))))
"An alist of IRC connections to establish when running `rcirc'.
Each element looks like (SERVER-NAME PARAMETERS).
SERVER-NAME is a string describing the server to connect
to.
The optional PARAMETERS come in pairs PARAMETER VALUE.
The following parameters are recognized:
`:nick'
VALUE must be a string. If absent, `rcirc-default-nick' is used
for this connection.
`:port'
VALUE must be a number or string. If absent,
`rcirc-default-port' is used.
`:user-name'
VALUE must be a string. If absent, `rcirc-default-user-name' is
used.
`:password'
VALUE must be a string. If absent, no PASS command will be sent
to the server.
`:full-name'
VALUE must be a string. If absent, `rcirc-default-full-name' is
used.
`:channels'
VALUE must be a list of strings describing which channels to join
when connecting to this server. If absent, no channels will be
connected to automatically.
`:encryption'
VALUE must be `plain' (the default) for unencrypted connections, or `tls'
for connections using SSL/TLS.
`:server-alias'
VALUE must be a string that will be used instead of the server
name for display purposes. If absent, the real server name will
be displayed instead."
:type '(alist :key-type string
:value-type (plist :options
((:nick string)
(:port integer)
(:user-name string)
(:password string)
(:full-name string)
(:channels (repeat string))
(:encryption (choice (const tls)
(const plain)))
(:server-alias string))))
:version "28.1")
(defcustom rcirc-default-port 6667
"The default port to connect to."
:type 'natnum)
(defcustom rcirc-default-nick (user-login-name)
"Your nick."
:type 'string)
(defcustom rcirc-default-user-name "user"
"Your user name sent to the server when connecting."
:version "24.1" ; changed default
:type 'string)
(defcustom rcirc-default-full-name "unknown"
"The full name sent to the server when connecting."
:version "24.1" ; changed default
:type 'string)
(defcustom rcirc-default-part-reason rcirc-id-string
"The default reason to send when parting from a channel.
Used when no reason is explicitly given."
:type 'string)
(defcustom rcirc-default-quit-reason rcirc-id-string
"The default reason to send when quitting a server.
Used when no reason is explicitly given."
:type 'string)
(defcustom rcirc-fill-flag t
"Non-nil means line-wrap messages printed in channel buffers."
:type 'boolean)
(defcustom rcirc-fill-column nil
"Column beyond which automatic line-wrapping should happen.
If nil, use value of `fill-column'.
If a function (e.g., `frame-text-width' or `window-text-width'),
call it to compute the number of columns."
:risky t ; can get funcalled
:type '(choice (const :tag "Value of `fill-column'" nil)
(integer :tag "Number of columns")
(function :tag "Function returning the number of columns")))
(defcustom rcirc-fill-prefix nil
"Text to insert before filled lines.
If nil, calculate the prefix dynamically to line up text
underneath each nick."
:type '(choice (const :tag "Dynamic" nil)
(string :tag "Prefix text")))
(defcustom rcirc-url-max-length nil
"Maximum number of characters in displayed URLs.
If nil, no maximum is applied."
:version "27.1"
:type '(choice (const :tag "No maximum" nil)
(integer :tag "Number of characters")))
(defvar-local rcirc-ignore-buffer-activity-flag nil
"Non-nil means ignore activity in this buffer.")
(defvar-local rcirc-low-priority-flag nil
"Non-nil means activity in this buffer is considered low priority.")
(defvar-local rcirc-pending-requests '()
"List of pending requests.
See `rcirc-omit-unless-requested'.")
(defcustom rcirc-omit-unless-requested '()
"List of commands to only be requested if preceded by a command.
For example, if \"TOPIC\" is added to this list, TOPIC commands
will only be displayed if `rcirc-cmd-TOPIC' was previously
invoked. Commands will only be hidden if `rcirc-omit-mode' is
enabled."
:version "28.1"
:type '(repeat string))
(defcustom rcirc-omit-responses
'("JOIN" "PART" "QUIT" "NICK")
"Responses which will be hidden when `rcirc-omit-mode' is enabled."
:type '(repeat string))
(defvar-local rcirc-prompt-start-marker nil
"Marker indicating the beginning of the message prompt.")
(define-minor-mode rcirc-omit-mode
"Toggle the hiding of \"uninteresting\" lines.
Uninteresting lines are those whose responses are listed in
`rcirc-omit-responses'."
:lighter " Omit"
(if rcirc-omit-mode
(add-to-invisibility-spec '(rcirc-omit . nil))
(remove-from-invisibility-spec '(rcirc-omit . nil)))
(dolist (window (get-buffer-window-list (current-buffer)))
(with-selected-window window
(recenter (when (> (point) rcirc-prompt-start-marker) -1)))))
(defcustom rcirc-time-format "%H:%M "
"Describes how timestamps are printed.
Used as the first arg to `format-time-string'."
:type 'string)
(defcustom rcirc-log-time-format "%d-%b %H:%M "
"Describes how timestamps are printed in the log files.
Used as the first arg to `format-time-string'."
:version "30.1"
:type 'string )
(defcustom rcirc-input-ring-size 1024
"Size of input history ring."
:type 'integer)
(defcustom rcirc-read-only-flag t
"Non-nil means make text in IRC buffers read-only."
:type 'boolean)
(defcustom rcirc-buffer-maximum-lines nil
"The maximum size in lines for rcirc buffers.
Channel buffers are truncated from the top to be no greater than this
number. If zero or nil, no truncating is done."
:type '(choice (const :tag "No truncation" nil)
(integer :tag "Number of lines")))
(defcustom rcirc-scroll-show-maximum-output t
"Non-nil means scroll to keep the point at the bottom of the window."
:type 'boolean)
(defcustom rcirc-authinfo nil
"List of authentication passwords.
Each element of the list is a list with a SERVER-REGEXP string
and a method symbol followed by method specific arguments.
The valid METHOD symbols are `nickserv', `chanserv' and
`bitlbee'.
The ARGUMENTS for each METHOD symbol are:
`nickserv': NICK PASSWORD [NICKSERV-NICK]
`chanserv': NICK CHANNEL PASSWORD
`bitlbee': NICK PASSWORD
`quakenet': ACCOUNT PASSWORD
`sasl': NICK PASSWORD
`certfp': KEY CERT
Examples:
((\"Libera.Chat\" nickserv \"bob\" \"p455w0rd\")
(\"Libera.Chat\" chanserv \"bob\" \"#bobland\" \"passwd99\")
(\"Libera.Chat\" certfp \"/path/to/key\" \"/path/to/cert\")
(\"bitlbee\" bitlbee \"robert\" \"sekrit\")
(\"dal.net\" nickserv \"bob\" \"sekrit\" \"NickServ@services.dal.net\")
(\"quakenet.org\" quakenet \"bobby\" \"sekrit\")
(\"oftc\" sasl \"bob\" \"hunter2\"))"
:type '(alist :key-type (regexp :tag "Server")
:value-type (choice (list :tag "NickServ"
(const nickserv)
(string :tag "Nick")
(string :tag "Password"))
(list :tag "ChanServ"
(const chanserv)
(string :tag "Nick")
(string :tag "Channel")
(string :tag "Password"))
(list :tag "BitlBee"
(const bitlbee)
(string :tag "Nick")
(string :tag "Password"))
(list :tag "QuakeNet"
(const quakenet)
(string :tag "Account")
(string :tag "Password"))
(list :tag "SASL"
(const sasl)
(string :tag "Nick")
(string :tag "Password"))
(list :tag "CertFP"
(const certfp)
(string :tag "Key")
(string :tag "Certificate")))))
(defcustom rcirc-auto-authenticate-flag t
"Non-nil means automatically send authentication string to server.
See also `rcirc-authinfo'."
:type 'boolean)
(defcustom rcirc-authenticate-before-join t
"Non-nil means authenticate to services before joining channels.
Currently only works with NickServ on some networks."
:version "24.1"
:type 'boolean)
(defcustom rcirc-prompt "> "
"Prompt string to use in IRC buffers.
The following replacements are made:
%n is your nick.
%s is the server.
%t is the buffer target, a channel or a user.
Setting this alone will not affect the prompt; use either
\\[execute-extended-command] customize or also call
`rcirc-update-prompt'."
:type 'string
:set #'rcirc-set-changed
:initialize 'custom-initialize-default)
(defcustom rcirc-keywords nil
"List of keywords to highlight in message text."
:type '(repeat string))
(defcustom rcirc-ignore-list ()
"List of ignored nicks.
Use /ignore to list them, use /ignore NICK to add or remove a nick."
:type '(repeat string))
(defvar rcirc-ignore-list-automatic ()
"List of ignored nicks added to `rcirc-ignore-list' because of renaming.
When an ignored person renames, their nick is added to both lists.
Nicks will be removed from the automatic list on follow-up renamings or
parts.")
(defcustom rcirc-bright-nicks nil
"List of nicks to be emphasized.
See `rcirc-bright-nick' face."
:type '(repeat string))
(defcustom rcirc-dim-nicks nil
"List of nicks to be deemphasized.
See `rcirc-dim-nick' face."
:type '(repeat string))
(defcustom rcirc-print-functions nil
"Hook run after text is printed.
Called with 5 arguments, PROCESS, SENDER, RESPONSE, TARGET and TEXT."
:type 'hook)
(defvar rcirc-authenticated-hook nil
"Hook run after successfully authenticated.
Functions in this hook are called with a single argument PROCESS.")
(defcustom rcirc-always-use-server-buffer-flag nil
"Non-nil means messages without a channel target will go to the server buffer."
:type 'boolean)
(defcustom rcirc-decode-coding-system 'utf-8
"Coding system used to decode incoming irc messages.
Set to `undecided' if you want the encoding of the incoming
messages autodetected."
:type 'coding-system)
(defcustom rcirc-encode-coding-system 'utf-8
"Coding system used to encode outgoing irc messages."
:type 'coding-system)
(defcustom rcirc-coding-system-alist nil
"Alist to decide a coding system to use for a channel I/O operation.
The format is ((PATTERN . VAL) ...).
PATTERN is either a string or a cons of strings.
If PATTERN is a string, it is used to match a target.
If PATTERN is a cons of strings, the car part is used to match a
target, and the cdr part is used to match a server.
VAL is either a coding system or a cons of coding systems.
If VAL is a coding system, it is used for both decoding and encoding
messages.
If VAL is a cons of coding systems, the car part is used for decoding,
and the cdr part is used for encoding."
:type '(alist :key-type (choice (regexp :tag "Channel Regexp")
(cons (regexp :tag "Channel Regexp")
(regexp :tag "Server Regexp")))
:value-type (choice coding-system
(cons (coding-system :tag "Decode")
(coding-system :tag "Encode")))))
(defcustom rcirc-multiline-major-mode #'text-mode
"Major-mode function to use in multiline edit buffers."
:version "30.1"
:type 'function)
(defcustom rcirc-nick-completion-format "%s: "
"Format string to use in nick completions.
The format string is only used when completing at the beginning
of a line. The string is passed as the first argument to
`format' with the nickname as the second argument."
:version "24.1"
:type 'string)
(defcustom rcirc-kill-channel-buffers nil
"When non-nil, kill channel buffers when the server buffer is killed.
Only the channel buffers associated with the server in question
will be killed."
:version "24.3"
:type 'boolean)
(defcustom rcirc-nick-filter #'identity
"Function applied to nicknames before displaying."
:version "28.1"
:type 'function)
(defcustom rcirc-channel-filter #'identity
"Function applied to channels before displaying."
:version "28.1"
:type 'function)
(defcustom rcirc-track-ignore-server-buffer-flag nil
"Non-nil means activities in the server buffer are not traced."
:version "28.1"
:type 'boolean)
(defcustom rcirc-display-server-buffer t
"Non-nil means the server buffer should be shown on connecting."
:version "28.1"
:type 'boolean)
(defcustom rcirc-cycle-completion-flag nil
"Non-nil means to use cycling for completion in rcirc buffers.
See the Info node `(emacs) Completion Options' for background on
what cycling completion means."
:version "29.1"
:set (lambda (sym val)
(dolist (buf (match-buffers '(major-mode . rcirc-mode)))
(with-current-buffer buf
(if val
(setq-local completion-cycle-threshold t)
(kill-local-variable 'completion-cycle-threshold))))
(set-default sym val))
:type 'boolean)
(defvar-local rcirc-nick nil
"The nickname used for the current connection.")
(defvar-local rcirc-prompt-end-marker nil
"Marker indicating the end of the message prompt.")
(defvar-local rcirc-nick-table nil
"Hash table mapping nicks to channels.")
(defvar-local rcirc-recent-quit-alist nil
"Alist of nicks that have recently quit or parted the channel.")
(defvar rcirc-nick-syntax-table
(let ((table (make-syntax-table text-mode-syntax-table)))
(mapc (lambda (c) (modify-syntax-entry c "w" table))
"[]\\`_^{|}-")
(modify-syntax-entry ?' "_" table)
table)
"Syntax table which includes all nick characters as word constituents.")
(defvar-local rcirc-buffer-alist nil
"Alist of (TARGET . BUFFER) pairs.")
(defvar rcirc-activity nil
"List of buffers with unviewed activity.")
(defvar rcirc-activity-string ""
"String displayed in mode line representing `rcirc-activity'.")
(put 'rcirc-activity-string 'risky-local-variable t)
(defvar-local rcirc-server-buffer nil
"The server buffer associated with this channel buffer.")
(defvar-local rcirc-server-parameters nil
"List of parameters received from the server.")
(defvar-local rcirc-target nil
"The channel or user associated with this buffer.")
(defvar-local rcirc-urls nil
"List of URLs seen in the current buffer and their start positions.")
(put 'rcirc-urls 'permanent-local t)
(defvar rcirc-timeout-seconds 600
"Kill connection after this many seconds if there is no activity.")
\f
(defvar-local rcirc-startup-channels nil
"List of channel names to join after authenticating.")
(defvar rcirc-server-name-history nil
"History variable for \\[rcirc] call.")
(defvar rcirc-server-port-history nil
"History variable for \\[rcirc] call.")
(defvar rcirc-nick-name-history nil
"History variable for \\[rcirc] call.")
(defvar rcirc-user-name-history nil
"History variable for \\[rcirc] call.")
;;;###autoload
(defun rcirc (arg)
"Connect to all servers in `rcirc-server-alist'.
Do not connect to a server if it is already connected.
If ARG is non-nil, instead prompt for connection parameters."
(interactive "P")
(if arg
(let* ((server (completing-read "IRC Server: "
rcirc-server-alist
nil nil
(caar rcirc-server-alist)
'rcirc-server-name-history))
(server-plist (cdr (assoc-string server rcirc-server-alist)))
(port (read-string "IRC Port: "
(number-to-string
(or (plist-get server-plist :port)
rcirc-default-port))
'rcirc-server-port-history))
(nick (read-string "IRC Nick: "
(or (plist-get server-plist :nick)
rcirc-default-nick)
'rcirc-nick-name-history))
(user-name (read-string "IRC Username: "
(or (plist-get server-plist :user-name)
rcirc-default-user-name)
'rcirc-user-name-history))
(password (read-passwd "IRC Password: " nil
(plist-get server-plist :password)))
(channels (split-string
(read-string "IRC Channels: "
(mapconcat 'identity
(plist-get server-plist
:channels)
" "))
"[, ]+" t))
(encryption (rcirc-prompt-for-encryption server-plist))
(process (rcirc-connect server port nick user-name
rcirc-default-full-name
channels password encryption)))
(when rcirc-display-server-buffer
(pop-to-buffer-same-window (process-buffer process))))
;; connect to servers in `rcirc-server-alist'
(let (connected-servers)
(dolist (c rcirc-server-alist)
(let ((server (car c))
(nick (or (plist-get (cdr c) :nick) rcirc-default-nick))
(port (or (plist-get (cdr c) :port) rcirc-default-port))
(user-name (or (plist-get (cdr c) :user-name)
rcirc-default-user-name))
(full-name (or (plist-get (cdr c) :full-name)
rcirc-default-full-name))
(channels (plist-get (cdr c) :channels))
(password (plist-get (cdr c) :password))
(encryption (plist-get (cdr c) :encryption))
(server-alias (plist-get (cdr c) :server-alias))
(client-cert (when (eq (rcirc-get-server-method (car c))
'certfp)
(rcirc-get-server-cert (car c))))
contact)
(when-let* (((not password))
(auth (auth-source-search :host server
:user user-name
:port port))
(pwd (auth-info-password (car auth))))
(setq password pwd))
(when server
(let (connected)
(dolist (p (rcirc-process-list))
(when (string= (or server-alias server) (process-name p))
(setq connected p)))
(if (not connected)
(condition-case nil
(let ((process (rcirc-connect server port nick user-name
full-name channels password encryption
server-alias client-cert)))
(when rcirc-display-server-buffer
(pop-to-buffer-same-window (process-buffer process))))
(quit (message "Quit connecting to %s"
(or server-alias server))))
(with-current-buffer (process-buffer connected)
(setq contact (process-contact
(get-buffer-process (current-buffer)) :name))
(setq connected-servers
(cons (if (stringp contact)
contact (or server-alias server))
connected-servers))))))))
(when connected-servers
(message "Already connected to %s"
(if (cdr connected-servers)
(concat (mapconcat 'identity (butlast connected-servers) ", ")
", and "
(car (last connected-servers)))
(car connected-servers)))))))
;;;###autoload
(defalias 'irc 'rcirc)
\f
(defvar-local rcirc-process-output nil
"Partial message response.")
(defvar-local rcirc-topic nil
"Topic of the current channel.")
(defvar rcirc-keepalive-timer nil
"Timer for sending KEEPALIVE message.")
(defvar-local rcirc-last-server-message-time nil
"Timestamp for the last server response.")
(defvar-local rcirc-server nil
"Server provided by server.")
(defvar-local rcirc-server-name nil
"Server name given by 001 response.")
(defvar-local rcirc-timeout-timer nil
"Timer for determining a network timeout.")
(defvar-local rcirc-user-authenticated nil
"Flag indicating if the user is authenticated.")
(defvar-local rcirc-user-disconnect nil
"Flag indicating if the connection was broken.")
(defvar-local rcirc-connecting nil
"Flag indicating if the connection is being established.")
(defvar-local rcirc-connection-info nil
"Information about the current connection.
If defined, it is a list of this form (SERVER PORT NICK USER-NAME
FULL-NAME STARTUP-CHANNELS PASSWORD ENCRYPTION SERVER-ALIAS).
See `rcirc-connect' for more details on these variables.")
(defvar-local rcirc-process nil
"Network process for the current connection.")
(defvar-local rcirc-last-connect-time nil
"The last time the buffer was connected.")
;;; IRCv3 capability negotiation (https://ircv3.net/specs/extensions/capability-negotiation)
(defvar rcirc-implemented-capabilities
'("message-tags" ;https://ircv3.net/specs/extensions/message-tags
"server-time" ;https://ircv3.net/specs/extensions/server-time
"batch" ;https://ircv3.net/specs/extensions/batch
"message-ids" ;https://ircv3.net/specs/extensions/message-ids
"invite-notify" ;https://ircv3.net/specs/extensions/invite-notify
"sasl" ;https://ircv3.net/specs/extensions/sasl-3.1
"multi-prefix" ;https://ircv3.net/specs/extensions/multi-prefix
"standard-replies" ;https://ircv3.net/specs/extensions/standard-replies
;; The following capabilities should be implemented as soon as
;; their specifications are undrafted:
;;
;; "reply" ;https://ircv3.net/specs/client-tags/reply
;; "react" ;https://ircv3.net/specs/client-tags/react
;; "multiline" ;https://ircv3.net/specs/extensions/multiline
;; "chathistory" ;https://ircv3.net/specs/extensions/chathistory
;; "channel-rename" ;https://ircv3.net/specs/extensions/channel-rename
)
"A list of capabilities that rcirc supports.")
(defvar-local rcirc-requested-capabilities nil
"A list of capabilities that client has requested.")
(defvar-local rcirc-acked-capabilities nil
"A list of capabilities that the server supports.")
(defvar-local rcirc-finished-sasl t
"Check whether SASL authentication has completed.")
(defun rcirc-get-server-method (server)
"Return authentication method for SERVER."
(cadr (assoc server rcirc-authinfo #'string-match)))
(defun rcirc-get-server-password (server)
"Return password for SERVER."
(cadddr (assoc server rcirc-authinfo #'string-match)))
(defun rcirc-get-server-cert (server)
"Return a list of key and certificate for SERVER."
(cddr (assoc server rcirc-authinfo #'string-match)))
;;;###autoload
(defun rcirc-connect (server &optional port nick user-name
full-name startup-channels password encryption
server-alias certfp)
"Connect to SERVER.
The arguments PORT, NICK, USER-NAME, FULL-NAME, PASSWORD,
ENCRYPTION, CERTFP, SERVER-ALIAS are interpreted as in
`rcirc-server-alist'. STARTUP-CHANNELS is a list of channels
that are joined after authentication."
(save-excursion
(message "Connecting to %s..." (or server-alias server))
(let* ((inhibit-eol-conversion)
(port-number (if port
(if (stringp port)
(string-to-number port)
port)
rcirc-default-port))
(nick (or nick rcirc-default-nick))
(user-name (or user-name rcirc-default-user-name))
(full-name (or full-name rcirc-default-full-name))
(startup-channels startup-channels)
process)
;; Ensure any previous process is killed
(when-let* ((old-process (get-process (or server-alias server))))
(set-process-sentinel old-process #'ignore)
(delete-process process))
;; Set up process
(setq process (open-network-stream
(or server-alias server) nil server port-number
:type (or encryption 'plain)
:client-certificate certfp
:nowait t))
(set-process-coding-system process 'raw-text 'raw-text)
(with-current-buffer (get-buffer-create (rcirc-generate-new-buffer-name process nil))
(set-process-buffer process (current-buffer))
(unless (eq major-mode 'rcirc-mode)
(rcirc-mode process nil))
(set-process-sentinel process #'rcirc-sentinel)
(set-process-filter process #'rcirc-filter)
(setq rcirc-connection-info
(list server port nick user-name full-name startup-channels
password encryption server-alias))
(setq rcirc-process process)
(setq rcirc-server server)
(setq rcirc-server-name (or server-alias server)) ; Update when we get 001 response.
(setq rcirc-nick-table (make-hash-table :test 'equal))
(setq rcirc-nick nick)
(setq rcirc-startup-channels startup-channels)
(setq rcirc-last-connect-time (current-time))
(setq rcirc-last-server-message-time rcirc-last-connect-time)
;; Check if the immediate process state
(sit-for .1)
(cond
((eq (process-status process) 'failed)
(setq mode-line-process ":disconnected")
(setq rcirc-connecting nil))
((eq (process-status process) 'connect)
(setq mode-line-process ":connecting")
(setq rcirc-connecting t)))
(add-hook 'auto-save-hook #'rcirc-log-write)
;; return process object
process))))
(defmacro with-rcirc-process-buffer (process &rest body)
"Evaluate BODY in the buffer of PROCESS."
(declare (indent 1) (debug t))
`(with-current-buffer (process-buffer ,process)
,@body))
(defmacro with-rcirc-server-buffer (&rest body)
"Evaluate BODY in the server buffer of the current channel."
(declare (indent 0) (debug t))
`(if (buffer-live-p rcirc-server-buffer)
(with-current-buffer rcirc-server-buffer
,@body)
(user-error "Server buffer was killed")))
(define-obsolete-function-alias 'rcirc-float-time 'float-time "26.1")
(defun rcirc-prompt-for-encryption (server-plist)
"Prompt the user for the encryption method to use.
SERVER-PLIST is the property list for the server."
(if (or (eq (plist-get server-plist :encryption) 'plain)
(yes-or-no-p "Encrypt connection?"))
'tls 'plain))
(defvar rcirc-reconnect-delay)
(defun rcirc-keepalive ()
"Send keep alive pings to active rcirc processes.
Kill processes that have not received a server message since the
last ping."
(if (rcirc-process-list)
(mapc (lambda (process)
(with-rcirc-process-buffer process
(when (not rcirc-connecting)
(condition-case nil
(rcirc-send-ctcp process
rcirc-nick
(format "KEEPALIVE %f"
(float-time)))
(rcirc-closed-connection
(if (zerop rcirc-reconnect-delay)
(message "rcirc: Connection to %s closed"
(process-name process))
(rcirc-reconnect process))
(message ""))))))
(rcirc-process-list))
;; no processes, clean up timer
(when (timerp rcirc-keepalive-timer)
(cancel-timer rcirc-keepalive-timer))
(setq rcirc-keepalive-timer nil)))
(defun rcirc-handler-ctcp-KEEPALIVE (process _target _sender message)
"Uptime header in PROCESS buffer.
MESSAGE should contain a timestamp, indicating when the KEEPALIVE
message was generated."
(with-rcirc-process-buffer process
(setq header-line-format
(format "%f" (float-time
(time-since (string-to-number message)))))))
(defvar rcirc-debug-buffer "*rcirc debug*"
"Buffer name for debugging messages.")
(defvar rcirc-debug-flag nil
"Non-nil means write information to `rcirc-debug-buffer'.")
(defun rcirc-debug (process text)
"Add an entry to the debug log including PROCESS and TEXT.
Debug text is appended to `rcirc-debug-buffer' if `rcirc-debug-flag'
is non-nil.
For convenience, the read-only state of the debug buffer is ignored.
When the point is at the end of the visible portion of the buffer, it
is moved to after the text inserted. Otherwise the point is not moved."
(when rcirc-debug-flag
(with-current-buffer (get-buffer-create rcirc-debug-buffer)
(let ((old (point-marker)))
(set-marker-insertion-type old t)
(goto-char (point-max))
(let ((inhibit-read-only t))
(terpri (current-buffer) t)
(insert "["
(format-time-string "%FT%T ") (process-name process)
"] "
text))
(goto-char old)))))
(defvar rcirc-sentinel-functions nil
"Hook functions called when the process sentinel is called.
Functions are called with PROCESS and SENTINEL arguments.")
(defcustom rcirc-reconnect-delay 0
"The minimum interval in seconds between reconnect attempts.
When 0, do not auto-reconnect."
:version "25.1"
:type 'integer)
(defcustom rcirc-reconnect-attempts 3
"Number of times a reconnection should be attempted."
:version "28.1"
:type 'integer)
(defvar-local rcirc-failed-attempts 0
"Number of times reconnecting has failed.")
(defvar-local rcirc-reconnection-timer nil
"Timer used for reconnecting.")
(defun rcirc-reconnect (process &optional quiet)
"Attempt to reconnect connection to PROCESS.
If QUIET is non-nil, no not emit a message."
(with-rcirc-process-buffer process
(catch 'exit
(if (rcirc--connection-open-p process)
(throw 'exit (or quiet (message "Server process is alive")))
(delete-process process))
(setq rcirc-user-authenticated nil)
(let ((conn-info rcirc-connection-info))
(setf (nth 5 conn-info)
(cl-remove-if-not #'rcirc-channel-p
(mapcar #'car rcirc-buffer-alist)))
(dolist (buffer (mapcar #'cdr rcirc-buffer-alist))
(when (buffer-live-p buffer)
(with-current-buffer buffer
(setq mode-line-process ":connecting"))))
(let ((nprocess (apply #'rcirc-connect conn-info)))
(when (and (< rcirc-failed-attempts rcirc-reconnect-attempts)
(eq (process-status nprocess) 'failed))
(setq rcirc-failed-attempts (1+ rcirc-failed-attempts))
(rcirc-print nprocess "*rcirc*" "ERROR" nil
(format "Failed to reconnect (%d/%d)..."
rcirc-failed-attempts
rcirc-reconnect-attempts))
(setq rcirc-reconnection-timer
(run-at-time rcirc-reconnect-delay nil
#'rcirc-reconnect process t))))))))
(defun rcirc-sentinel (process sentinel)
"Called on a change of the state of PROCESS.
SENTINEL describes the change in form of a string."
(let ((status (process-status process)))
(rcirc-debug process (format "SENTINEL: %S %S\n" process sentinel))
(with-rcirc-process-buffer process
(cond
((eq status 'open)
(let* ((server (nth 0 rcirc-connection-info))
(user-name (nth 3 rcirc-connection-info))
(full-name (nth 4 rcirc-connection-info))
(password (nth 6 rcirc-connection-info))
(server-alias (nth 8 rcirc-connection-info))
(use-sasl (eq (rcirc-get-server-method server) 'sasl)))
;; Prepare SASL authentication
(when use-sasl
(rcirc-send-string process "CAP REQ sasl")
(setq-local rcirc-finished-sasl nil))
;; Capability negotiation
(dolist (cap rcirc-implemented-capabilities)
(rcirc-send-string process "CAP" "REQ" : cap)
(push cap rcirc-requested-capabilities))
;; Identify user
(unless (zerop (length password))
(rcirc-send-string process "PASS" password))
(rcirc-send-string process "NICK" rcirc-nick)
(rcirc-send-string process "USER" user-name "0" "*" : full-name)
;; Setup sasl, and initiate authentication.
(when (and rcirc-auto-authenticate-flag
use-sasl)
(rcirc-send-string process "AUTHENTICATE" "PLAIN"))
;; Setup ping timer if necessary
(unless rcirc-keepalive-timer
(setq rcirc-keepalive-timer
(run-at-time 0 (/ rcirc-timeout-seconds 2) #'rcirc-keepalive)))
;; Reset previous reconnection attempts
(setq rcirc-failed-attempts 0)
(when rcirc-reconnection-timer
(cancel-timer rcirc-reconnection-timer)
(setq rcirc-reconnection-timer nil))
(message "Connecting to %s...done" (or server-alias server))
(dolist (buffer (cons nil (mapcar 'cdr rcirc-buffer-alist)))
(with-current-buffer (or buffer (current-buffer))
(setq mode-line-process nil)))))
((eq status 'closed)
(let ((now (current-time)))
(with-rcirc-process-buffer process
(when (and (< 0 rcirc-reconnect-delay)
(time-less-p rcirc-reconnect-delay
(time-subtract now rcirc-last-connect-time)))
(setq rcirc-last-connect-time now)
(rcirc-reconnect process)))))
((eq status 'failed)
(dolist (buffer (cons nil (mapcar 'cdr rcirc-buffer-alist)))
(with-current-buffer (or buffer (current-buffer))
(rcirc-print process "*rcirc*" "ERROR" rcirc-target
(format "%s: %s (%S)"
(process-name process)
sentinel
(process-status process))
(not rcirc-target))
(rcirc-disconnect-buffer)))))
(run-hook-with-args 'rcirc-sentinel-functions process sentinel))))
(defun rcirc-disconnect-buffer (&optional buffer)
"Disconnect BUFFER.
If BUFFER is nil, default to the current buffer."
(with-current-buffer (or buffer (current-buffer))
;; set rcirc-target to nil for each channel so cleanup
;; doesn't happen when we reconnect
(setq rcirc-target nil)
(setq mode-line-process ":disconnected")))
(defun rcirc-process-list ()
"Return a list of rcirc processes."
(let (ps)
(mapc (lambda (p)
(when (buffer-live-p (process-buffer p))
(with-rcirc-process-buffer p
(when (eq major-mode 'rcirc-mode)
(setq ps (cons p ps))))))
(process-list))
ps))
(defvar rcirc-receive-message-functions nil
"Hook functions run when a message is received from server.
Function is called with PROCESS, COMMAND, SENDER, ARGS and LINE.")
(defun rcirc-filter (process output)
"Called when PROCESS receives OUTPUT."
(rcirc-debug process output)
(rcirc-reschedule-timeout process)
(with-rcirc-process-buffer process
(setq rcirc-last-server-message-time (current-time))
(setq rcirc-process-output (concat rcirc-process-output output))
(when (= ?\n (aref rcirc-process-output
(1- (length rcirc-process-output))))
(let ((lines (split-string rcirc-process-output "[\n\r]" t)))
(setq rcirc-process-output nil)
(dolist (line lines)
(rcirc-process-server-response process line))))))
(defun rcirc-reschedule-timeout (process)
"Update timeout indicator for PROCESS."
(with-rcirc-process-buffer process
(when (not rcirc-connecting)
(with-rcirc-process-buffer process
(when rcirc-timeout-timer (cancel-timer rcirc-timeout-timer))
(setq rcirc-timeout-timer (run-at-time rcirc-timeout-seconds nil
'delete-process
process))))))
(defvar rcirc-trap-errors-flag t
"Non-nil means Lisp errors are degraded to error messages.")
(defun rcirc-process-server-response (process text)
"Parse TEXT as received from PROCESS."
(if rcirc-trap-errors-flag
(condition-case err
(rcirc-process-server-response-1 process text)
(error
(rcirc-print process "*rcirc*" "ERROR" nil
(format "\"%s\" %s" text err) t)))
(rcirc-process-server-response-1 process text)))
(defconst rcirc-process-regexp
(rx-let ((message-tag ; message tags as specified in
; https://ircv3.net/specs/extensions/message-tags
(: (? "+")
(? (+ (or alnum "-")) (+ "." (+ (or alnum "-"))) "/")
(+ (any alnum "-"))
(? "="
(* (not (any 0 ?\n ?\r ?\; ?\s)))))))
(rx line-start
(optional "@" (group message-tag (* ";" message-tag)) (+ space))
;; See https://tools.ietf.org/html/rfc2812#section-2.3.1.
;; We're a bit more accepting than the RFC: We allow any non-space
;; characters in the command name, multiple spaces between
;; arguments, and allow the last argument to omit the leading ":",
;; even if there are less than 15 arguments.
(optional
(group ":" (group (one-or-more (not (any " ")))) " "))
(group (one-or-more (not (any " "))))))
"Regular expression used for parsing server response.")
(defconst rcirc-tag-regexp
(rx bos
(group
(? "+")
(? (+ (or alnum "-")) (+ "." (+ (or alnum "-"))) "/")
(+ (any alnum "-")))
(? "=" (group (* (not (any 0 ?\n ?\r ?\; ?\s)))))
eos)
"Regular expression used for destructing a tag.")
(defvar rcirc-message-tags nil
"Alist of parsed message tags.")
(defvar rcirc-supported-batch-types
'()
"List of recognized batch types.
Each element has the form (TYPE HANDLE), where TYPE is a string
and HANDLE is either the symbol `immediate' or `deferred'.
Messages in an immediate batch are handled just like regular
messages, while deferred messages are stored in
`rcirc-batched-messages'.")
(defvar-local rcirc-batch-attributes nil
"Alist mapping batch IDs to parameters.")
(defvar-local rcirc-batched-messages nil
"Alist mapping batch IDs to deferred messages.
Note that the messages are stored in reverse order.")
(defsubst rcirc-get-tag (key &optional default)
"Return tag value for KEY or DEFAULT."
(alist-get key rcirc-message-tags default nil #'string=))
(defun rcirc-process-server-response-1 (process text)
"Parse TEXT as received from PROCESS."
(if (string-match rcirc-process-regexp text)
(let* ((rcirc-message-tags
(append
(and-let* ((tag-data (match-string 1 text)))
(save-match-data
(mapcar
(lambda (tag)
(unless (string-match rcirc-tag-regexp tag)
;; This should not happen, unless there is
;; a mismatch between this regular
;; expression and `rcirc-process-regexp'.
(error "Malformed tag %S" tag))
(cons (match-string 1 tag)
(when (match-string 2 tag)
(replace-regexp-in-string
(rx (* ?\\ ?\\) ?\\ (any ?: ?s ?\\ ?r ?n))
(lambda (rep)
(concat (substring rep 0 -2)
(cl-case (aref rep (1- (length rep)))
(?: ";")
(?s " ")
(?\\ "\\\\")
(?r "\r")
(?n "\n"))))
(match-string 2 tag)))))
(split-string tag-data ";"))))
rcirc-message-tags))
(user (match-string 3 text))
(sender (rcirc-user-nick user))
(cmd (match-string 4 text))
(cmd-end (match-end 4))
(args nil)
(handler (intern-soft (concat "rcirc-handler-" cmd))))
(cl-loop with i = cmd-end
repeat 14
while (eql i (string-match " +\\([^: ][^ ]*\\)" text i))
do (progn (push (match-string 1 text) args)
(setq i (match-end 0)))
finally
(progn (if (eql i (string-match " +:?" text i))
(push (substring text (match-end 0)) args)
(cl-assert (= i (length text))))
(cl-callf nreverse args)))
(cond ((and-let* ((batch-id (rcirc-get-tag "batch"))
(type (cadr (assoc batch-id rcirc-batch-attributes)))
(attr (assoc type rcirc-supported-batch-types))
((eq (cadr attr) 'deferred)))
;; handle deferred batch messages later
(push (list cmd process sender args text rcirc-message-tags)
(alist-get batch-id rcirc-batched-messages
nil nil #'string=))
t))
((not (fboundp handler))
(rcirc-handler-generic process cmd sender args text))
((funcall handler process sender args text)))
(run-hook-with-args 'rcirc-receive-message-functions
process cmd sender args text))
(message "UNHANDLED: %s" text)))
(defvar rcirc-responses-no-activity '("305" "306")
"Responses that don't trigger activity in the mode-line indicator.")
(defun rcirc-handler-generic (process response sender args _text)
"Generic server response handler.
This handler is called, when no more specific handler could be
found. PROCESS, SENDER and RESPONSE are passed on to
`rcirc-print'. ARGS are concatenated into a single string and
used as the message body."
(rcirc-print process sender response nil
(mapconcat 'identity (cdr args) " ")
(not (member response rcirc-responses-no-activity))))
(defun rcirc--connection-open-p (process)
"Check if PROCESS is open or running."
(memq (process-status process) '(run open)))
(define-error 'rcirc-closed-connection "Network connection not open")
(defun rcirc-send-string (process &rest parts)
"Send PROCESS a PARTS plus a newline.
PARTS may contain a `:' symbol, to designate that the next string
is the message, that should be prefixed by a colon. If the last
element in PARTS is a list, append it to PARTS."
(let ((last (car (last parts))))
(when (listp last)
(setf parts (append (butlast parts) last))))
(when-let* ((message (memq : parts)))
(cl-check-type (cadr message) string)
(setf (cadr message) (concat ":" (cadr message))
parts (remq : parts)))
(let ((string (concat (encode-coding-string
(mapconcat #'identity parts " ")
rcirc-encode-coding-system)
"\n")))
(unless (rcirc--connection-open-p process)
(signal 'rcirc-closed-connection process))
(rcirc-debug process string)
(process-send-string process string)))
(defun rcirc-send-privmsg (process target string)
"Send TARGET the message in STRING via PROCESS."
(cl-check-type target string)
(rcirc-send-string process "PRIVMSG" target : string))
(defun rcirc-ctcp-wrap (&rest args)
"Join ARGS into a string wrapped by ASCII 1 charterers."
(concat "\C-a" (string-join (delq nil args) " ") "\C-a"))
(defun rcirc-send-ctcp (process target request &optional args)
"Send TARGET a REQUEST via PROCESS."
(rcirc-send-privmsg process target (rcirc-ctcp-wrap request args)))
(defun rcirc-buffer-process (&optional buffer)
"Return the process associated with channel BUFFER.
With no argument or nil as argument, use the current buffer."
(let ((buffer (or buffer (and (buffer-live-p rcirc-server-buffer)
rcirc-server-buffer))))
(if buffer
(buffer-local-value 'rcirc-process buffer)
rcirc-process)))
(defun rcirc-server-name (process)
"Return PROCESS server name, given by the 001 response."
(with-rcirc-process-buffer process
(or rcirc-server-name
(warn "Server name for process %S unknown" process))))
(defun rcirc-nick (process)
"Return PROCESS nick."
(with-rcirc-process-buffer process
(or rcirc-nick rcirc-default-nick)))
(defun rcirc-buffer-nick (&optional buffer)
"Return the nick associated with BUFFER.
With no argument or nil as argument, use the current buffer."
(with-current-buffer (or buffer (current-buffer))
(with-rcirc-server-buffer
(or rcirc-nick rcirc-default-nick))))
(defvar rcirc-max-message-length 420
"Messages longer than this value will be split.")
(defun rcirc-split-message (message)
"Split MESSAGE into chunks within `rcirc-max-message-length'."
;; `rcirc-encode-coding-system' can have buffer-local value.
(let ((encoding rcirc-encode-coding-system))
(with-temp-buffer
(insert message)
(goto-char (point-min))
(let (result)
(while (not (eobp))
(goto-char (or (byte-to-position rcirc-max-message-length)
(point-max)))
;; max message length is 512 including CRLF
(while (and (not (bobp))
(> (length (encode-coding-region
(point-min) (point) encoding t))
rcirc-max-message-length))
(forward-char -1))
(push (delete-and-extract-region (point-min) (point)) result))
(nreverse result)))))
(defun rcirc-send-message (process target message &optional noticep silent)
"Send TARGET associated with PROCESS a privmsg with text MESSAGE.
If NOTICEP is non-nil, send a notice instead of privmsg.
If SILENT is non-nil, do not print the message in any irc buffer."
(let ((response (if noticep "NOTICE" "PRIVMSG")))
(rcirc-get-buffer-create process target)
(dolist (msg (rcirc-split-message message))
(unless silent
(rcirc-print process (rcirc-nick process) response target msg))
(rcirc-send-string process response target : msg))))
(defvar-local rcirc-input-ring nil
"Ring object for input.")
(defvar-local rcirc-input-ring-index 0
"Current position in the input ring.")
(defun rcirc-prev-input-string (arg)
"Move ARG elements ahead in the input ring."
(ring-ref rcirc-input-ring (+ rcirc-input-ring-index arg)))
(defun rcirc-insert-prev-input ()
"Insert previous element in input ring."
(interactive)
(when (<= rcirc-prompt-end-marker (point))
(delete-region rcirc-prompt-end-marker (point-max))
(insert (rcirc-prev-input-string 0))
(setq rcirc-input-ring-index (1+ rcirc-input-ring-index))))
(defun rcirc-insert-next-input ()
"Insert next element in input ring."
(interactive)
(when (<= rcirc-prompt-end-marker (point))
(delete-region rcirc-prompt-end-marker (point-max))
(setq rcirc-input-ring-index (1- rcirc-input-ring-index))
(insert (rcirc-prev-input-string -1))))
(defvar rcirc-server-commands
'("/admin" "/away" "/connect" "/die" "/error" "/info"
"/invite" "/ison" "/join" "/kick" "/kill" "/links"
"/list" "/lusers" "/mode" "/motd" "/names" "/nick"
"/notice" "/oper" "/part" "/pass" "/ping" "/pong"
"/privmsg" "/quit" "/rehash" "/restart" "/service" "/servlist"
"/server" "/squery" "/squit" "/stats" "/summon" "/time"
"/topic" "/trace" "/user" "/userhost" "/users" "/version"
"/wallops" "/who" "/whois" "/whowas")
"A list of user commands by IRC server.
The value defaults to RFCs 1459 and 2812.")
;; /me and /ctcp are not defined by `defun-rcirc-command'.
(defvar rcirc-client-commands '("/me" "/ctcp")
"A list of user commands defined by IRC client rcirc.
The list is updated automatically by `defun-rcirc-command'.")
(defun rcirc-completion-at-point ()
"Function used for `completion-at-point-functions' in `rcirc-mode'."
(and (rcirc-looking-at-input)
(let* ((beg (save-excursion
;; On some networks it is common to message or
;; mention someone using @nick instead of just
;; nick.
(if (re-search-backward "[[:space:]@]" rcirc-prompt-end-marker t)
(1+ (point))
rcirc-prompt-end-marker)))
(table (cond
;; No completion before the prompt
((< beg rcirc-prompt-end-marker) nil)
;; Only complete nicks mid-message
((> beg rcirc-prompt-end-marker)
(mapcar rcirc-nick-filter
(rcirc-channel-nicks
(rcirc-buffer-process)
rcirc-target)))
;; Complete commands at the beginning of the
;; message, when the first character is a dash
((eq (char-after beg) ?/)
(mapcar
(lambda (cmd) (concat cmd " "))
(nconc (sort (copy-sequence rcirc-client-commands)
'string-lessp)
(sort (copy-sequence rcirc-server-commands)
'string-lessp))))
;; Complete usernames right after the prompt by
;; appending a colon after the name
((mapcar
(lambda (str) (concat (funcall rcirc-nick-filter str) ": "))
(rcirc-channel-nicks (rcirc-buffer-process)
rcirc-target))))))
(list beg (point)
(lambda (str pred action)
(if (eq action 'metadata)
'(metadata (cycle-sort-function . identity))
(complete-with-action action table str pred)))))))
(defun rcirc-set-decode-coding-system (coding-system)
"Set the decode CODING-SYSTEM used in this channel."
(interactive "zCoding system for incoming messages: ")
(setq-local rcirc-decode-coding-system coding-system))
(define-obsolete-function-alias
'rcirc-set-decode-coding-system
'set-rcirc-decode-coding-system
"28.1")
(defun rcirc-set-encode-coding-system (coding-system)
"Set the encode CODING-SYSTEM used in this channel."
(interactive "zCoding system for outgoing messages: ")
(setq-local rcirc-encode-coding-system coding-system))
(define-obsolete-function-alias
'rcirc-set-encode-coding-system
'set-rcirc-encode-coding-system
"28.1")
(defun rcirc-format (pre &optional replace)
"Insert markup formatting PRE.
PRE and \"^O\" (ASCII #x0f) will either be inserted around the
current point respectively or the active region, if present.
This function an auxiliary function is not meant to be used
directly, but is invoked by other commands. If the optional
argument REPLACE is non-nil, first remove any formatting before
inserting the new one."
(when replace (rcirc-unformat))
(save-excursion
(if (use-region-p)
(let ((beg (region-beginning)))
(goto-char (region-end))
(insert "\^O")
(goto-char beg)
(insert pre))
(insert pre "\^O")))
(when (or (not (region-active-p)) (< (point) (mark)))
(forward-char (length pre))))
(defun rcirc-unformat ()
"Remove the closes formatting found closes to the current point."
(interactive)
(save-excursion
(when (and (search-backward-regexp (rx (or "\^B" "\^]" "\^_" "\^^" "\^Q"))
rcirc-prompt-end-marker t)
(looking-at (rx (group (or "\^B" "\^]" "\^_" "\^^" "\^Q"))
(*? nonl)
(group "\^O"))))
(replace-match "" nil nil nil 2)
(replace-match "" nil nil nil 1))))
(defun rcirc-format-bold (replace)
"Insert bold formatting.
If REPLACE is non-nil or a prefix argument is given, any prior
formatting will be replaced before the bold formatting is
inserted."
(interactive "P")
(rcirc-format "\^B" replace))
(defun rcirc-format-italic (replace)
"Insert italic formatting.
If REPLACE is non-nil or a prefix argument is given, any prior
formatting will be replaced before the italic formatting is
inserted."
(interactive "P")
(rcirc-format "\^]" replace))
(defun rcirc-format-underline (replace)
"Insert underlining formatting.
If REPLACE is non-nil or a prefix argument is given, any prior
formatting will be replaced before the underline formatting is
inserted."
(interactive "P")
(rcirc-format "\^_" replace))
(defun rcirc-format-strike-through (replace)
"Insert strike-through formatting.
If REPLACE is non-nil or a prefix argument is given, any prior
formatting will be replaced before the strike-through formatting
is inserted."
(interactive "P")
(rcirc-format "\^^" replace))
(defun rcirc-format-fixed-width (replace)
"Insert fixed-width formatting.
If REPLACE is non-nil or a prefix argument is given, any prior
formatting will be replaced before the fixed width formatting is
inserted."
(interactive "P")
(rcirc-format "\^Q" replace))
(defvar-keymap rcirc-mode-map
:doc "Keymap for rcirc mode."
"RET" #'rcirc-send-input
"M-p" #'rcirc-insert-prev-input
"M-n" #'rcirc-insert-next-input
"TAB" #'completion-at-point
"C-c C-f C-b" #'rcirc-format-bold
"C-c C-f C-i" #'rcirc-format-italic
"C-c C-f C-u" #'rcirc-format-underline
"C-c C-f C-s" #'rcirc-format-strike-through
"C-c C-f C-f" #'rcirc-format-fixed-width
"C-c C-f C-t" #'rcirc-format-fixed-width ;as in AucTeX
"C-c C-f C-d" #'rcirc-unformat
"C-c C-b" #'rcirc-browse-url
"C-c C-c" #'rcirc-edit-multiline
"C-c C-j" #'rcirc-cmd-join
"C-c C-k" #'rcirc-cmd-kick
"C-c C-l" #'rcirc-toggle-low-priority
"C-c C-d" #'rcirc-cmd-mode
"C-c C-m" #'rcirc-cmd-msg
"C-c C-r" #'rcirc-cmd-nick ; rename
"C-c C-o" #'rcirc-omit-mode
"C-c C-p" #'rcirc-cmd-part
"C-c C-q" #'rcirc-cmd-query
"C-c C-t" #'rcirc-cmd-topic
"C-c C-n" #'rcirc-cmd-names
"C-c C-w" #'rcirc-cmd-whois
"C-c C-x" #'rcirc-cmd-quit
"C-c C-i" #'rcirc-toggle-ignore-buffer-activity
"C-c C-s" #'rcirc-switch-to-server-buffer
"C-c C-a" #'rcirc-jump-to-first-unread-line)
(defvar-local rcirc-short-buffer-name nil
"Generated abbreviation to use to indicate buffer activity.")
(defvar rcirc-mode-hook nil
"Hook run when setting up rcirc buffer.")
(defvar-local rcirc-last-post-time nil
"Timestamp indicating last user action.")
(defvar rcirc-log-alist nil
"Alist of lines to log to disk when `rcirc-log-flag' is non-nil.
Each element looks like (FILENAME . TEXT).")
(defvar-local rcirc-current-line 0
"The current number of responses printed in this channel.
This number is independent of the number of lines in the buffer.")
(defun rcirc--electric-pair-inhibit (char)
"Check whether CHAR should be paired by `electric-pair-mode'.
This uses the default value inhibition predicate (as set by
`electric-pair-inhibit-predicate'), but ignores all text prior to
the prompt so that mismatches parentheses by some other message
does not confuse the pairing."
(let ((fallback (default-value 'electric-pair-inhibit-predicate)))
;; The assumption is that this function is only bound by
;; `rcirc-mode', and should never be the global default.
(cl-assert (not (eq fallback #'rcirc--electric-pair-inhibit)))
(save-restriction
(widen)
(narrow-to-region rcirc-prompt-start-marker (point-max))
(funcall fallback char))))
(defun rcirc-mode (process target)
"Initialize an IRC buffer for writing with TARGET.
PROCESS is the process object used for communication.
\\{rcirc-mode-map}"
;; FIXME: Use define-derived-mode.
(kill-all-local-variables)
(use-local-map rcirc-mode-map)
(setq mode-name "rcirc")
(setq major-mode 'rcirc-mode)
(setq mode-line-process nil)
(setq rcirc-input-ring
;; If rcirc-input-ring is already a ring with desired
;; size do not re-initialize.
(if (and (ring-p rcirc-input-ring)
(= (ring-size rcirc-input-ring)
rcirc-input-ring-size))
rcirc-input-ring
(make-ring rcirc-input-ring-size)))
(setq rcirc-server-buffer (process-buffer process))
(setq rcirc-target target)
(setq rcirc-last-post-time (current-time))
(setq-local fill-paragraph-function 'rcirc-fill-paragraph)
(setq rcirc-current-line 0)
(use-hard-newlines t)
;; setup for omitting responses
(setq buffer-invisibility-spec '())
(setq buffer-display-table (make-display-table))
(set-display-table-slot buffer-display-table 4
(let ((glyph (make-glyph-code
?. 'font-lock-keyword-face)))
(make-vector 3 glyph)))
(dolist (i rcirc-coding-system-alist)
(let ((chan (if (consp (car i)) (caar i) (car i)))
(serv (if (consp (car i)) (cdar i) "")))
(when (and (string-match chan (or target ""))
(string-match serv (rcirc-server-name process)))
(setq-local rcirc-decode-coding-system
(if (consp (cdr i)) (cadr i) (cdr i)))
(setq-local rcirc-encode-coding-system
(if (consp (cdr i)) (cddr i) (cdr i))))))
;; setup the prompt and markers
(setq rcirc-prompt-start-marker (point-max-marker))
(setq rcirc-prompt-end-marker (point-max-marker))
(rcirc-update-prompt)
(goto-char rcirc-prompt-end-marker)
(setq-local overlay-arrow-position (make-marker))
;; if the user changes the major mode or kills the buffer, there is
;; cleanup work to do
(add-hook 'change-major-mode-hook 'rcirc-change-major-mode-hook nil t)
(add-hook 'kill-buffer-hook 'rcirc-kill-buffer-hook nil t)
;; add to buffer list, and update buffer abbrevs
(when target ; skip server buffer
(let ((buffer (current-buffer)))
(with-rcirc-process-buffer process
(push (cons target buffer) rcirc-buffer-alist)))
(rcirc-update-short-buffer-names))
(add-hook 'completion-at-point-functions
'rcirc-completion-at-point nil 'local)
(when rcirc-cycle-completion-flag
(setq-local completion-cycle-threshold t))
(setq-local electric-pair-inhibit-predicate
#'rcirc--electric-pair-inhibit)
(run-mode-hooks 'rcirc-mode-hook))
(defun rcirc-update-prompt (&optional all)
"Reset the prompt string in the current buffer.
If ALL is non-nil, update prompts in all IRC buffers."
(if all
(mapc (lambda (process)
(mapc (lambda (buffer)
(with-current-buffer buffer
(rcirc-update-prompt)))
(with-rcirc-process-buffer process
(mapcar 'cdr rcirc-buffer-alist))))
(rcirc-process-list))
(let ((inhibit-read-only t)
(prompt (or rcirc-prompt "")))
(mapc (lambda (rep)
(setq prompt
(replace-regexp-in-string (car rep) (cdr rep) prompt)))
(list (cons "%n" (rcirc-buffer-nick))
(cons "%s" (with-rcirc-server-buffer rcirc-server-name))
(cons "%t" (or rcirc-target ""))))
(save-excursion
(delete-region rcirc-prompt-start-marker rcirc-prompt-end-marker)
(goto-char rcirc-prompt-start-marker)
(let ((start (point)))
(insert-before-markers prompt)
(set-marker rcirc-prompt-start-marker start)
(when (not (zerop (- rcirc-prompt-end-marker
rcirc-prompt-start-marker)))
(add-text-properties rcirc-prompt-start-marker
rcirc-prompt-end-marker
(list 'face 'rcirc-prompt
'read-only t 'field t
'front-sticky t 'rear-nonsticky t))))))))
(defun rcirc-set-changed (option value)
"Set OPTION to VALUE and update after a customization change."
(set-default option value)
(cond ((eq option 'rcirc-prompt)
(rcirc-update-prompt 'all))
(t
(error "Bad option %s" option))))
(defun rcirc-channel-p (target)
"Return t if TARGET is a channel name."
(and target
(not (zerop (length target)))
(or (eq (aref target 0) ?#)
(eq (aref target 0) ?&))))
(defcustom rcirc-log-directory (locate-user-emacs-file "rcirc-log")
"Directory to keep IRC logfiles."
:type 'directory
:version "28.1")
(defcustom rcirc-log-flag nil
"Non-nil means log IRC activity to disk.
Logfiles are kept in `rcirc-log-directory'."
:type 'boolean)
(defun rcirc-kill-buffer-hook ()
"Part the channel when killing an rcirc buffer.
If `rcirc-kill-channel-buffers' is non-nil and the killed buffer
is a server buffer, kills all of the channel buffers associated
with it."
(when (eq major-mode 'rcirc-mode)
(when (and rcirc-log-flag
rcirc-log-directory)
(rcirc-log-write))
(rcirc-clean-up-buffer "Killed buffer")
(when-let* ((process (get-buffer-process (current-buffer))))
(delete-process process))
(when (and rcirc-buffer-alist ;; it's a server buffer
rcirc-kill-channel-buffers)
(dolist (channel rcirc-buffer-alist)
(kill-buffer (cdr channel))))))
(defun rcirc-change-major-mode-hook ()
"Part the channel when changing the major mode."
(rcirc-clean-up-buffer "Changed major mode"))
(defun rcirc-clean-up-buffer (reason)
"Clean up current buffer and part with REASON."
(let ((buffer (current-buffer)))
(rcirc-clear-activity buffer)
(when (and (rcirc-buffer-process)
(rcirc--connection-open-p (rcirc-buffer-process)))
(with-rcirc-server-buffer
(setq rcirc-buffer-alist
(rassq-delete-all buffer rcirc-buffer-alist)))
(rcirc-update-short-buffer-names)
(if (rcirc-channel-p rcirc-target)
(rcirc-send-string (rcirc-buffer-process)
"PART" rcirc-target : reason)
(when rcirc-target
(rcirc-remove-nick-channel (rcirc-buffer-process)
(rcirc-buffer-nick)
rcirc-target))))
(setq rcirc-target nil)))
(defun rcirc-generate-new-buffer-name (process target)
"Return a buffer name based on PROCESS and TARGET.
This is used for the initial name given to IRC buffers."
(substring-no-properties
(if target
(concat target "@" (process-name process))
(concat "*" (process-name process) "*"))))
(defun rcirc-get-buffer (process target &optional server)
"Return the buffer associated with the PROCESS and TARGET.
If optional argument SERVER is non-nil, return the server buffer
if there is no existing buffer for TARGET, otherwise return nil."
(with-rcirc-process-buffer process
(if (null target)
(current-buffer)
(let ((buffer (cdr (assoc-string target rcirc-buffer-alist t))))
(or buffer (when server (current-buffer)))))))
(defun rcirc-get-buffer-create (process target)
"Return the buffer associated with the PROCESS and TARGET.
Create the buffer if it doesn't exist."
(let ((buffer (rcirc-get-buffer process target)))
(if (and buffer (buffer-live-p buffer))
(with-current-buffer buffer
(when (not rcirc-target)
(setq rcirc-target target))
buffer)
;; create the buffer
(with-rcirc-process-buffer process
(let ((new-buffer (get-buffer-create
(rcirc-generate-new-buffer-name process target))))
(with-current-buffer new-buffer
(unless (eq major-mode 'rcirc-mode)
(rcirc-mode process target))
(setq mode-line-process nil))
(rcirc-put-nick-channel process (rcirc-nick process) target
rcirc-current-line)
new-buffer)))))
(defun rcirc-send-input ()
"Send input to target associated with the current buffer."
(interactive)
(if (< (point) rcirc-prompt-end-marker)
;; copy the line down to the input area
(progn
(forward-line 0)
(let ((start (if (eq (point) (point-min))
(point)
(if (get-text-property (1- (point)) 'hard)
(point)
(previous-single-property-change (point) 'hard))))
(end (next-single-property-change (1+ (point)) 'hard)))
(goto-char (point-max))
(insert (replace-regexp-in-string
"\n\\s-+" " "
(buffer-substring-no-properties start end)))))
;; process input
(goto-char (point-max))
(when (not (equal 0 (- (point) rcirc-prompt-end-marker)))
;; delete a trailing newline
(when (eq (point) (line-beginning-position))
(delete-char -1))
(let ((input (buffer-substring-no-properties
rcirc-prompt-end-marker (point))))
(dolist (line (split-string input "\n"))
(rcirc-process-input-line line))
;; add to input-ring
(save-excursion
(ring-insert rcirc-input-ring input)
(setq rcirc-input-ring-index 0))))))
(defun rcirc-fill-paragraph (&optional justify)
"Implementation for `fill-paragraph-function'.
The argument JUSTIFY is passed on to `fill-region'."
(interactive "P")
(when (> (point) rcirc-prompt-end-marker)
(save-restriction
(narrow-to-region rcirc-prompt-end-marker (point-max))
(let ((fill-column rcirc-max-message-length))
(fill-region (point-min) (point-max) justify)))))
(defun rcirc-process-input-line (line)
"Process LINE as a message or a command."
(if (string-match "^/\\([^/ ][^ ]*\\) ?\\(.*\\)$" line)
(rcirc-process-command (match-string 1 line)
(match-string 2 line)
line)
(rcirc-process-message line)))
(defun rcirc-process-message (line)
"Process LINE as a message to be sent."
(when (and (null rcirc-target)
(string-match
(rx bos (group (+? nonl)) "@" (+ nonl) eos)
(buffer-name)))
(setq rcirc-target (match-string 1 (buffer-name))))
(if (not rcirc-target)
(message "Not joined (no target)")
(delete-region rcirc-prompt-end-marker (point))
(rcirc-send-message (rcirc-buffer-process) rcirc-target line)
(setq rcirc-last-post-time (current-time))))
(defun rcirc-process-command (command args line)
"Process COMMAND with arguments ARGS.
LINE is the raw input, from which COMMAND and ARGS was
extracted."
(let ((fun (intern-soft (concat "rcirc-cmd-" command)))
(process (rcirc-buffer-process)))
(newline)
(with-current-buffer (current-buffer)
(delete-region rcirc-prompt-end-marker (point))
(if (string= command "me")
(rcirc-print process (rcirc-buffer-nick)
"ACTION" rcirc-target args)
(rcirc-print process (rcirc-buffer-nick)
"COMMAND" rcirc-target line))
(set-marker rcirc-prompt-end-marker (point))
(if (fboundp fun)
(funcall fun args process rcirc-target)
(rcirc-send-string process command : args)))))
(defvar-local rcirc-parent-buffer nil
"Message buffer that requested a multiline buffer.")
(put 'rcirc-parent-buffer 'permanent-local t)
(defvar rcirc-window-configuration nil
"Window configuration before creating multiline buffer.")
(defun rcirc-edit-multiline ()
"Move current edit to a dedicated buffer."
(interactive)
(let ((pos (1+ (- (point) rcirc-prompt-end-marker))))
(goto-char (point-max))
(let ((text (buffer-substring-no-properties rcirc-prompt-end-marker
(point)))
(parent (buffer-name)))
(delete-region rcirc-prompt-end-marker (point))
(setq rcirc-window-configuration (current-window-configuration))
(pop-to-buffer (concat "*multiline " parent "*"))
(funcall rcirc-multiline-major-mode)
(rcirc-multiline-minor-mode 1)
(setq rcirc-parent-buffer parent)
(insert text)
(and (> pos 0) (goto-char pos))
(message "Type %s to return text to %s, or %s to cancel"
(substitute-command-keys "\\[rcirc-multiline-minor-submit]")
parent
(substitute-command-keys "\\[rcirc-multiline-minor-cancel]")))))
(defvar-keymap rcirc-multiline-minor-mode-map
:doc "Keymap for multiline mode in rcirc."
"C-c C-f C-b" #'rcirc-format-bold
"C-c C-f C-i" #'rcirc-format-italic
"C-c C-f C-u" #'rcirc-format-underline
"C-c C-f C-s" #'rcirc-format-strike-through
"C-c C-f C-f" #'rcirc-format-fixed-width
"C-c C-f C-t" #'rcirc-format-fixed-width ;as in AucTeX
"C-c C-f C-d" #'rcirc-unformat
"C-c C-c" #'rcirc-multiline-minor-submit
"C-x C-s" #'rcirc-multiline-minor-submit
"C-c C-k" #'rcirc-multiline-minor-cancel
"ESC ESC ESC" #'rcirc-multiline-minor-cancel)
(define-minor-mode rcirc-multiline-minor-mode
"Minor mode for editing multiple lines in rcirc."
:lighter " rcirc-mline"
:global nil
(setq fill-column rcirc-max-message-length))
(defun rcirc-multiline-minor-submit ()
"Send the text in buffer back to parent buffer."
(interactive)
(untabify (point-min) (point-max))
(let ((text (buffer-substring (point-min) (point-max)))
(buffer (current-buffer))
(pos (point)))
(set-buffer rcirc-parent-buffer)
(goto-char (point-max))
(insert text)
(kill-buffer buffer)
(set-window-configuration rcirc-window-configuration)
(goto-char (+ rcirc-prompt-end-marker (1- pos)))))
(defun rcirc-multiline-minor-cancel ()
"Cancel the multiline edit."
(interactive)
(kill-buffer (current-buffer))
(set-window-configuration rcirc-window-configuration))
(defun rcirc-any-buffer (process)
"Return a buffer for PROCESS, either the one selected or the process buffer."
(if rcirc-always-use-server-buffer-flag
(process-buffer process)
(let ((buffer (window-buffer)))
(if (and buffer
(with-current-buffer buffer
(and (eq major-mode 'rcirc-mode)
(eq (rcirc-buffer-process) process))))
buffer
(process-buffer process)))))
(defcustom rcirc-response-formats
'(("PRIVMSG" . "<%N> %m")
("NOTICE" . "-%N- %m")
("ACTION" . "[%N %m]")
("COMMAND" . "%m")
("ERROR" . "%fw!!! %m")
("FAIL" . "(%fwFAIL%f-) %m")
("WARN" . "(%fwWARN%f-) %m")
("NOTE" . "(%fwNOTE%f-) %m")
(t . "%fp*** %fs%n %r %m"))
"An alist of formats used for printing responses.
The format is looked up using the response-type as a key;
if no match is found, the default entry (with a key of t) is used.
The entry's value part should be a string, which is inserted with
the of the following escape sequences replaced by the described values:
%m The message text
%n The sender's nick
%N The sender's nick (with face `rcirc-my-nick' or `rcirc-other-nick')
%r The response-type
%t The target
%fw Following text uses the face `font-lock-warning-face'
%fp Following text uses the face `rcirc-server-prefix'
%fs Following text uses the face `rcirc-server'
%f[FACE] Following text uses the face FACE
%f- Following text uses the default face
%% A literal `%' character"
:type '(alist :key-type (choice (string :tag "Type")
(const :tag "Default" t))
:value-type string))
(defun rcirc-format-response-string (process sender response target text)
"Return a formatted response string from SENDER, incorporating TEXT.
The specific formatting used is found by looking up RESPONSE in
`rcirc-response-formats'. PROCESS is the process object used for
communication."
(with-temp-buffer
(insert (or (cdr (assoc response rcirc-response-formats))
(cdr (assq t rcirc-response-formats))))
(goto-char (point-min))
(let ((start (point-min))
(sender (if (or (not sender)
(string= (rcirc-server-name process) sender))
""
(funcall rcirc-nick-filter sender)))
face)
(while (re-search-forward "%\\(\\(f\\(.\\)\\)\\|\\(.\\)\\)" nil t)
(rcirc-add-face start (match-beginning 0) face)
(setq start (match-beginning 0))
(replace-match
(cl-case (aref (match-string 1) 0)
(?f (setq face
(cl-case (string-to-char (match-string 3))
(?w 'font-lock-warning-face)
(?p 'rcirc-server-prefix)
(?s 'rcirc-server)
(t nil)))
"")
(?n sender)
(?N (let ((my-nick (rcirc-nick process)))
(save-match-data
(with-syntax-table rcirc-nick-syntax-table
(rcirc-facify sender
(cond ((string= sender my-nick)
'rcirc-my-nick)
((and rcirc-bright-nicks
(string-match
(regexp-opt rcirc-bright-nicks
'words)
sender))
'rcirc-bright-nick)
((and rcirc-dim-nicks
(string-match
(regexp-opt rcirc-dim-nicks
'words)
sender))
'rcirc-dim-nick)
(t
'rcirc-other-nick)))))))
(?m (propertize text 'rcirc-text text))
(?r response)
(?t (or target ""))
(t (concat "UNKNOWN CODE:" (match-string 0))))
t t nil 0)
(rcirc-add-face (match-beginning 0) (match-end 0) face))
(rcirc-add-face start (match-beginning 0) face))
(buffer-substring (point-min) (point-max))))
(defun rcirc-target-buffer (process sender response target _text)
"Return a buffer to print the server response from SENDER.
PROCESS is the process object for the current connection."
(cl-assert (not (bufferp target)))
(with-rcirc-process-buffer process
(cond ((not target)
(rcirc-any-buffer process))
((not (rcirc-channel-p target))
;; message from another user
(if (or (string= response "PRIVMSG")
(string= response "ACTION"))
(rcirc-get-buffer-create process (if (string= sender rcirc-nick)
target
sender))
(rcirc-get-buffer process target t)))
((or (rcirc-get-buffer process target)
(rcirc-any-buffer process))))))
(defvar-local rcirc-last-sender nil)
(defvar-local rcirc-activity-types nil
"List of symbols designating kinds of activities in a buffer.")
(defcustom rcirc-omit-threshold 100
"Lines since last activity from a nick before `rcirc-omit-responses' are omitted."
:type 'integer)
(defcustom rcirc-log-process-buffers nil
"Non-nil if rcirc process buffers should be logged to disk."
:type 'boolean
:version "24.1")
(defun rcirc-last-quit-line (process nick target)
"Return the line number where NICK left TARGET.
Returns nil if the information is not recorded.
PROCESS is the process object for the current connection."
(let ((chanbuf (rcirc-get-buffer process target)))
(when chanbuf
(cdr (assoc-string nick (buffer-local-value
'rcirc-recent-quit-alist
chanbuf))))))
(defun rcirc-last-line (process nick target)
"Return the line from the last activity from NICK in TARGET.
PROCESS is the process object for the current connection."
(let ((line (or (cdr (assoc-string target
(gethash nick (with-rcirc-server-buffer
rcirc-nick-table)) t))
(rcirc-last-quit-line process nick target))))
(if line
line
;;(message "line is nil for %s in %s" nick target)
nil)))
(defun rcirc-elapsed-lines (process nick target)
"Return the number of lines since activity from NICK in TARGET.
PROCESS is the process object for the current connection."
(let ((last-activity-line (rcirc-last-line process nick target)))
(when (and last-activity-line
(> last-activity-line 0))
(- rcirc-current-line last-activity-line))))
(defvar rcirc-markup-text-functions
'(rcirc-markup-attributes
rcirc-color-attributes
rcirc-remove-markup-codes
rcirc-markup-my-nick
rcirc-markup-urls
rcirc-markup-keywords
rcirc-markup-bright-nicks
rcirc-markup-bridge-bots)
"List of functions used to manipulate text before it is printed.
Each function takes two arguments, SENDER, and RESPONSE. The
buffer is narrowed with the text to be printed and the point is
at the beginning of the `rcirc-text' propertized text.")
(defun rcirc-print (process sender response target text &optional activity)
"Print TEXT in the buffer associated with TARGET.
Format based on SENDER and RESPONSE. If ACTIVITY is non-nil,
record activity. PROCESS is the process object for the current
connection."
(or text (setq text ""))
(unless (and (or (member sender rcirc-ignore-list)
(member (with-syntax-table rcirc-nick-syntax-table
(when (string-match "^\\([^/]\\w*\\)[:,]" text)
(match-string 1 text)))
rcirc-ignore-list))
;; do not ignore if we sent the message
(not (string= sender (rcirc-nick process))))
(let* ((buffer (rcirc-target-buffer process sender response target text))
(time (if-let* ((time (rcirc-get-tag "time")))
(parse-iso8601-time-string time t)
(current-time)))
(inhibit-read-only t))
(with-current-buffer buffer
(let ((moving (= (point) rcirc-prompt-end-marker))
(old-point (point-marker)))
(setq text (decode-coding-string text rcirc-decode-coding-system))
(unless (string= sender (rcirc-nick process))
;; mark the line with overlay arrow
(unless (or (marker-position overlay-arrow-position)
(get-buffer-window (current-buffer))
(member response rcirc-omit-responses))
(set-marker overlay-arrow-position
(marker-position rcirc-prompt-start-marker))))
;; temporarily set the marker insertion-type because
;; insert-before-markers results in hidden text in new buffers
(goto-char rcirc-prompt-start-marker)
(catch 'exit
(while (not (bobp))
(goto-char (or (previous-single-property-change (point) 'hard)
(point-min)))
(when (let ((then (get-text-property (point) 'rcirc-time)))
(and then (not (time-less-p time then))))
(goto-char (next-single-property-change (point) 'hard))
(forward-char 1)
(throw 'exit nil))))
(goto-char (line-beginning-position))
(set-marker-insertion-type rcirc-prompt-start-marker t)
(set-marker-insertion-type rcirc-prompt-end-marker t)
;; run markup functions
(save-excursion
(save-restriction
(narrow-to-region (point) (point))
(insert (propertize (rcirc-format-response-string process sender response
nil text)
'rcirc-msgid (rcirc-get-tag "msgid"))
(propertize "\n" 'hard t))
(goto-char (or (next-single-property-change (point-min) 'rcirc-text)
(point)))
(when (rcirc-buffer-process)
(save-excursion (rcirc-markup-timestamp sender response))
(dolist (fn rcirc-markup-text-functions)
(save-excursion (funcall fn sender response)))
(when rcirc-fill-flag
(save-excursion (rcirc-markup-fill sender response))))
(when rcirc-read-only-flag
(add-text-properties (point-min) (point-max)
'(read-only t front-sticky t)))
(add-text-properties (point-min) (point-max)
(list 'rcirc-time time))
;; make text omittable
(let ((last-activity-lines (rcirc-elapsed-lines process sender target)))
(if (and (not (string= (rcirc-nick process) sender))
(or (member response rcirc-omit-responses)
(and (member response rcirc-omit-unless-requested)
(if (member response rcirc-pending-requests)
(ignore (setq rcirc-pending-requests
(delete response rcirc-pending-requests)))
t)))
(or (member response rcirc-omit-unless-requested)
(not last-activity-lines)
(< rcirc-omit-threshold last-activity-lines)))
(put-text-property (point-min) (point-max)
'invisible 'rcirc-omit)
;; otherwise increment the line count
(setq rcirc-current-line (1+ rcirc-current-line))))))
(set-marker-insertion-type rcirc-prompt-start-marker nil)
(set-marker-insertion-type rcirc-prompt-end-marker nil)
;; truncate buffer if it is very long
(save-excursion
(when (and rcirc-buffer-maximum-lines
(> rcirc-buffer-maximum-lines 0)
(= (forward-line (- rcirc-buffer-maximum-lines)) 0))
(delete-region (point-min) (point))))
;; set the window point for buffers show in windows
(walk-windows (lambda (w)
(when (and (not (eq (selected-window) w))
(eq (current-buffer)
(window-buffer w))
(>= (window-point w)
rcirc-prompt-end-marker))
(set-window-point w (point-max))))
nil t)
;; restore the point
(goto-char (if moving rcirc-prompt-end-marker old-point)))
;; keep window on bottom line if it was already there
(when rcirc-scroll-show-maximum-output
(let ((window (get-buffer-window)))
(when window
(with-selected-window window
(when (eq major-mode 'rcirc-mode)
(when (<= (- (window-height)
(count-screen-lines (window-point)
(window-start))
1)
0)
(recenter -1)))))))
;; flush undo (can we do something smarter here?)
(buffer-disable-undo)
(buffer-enable-undo)
;; record mode line activity
(when (and activity
(not rcirc-ignore-buffer-activity-flag)
(not (and rcirc-dim-nicks sender
(string-match (regexp-opt rcirc-dim-nicks) sender)
(rcirc-channel-p target))))
(rcirc-record-activity (current-buffer)
(when (not (rcirc-channel-p rcirc-target))
'nick)))
(when (and rcirc-log-flag
(or target
rcirc-log-process-buffers))
(rcirc-log process sender response target text))
(sit-for 0) ; displayed text before hook
(run-hook-with-args 'rcirc-print-functions
process sender response target text)))))
(defun rcirc-when ()
"Show the time of reception of the message at point."
(interactive)
(if-let* ((time (get-text-property (point) 'rcirc-time)))
(message (format-time-string "%c" time))
(message "No time information at point.")))
(defun rcirc-generate-log-filename (process target)
"Return filename for log file based on PROCESS and TARGET."
(concat
(if target
(rcirc-generate-new-buffer-name process target)
(process-name process))
".log"))
(defcustom rcirc-log-filename-function 'rcirc-generate-log-filename
"A function to generate the filename used by rcirc's logging facility.
It is called with two arguments, PROCESS and TARGET (see
`rcirc-generate-new-buffer-name' for their meaning), and should
return the filename, or nil if no logging is desired for this
session.
If the returned filename is absolute (`file-name-absolute-p'
returns t), then it is used as-is, otherwise the resulting file
is put into `rcirc-log-directory'.
The filename is then cleaned using `convert-standard-filename' to
guarantee valid filenames for the current OS."
:type 'function)
(defun rcirc-log (process sender response target text)
"Record TEXT from SENDER to TARGET to be logged.
The message is logged in `rcirc-log', and is later written to
disk. PROCESS is the process object for the current connection."
(let ((filename (funcall rcirc-log-filename-function process target))
(time (and-let* ((time (rcirc-get-tag "time")))
(parse-iso8601-time-string time t))))
(unless (null filename)
(let ((cell (assoc-string filename rcirc-log-alist))
(line (concat (format-time-string rcirc-log-time-format time)
(substring-no-properties
(rcirc-format-response-string process sender
response target text))
"\n")))
(if cell
(setcdr cell (concat (cdr cell) line))
(setq rcirc-log-alist
(cons (cons filename line) rcirc-log-alist)))))))
(defun rcirc-log-write ()
"Flush `rcirc-log-alist' data to disk.
Log data is written to `rcirc-log-directory', except for
log-files with absolute names (see `rcirc-log-filename-function')."
(dolist (cell rcirc-log-alist)
(let ((filename (convert-standard-filename
(expand-file-name (car cell)
rcirc-log-directory)))
(coding-system-for-write 'utf-8))
(make-directory (file-name-directory filename) t)
(with-temp-buffer
(insert (cdr cell))
(write-region (point-min) (point-max) filename t 'quiet))))
(setq rcirc-log-alist nil))
(defun rcirc-view-log-file ()
"View logfile corresponding to the current buffer."
(interactive)
(find-file-other-window
(expand-file-name (funcall rcirc-log-filename-function
(rcirc-buffer-process) rcirc-target)
rcirc-log-directory)))
(defun rcirc-join-channels (process channels)
"Join CHANNELS.
PROCESS is the process object for the current connection."
(save-window-excursion
(dolist (channel channels)
(with-rcirc-process-buffer process
(rcirc-cmd-join channel process)))))
\f
;;; nick management
(defvar rcirc-nick-prefix-chars '(?~ ?& ?@ ?% ?+)
"List of junk characters to strip from nick prefixes.")
(defun rcirc-user-nick (user)
"Return the nick from USER. Remove any non-nick junk."
(save-match-data
(if (string-match (concat "^[" rcirc-nick-prefix-chars
"]*\\([^! ]+\\)!?")
(or user ""))
(match-string 1 user)
user)))
(defun rcirc-nick-channels (process nick)
"Return list of channels for NICK.
PROCESS is the process object for the current connection."
(with-rcirc-process-buffer process
(mapcar (lambda (x) (car x))
(gethash nick rcirc-nick-table))))
(defun rcirc-put-nick-channel (process nick channel &optional line)
"Add CHANNEL to list associated with NICK.
Update the associated linestamp if LINE is non-nil.
If the record doesn't exist, and LINE is nil, set the linestamp
to zero. PROCESS is the process object for the current connection."
(let ((nick (rcirc-user-nick nick)))
(with-rcirc-process-buffer process
(let* ((chans (gethash nick rcirc-nick-table))
(record (assoc-string channel chans t)))
(if record
(when line (setcdr record line))
(puthash nick (cons (cons channel (or line 0))
chans)
rcirc-nick-table))))))
(defun rcirc-nick-remove (process nick)
"Remove NICK from table.
PROCESS is the process object for the current connection."
(with-rcirc-process-buffer process
(remhash nick rcirc-nick-table)))
(defun rcirc-remove-nick-channel (process nick channel)
"Remove the CHANNEL from list associated with NICK.
PROCESS is the process object for the current connection."
(with-rcirc-process-buffer process
(let* ((chans (gethash nick rcirc-nick-table))
(newchans
;; instead of assoc-string-delete-all:
(let ((record (assoc-string channel chans t)))
(when record
(setcar record 'delete)
(assq-delete-all 'delete chans)))))
(if newchans
(puthash nick newchans rcirc-nick-table)
(remhash nick rcirc-nick-table)))))
(defvar rcirc-pseudo-nicks)
(defun rcirc-channel-nicks (process target)
"Return the list of nicks associated with TARGET sorted by last activity.
PROCESS is the process object for the current connection."
(when target
(if (rcirc-channel-p target)
(let ((pseudo-nicks (mapcar #'list rcirc-pseudo-nicks)))
(with-rcirc-process-buffer process
(let (nicks)
(maphash
(lambda (k v)
(let ((record (assoc-string target v t)))
(if record
(setq nicks (cons (cons k (cdr record)) nicks)))))
rcirc-nick-table)
(mapcar (lambda (x) (car x))
(sort (nconc pseudo-nicks nicks)
(lambda (x y)
(let ((lx (or (cdr x) 0))
(ly (or (cdr y) 0)))
(< ly lx))))))))
(list target))))
(defun rcirc-ignore-update-automatic (nick)
"Check if NICK is in `rcirc-ignore-list-automatic'.
If so, remove from `rcirc-ignore-list'. PROCESS is the process
object for the current connection."
(when (member nick rcirc-ignore-list-automatic)
(setq rcirc-ignore-list-automatic
(delete nick rcirc-ignore-list-automatic)
rcirc-ignore-list
(delete nick rcirc-ignore-list))))
\f
(defun rcirc-nickname< (s1 s2)
"Return non-nil if IRC nickname S1 is less than S2, and nil otherwise.
Operator nicknames (@) are considered less than voiced
nicknames (+). Any other nicknames are greater than voiced
nicknames. The comparison is case-insensitive."
(setq s1 (downcase s1)
s2 (downcase s2))
(let* ((s1-op (eq ?@ (string-to-char s1)))
(s2-op (eq ?@ (string-to-char s2))))
(if s1-op
(if s2-op
(string< (substring s1 1) (substring s2 1))
t)
(if s2-op
nil
(string< s1 s2)))))
(defun rcirc-sort-nicknames-join (input sep)
"Return a string of sorted nicknames.
INPUT is a string containing nicknames separated by SEP.
This function does not alter the INPUT string."
(let* ((parts (split-string input sep t))
(sorted (sort parts 'rcirc-nickname<)))
(mapconcat rcirc-nick-filter sorted sep)))
\f
;;; activity tracking
(defvar-keymap rcirc-track-minor-mode-map
:doc "Keymap for rcirc track minor mode."
"C-c C-@" #'rcirc-next-active-buffer
"C-c C-SPC" #'rcirc-next-active-buffer)
(define-obsolete-variable-alias 'rcirc-track-abbrevate-flag
'rcirc-track-abbreviate-flag "30.1")
(defcustom rcirc-track-abbreviate-flag t
"Non-nil means `rcirc-track-minor-mode' should abbreviate names."
:version "30.1"
:type 'boolean)
;;;###autoload
(define-minor-mode rcirc-track-minor-mode
"Global minor mode for tracking activity in rcirc buffers."
:global t
(or global-mode-string (setq global-mode-string '("")))
;; toggle the mode-line channel indicator
(if rcirc-track-minor-mode
(progn
(and (not (memq 'rcirc-activity-string global-mode-string))
(setq global-mode-string
(append global-mode-string '(rcirc-activity-string))))
(add-hook 'window-configuration-change-hook
'rcirc-window-configuration-change))
(setq global-mode-string
(delete 'rcirc-activity-string global-mode-string))
(remove-hook 'window-configuration-change-hook
'rcirc-window-configuration-change)))
(add-to-list 'minor-mode-alist '(rcirc-ignore-buffer-activity-flag " Ignore"))
(add-to-list 'minor-mode-alist '(rcirc-low-priority-flag " LowPri"))
(defun rcirc-toggle-ignore-buffer-activity ()
"Toggle the value of `rcirc-ignore-buffer-activity-flag'."
(interactive)
(setq rcirc-ignore-buffer-activity-flag
(not rcirc-ignore-buffer-activity-flag))
(message (if rcirc-ignore-buffer-activity-flag
"Ignore activity in this buffer"
"Notice activity in this buffer"))
(force-mode-line-update))
(defun rcirc-toggle-low-priority ()
"Toggle the value of `rcirc-low-priority-flag'."
(interactive)
(setq rcirc-low-priority-flag
(not rcirc-low-priority-flag))
(message (if rcirc-low-priority-flag
"Activity in this buffer is low priority"
"Activity in this buffer is normal priority"))
(force-mode-line-update))
(defun rcirc-switch-to-server-buffer ()
"Switch to the server buffer associated with current channel buffer."
(interactive)
(switch-to-buffer (with-rcirc-server-buffer (current-buffer))))
(defun rcirc-jump-to-first-unread-line ()
"Move the point to the first unread line in this buffer."
(interactive)
(if (marker-position overlay-arrow-position)
(goto-char overlay-arrow-position)
(message "No unread messages")))
(defun rcirc-bury-buffers ()
"Bury all RCIRC buffers."
(interactive)
(dolist (buf (buffer-list))
(when (eq 'rcirc-mode (buffer-local-value 'major-mode buf))
(bury-buffer buf) ; buffers not shown
(quit-windows-on buf)))) ; buffers shown in a window
(defun rcirc-next-active-buffer (arg)
"Switch to the next rcirc buffer with activity.
With prefix ARG, go to the next low priority buffer with activity."
(interactive "P")
(let* ((pair (rcirc-split-activity rcirc-activity))
(lopri (car pair))
(hipri (cdr pair)))
(if (or (and (not arg) hipri)
(and arg lopri))
(progn
(switch-to-buffer (car (if arg lopri hipri)))
(when (> (point) rcirc-prompt-start-marker)
(recenter -1)))
(rcirc-bury-buffers)
(message "No IRC activity.%s"
(if lopri
(concat
" Type C-u " (key-description (this-command-keys))
" for low priority activity.")
""))))
(rcirc-update-activity-string))
(defvar rcirc-activity-functions nil
"Hook to be run when there is channel activity.
Functions are called with a single argument, the buffer with the
activity. Only run if the buffer is not visible and
`rcirc-ignore-buffer-activity-flag' is non-nil.")
(defun rcirc-record-activity (buffer &optional type)
"Record BUFFER activity with TYPE."
(with-current-buffer buffer
(let ((old-activity rcirc-activity)
(old-types rcirc-activity-types))
(when (and (not (get-buffer-window (current-buffer) t))
(not (and rcirc-track-ignore-server-buffer-flag
(eq rcirc-server-buffer (current-buffer)))))
(setq rcirc-activity
(sort (if (memq (current-buffer) rcirc-activity) rcirc-activity
(cons (current-buffer) rcirc-activity))
(lambda (b1 b2)
(let ((t1 (buffer-local-value 'rcirc-last-post-time b1))
(t2 (buffer-local-value 'rcirc-last-post-time b2)))
(time-less-p t2 t1)))))
(cl-pushnew type rcirc-activity-types)
(unless (and (equal rcirc-activity old-activity)
(member type old-types))
(rcirc-update-activity-string)))))
(run-hook-with-args 'rcirc-activity-functions buffer))
(defun rcirc-clear-activity (buffer)
"Clear the BUFFER activity."
(setq rcirc-activity (remove buffer rcirc-activity))
(with-current-buffer buffer
(setq rcirc-activity-types nil)))
(defun rcirc-clear-unread (buffer)
"Erase the last read message arrow from BUFFER."
(when (buffer-live-p buffer)
(with-current-buffer buffer
(set-marker overlay-arrow-position nil))))
(defun rcirc-split-activity (activity)
"Return a cons cell with ACTIVITY split into (lopri . hipri)."
(let (lopri hipri)
(dolist (buf activity)
(with-current-buffer buf
(if (and rcirc-low-priority-flag
(not (member 'nick rcirc-activity-types)))
(push buf lopri)
(push buf hipri))))
(cons (nreverse lopri) (nreverse hipri))))
(defvar rcirc-update-activity-string-hook nil
"Hook run whenever the activity string is updated.")
(defun rcirc-update-activity-string ()
"Update mode-line string."
(let* ((pair (rcirc-split-activity rcirc-activity))
(lopri (car pair))
(hipri (cdr pair)))
(setq rcirc-activity-string
(cond ((or hipri lopri)
(concat (and hipri "[")
(rcirc-activity-string hipri)
(and hipri lopri ",")
(and lopri
(concat "("
(rcirc-activity-string lopri)
")"))
(and hipri "]")))
;; Consistently don't display anything if there aren't
;; any IRC connections. Otherwise, whether we display
;; "[]" or not depends on whether or not this function
;; happens to have been called in this session yet.
;;
;; Consistently display nothing, rather than
;; consistently displaying "[]", for the sake of the
;; following sort of case: the user has enabled
;; `rcirc-track-minor-mode' using the customization
;; system, but also starts up Emacs instances that
;; aren't used for IRC. Due to the use of easy
;; customization, `rcirc-track-minor-mode' will be
;; turned on for every instance of Emacs. But we don't
;; want to take up valuable mode line space when, say,
;; Emacs is started up as the value of EDITOR/VISUAL.
((not (null (rcirc-process-list)))
"[]")
(t
"")))
(run-hooks 'rcirc-update-activity-string-hook)
(force-mode-line-update t)))
(defun rcirc-activity-string (buffers)
"Generate activity string for all BUFFERS."
(mapconcat (lambda (b)
(let ((s (substring-no-properties (rcirc-short-buffer-name b))))
(with-current-buffer b
(dolist (type rcirc-activity-types)
(rcirc-facify s (cl-case type
(nick 'rcirc-track-nick)
(keyword 'rcirc-track-keyword)))))
(let ((map (make-mode-line-mouse-map
'mouse-1
(lambda ()
(interactive)
(pop-to-buffer b)))))
(propertize s
'mouse-face 'mode-line-highlight
'local-map map))))
buffers ","))
(defun rcirc-short-buffer-name (buffer)
"Return a short name for BUFFER to use in the mode line indicator."
(with-current-buffer buffer
(funcall rcirc-channel-filter
(replace-regexp-in-string
"@.*?\\'" ""
(or (and rcirc-track-abbreviate-flag
rcirc-short-buffer-name)
(buffer-name))))))
(defun rcirc-visible-buffers ()
"Return a list of the visible buffers that are in `rcirc-mode'."
(let (acc)
(walk-windows (lambda (w)
(with-current-buffer (window-buffer w)
(when (eq major-mode 'rcirc-mode)
(push (current-buffer) acc)))))
acc))
(defvar rcirc-visible-buffers nil
"List of visible IRC buffers.")
(defun rcirc-window-configuration-change ()
"Clear activity and overlay arrows, unless minibuffer is active."
(unless (minibuffer-window-active-p (minibuffer-window))
(rcirc-window-configuration-change-1)))
(defun rcirc-window-configuration-change-1 ()
"Clear activity and overlay arrows."
(let* ((old-activity rcirc-activity)
(hidden-buffers rcirc-visible-buffers))
(setq rcirc-visible-buffers (rcirc-visible-buffers))
(dolist (vbuf rcirc-visible-buffers)
(setq hidden-buffers (delq vbuf hidden-buffers))
;; clear activity for all visible buffers
(rcirc-clear-activity vbuf))
;; clear unread arrow from recently hidden buffers
(dolist (hbuf hidden-buffers)
(rcirc-clear-unread hbuf))
;; remove any killed buffers from list
(setq rcirc-activity
(delq nil (mapcar (lambda (buf) (when (buffer-live-p buf) buf))
rcirc-activity)))
;; update the mode-line string
(unless (equal old-activity rcirc-activity)
(rcirc-update-activity-string))))
\f
;;; buffer name abbreviation
(defun rcirc-update-short-buffer-names ()
"Update variable `rcirc-short-buffer-name' for IRC buffers."
(let ((bufalist
(apply 'append (mapcar (lambda (process)
(with-rcirc-process-buffer process
rcirc-buffer-alist))
(rcirc-process-list)))))
(dolist (i (rcirc-abbreviate bufalist))
(when (buffer-live-p (cdr i))
(with-current-buffer (cdr i)
(setq rcirc-short-buffer-name (car i)))))))
(defun rcirc-abbreviate (pairs)
"Generate alist of abbreviated buffer names to buffers.
PAIRS is the concatenated value of all `rcirc-buffer-alist'
values, from each process."
(apply 'append (mapcar 'rcirc-rebuild-tree (rcirc-make-trees pairs))))
(defun rcirc-rebuild-tree (tree)
"Merge prefix TREE into alist of unique prefixes to buffers."
(let ((ch (char-to-string (car tree)))
acc)
(dolist (x (cdr tree))
(if (listp x)
(setq acc (append acc
(mapcar (lambda (y)
(cons (concat ch (car y))
(cdr y)))
(rcirc-rebuild-tree x))))
(setq acc (cons (cons ch x) acc))))
acc))
(defun rcirc-make-trees (pairs)
"Generate tree prefix tree of buffer names.
PAIRS is a list of (TARGET . BUFFER) entries. The resulting tree
is a list of (CHAR . CHILDREN) cons-cells, where CHAR is the
leading character and CHILDREN is either BUFFER when a unique
prefix could be found or another tree if it shares the same
prefix with another element in PAIRS."
(let (alist)
(mapc (lambda (pair)
(if (consp pair)
(let* ((str (car pair))
(data (cdr pair))
(char (unless (zerop (length str))
(aref str 0)))
(rest (unless (zerop (length str))
(substring str 1)))
(part (if char (assq char alist))))
(if part
;; existing partition
(setcdr part (cons (cons rest data) (cdr part)))
;; new partition
(setq alist (cons (if char
(list char (cons rest data))
data)
alist))))
(setq alist (cons pair alist))))
pairs)
;; recurse into cdrs of alist
(mapc (lambda (x)
(when (and (listp x) (listp (cadr x)))
(setcdr x (if (> (length (cdr x)) 1)
(rcirc-make-trees (cdr x))
(setcdr x (list (cdadr x)))))))
alist)))
\f
;;; /commands these are called with 3 args: PROCESS, TARGET, which is
;; the current buffer/channel/user, and ARGS, which is a string
;; containing the text following the /cmd.
(defmacro rcirc-define-command (command arguments &rest body)
"Define a new client COMMAND in BODY that takes ARGUMENTS.
ARGUMENTS may designate optional arguments using a single
`&optional' symbol. Just like `defun', a string at the beginning
of BODY is interpreted as the documentation string. Following
that, an interactive form can specified."
(declare (debug (symbolp (&rest symbolp) def-body))
(indent defun))
(cl-check-type command symbol)
(cl-check-type arguments list)
(let* ((fn-name (intern (concat "rcirc-cmd-" (symbol-name command))))
(total (length (remq '&optional arguments)))
(required (- (length arguments) (length (memq '&optional arguments))))
(optional (- total required))
(regexp (with-temp-buffer
(insert "\\`")
(when arguments
(dotimes (_ (1- (length arguments)))
(insert "\\(?:\\(.+?\\)[[:space:]]+"))
(dotimes (i (1- (length arguments)))
(if (< i optional)
(insert "\\)?")
(insert "\\)"))))
(insert "\\(.*?\\)")
(insert "[[:space:]]*\\'")
(buffer-string)))
(argument (make-symbol "arglist"))
documentation
interactive-spec)
(when (stringp (car body))
(setq documentation (pop body)))
(when (eq (car-safe (car-safe body)) 'interactive)
(setq interactive-spec (cadr (pop body))))
`(progn
(defun ,fn-name (,argument &optional process target)
,(concat documentation
"\n\nNote: If PROCESS or TARGET are nil, the values given"
"\nby `rcirc-buffer-process' and `rcirc-target' will be used.")
(interactive ,(if (stringp interactive-spec)
;; HACK: Necessary to wrap the result of
;; the interactive spec in a list.
`(list (call-interactively
(lambda (&rest args)
(interactive ,interactive-spec)
args)))
`(list ,interactive-spec)))
(unless (if (listp ,argument)
(<= ,required (length ,argument) ,total)
(string-match ,regexp ,argument))
(user-error "Malformed input (%s): %S" ',command ,argument))
(push ,(upcase (symbol-name command)) rcirc-pending-requests)
(let ((process (or process (rcirc-buffer-process)))
(target (or target rcirc-target)))
(ignore target process)
(let (,@(cl-loop
for i from 0 for arg in (delq '&optional arguments)
collect `(,arg (if (listp ,argument)
(nth ,i ,argument)
(match-string ,(1+ i) ,argument)))))
,@body)))
(add-to-list 'rcirc-client-commands ,(concat "/" (symbol-name command))))))
(define-obsolete-function-alias
'defun-rcirc-command
'rcirc-define-command
"28.1")
(rcirc-define-command msg (chan-or-nick message)
"Send MESSAGE to CHAN-OR-NICK."
(interactive (list (completing-read "Message nick: "
(with-rcirc-server-buffer
rcirc-nick-table))
(read-string "Message: ")))
(rcirc-send-message process chan-or-nick message))
(rcirc-define-command query (nick)
"Open a private chat buffer to NICK."
(interactive (list (completing-read "Query nick: "
(with-rcirc-server-buffer
rcirc-nick-table))))
(let ((existing-buffer (rcirc-get-buffer process nick)))
(switch-to-buffer (or existing-buffer
(rcirc-get-buffer-create process nick)))
(when (not existing-buffer)
(rcirc-cmd-whois nick))))
(rcirc-define-command join (channels)
"Join CHANNELS.
CHANNELS is a comma- or space-separated string of channel names."
(interactive "sJoin channels: ")
(let* ((split-channels (split-string channels "[ ,]" t))
(buffers (mapcar (lambda (ch)
(rcirc-get-buffer-create process ch))
split-channels))
(channels (mapconcat 'identity split-channels ",")))
(rcirc-send-string process "JOIN" channels)
(when (not (eq (selected-window) (minibuffer-window)))
(dolist (b buffers) ;; order the new channel buffers in the buffer list
(switch-to-buffer b)))))
(rcirc-define-command invite (nick channel)
"Invite NICK to CHANNEL."
(interactive (list
(completing-read "Invite nick: "
(with-rcirc-server-buffer rcirc-nick-table))
(read-string "Channel: ")))
(rcirc-send-string process "INVITE" nick channel))
(rcirc-define-command part (&optional channel reason)
"Part CHANNEL.
CHANNEL should be a string of the form \"#CHANNEL-NAME REASON\".
If omitted, CHANNEL-NAME defaults to TARGET, and REASON defaults
to `rcirc-default-part-reason'."
(interactive "sPart channel: \nsReason: ")
(rcirc-send-string process "PART" (or channel target)
: (or reason rcirc-default-part-reason)))
(rcirc-define-command quit (&optional reason)
"Send a quit message to server with REASON."
(interactive "sQuit reason: ")
(rcirc-send-string process "QUIT"
: (or reason rcirc-default-quit-reason)))
(rcirc-define-command reconnect ()
"Reconnect to current server."
(interactive "i")
(setq rcirc-failed-attempts 0)
(rcirc-reconnect process))
(rcirc-define-command nick (nick)
"Change nick to NICK."
(interactive (list (read-string "New nick: ")))
(rcirc-send-string process "NICK" nick))
(rcirc-define-command names (&optional channel)
"Display list of names in CHANNEL or in current channel if CHANNEL is nil.
If called interactively, prompt for a channel when prefix arg is supplied."
(interactive (list (and current-prefix-arg
(read-string "List names in channel: "))))
(rcirc-send-string process "NAMES" (or channel target)))
(rcirc-define-command topic (topic)
"List TOPIC for the TARGET channel.
With a prefix arg, prompt for new topic."
(interactive (list (and current-prefix-arg
(read-string "List names in channel: "))))
(if (> (length topic) 0)
(rcirc-send-string process "TOPIC" target : topic)
(rcirc-send-string process "TOPIC" target)))
(rcirc-define-command whois (nick)
"Request information from server about NICK."
(interactive (list (completing-read
"Whois: "
(with-rcirc-server-buffer rcirc-nick-table))))
(rcirc-send-string process "WHOIS" nick))
(rcirc-define-command mode (nick-or-chan mode)
"Set NICK-OR-CHAN mode to MODE."
(interactive (list (read-string "Mode nick or channel: ")
(read-string "Mode: ")))
(rcirc-send-string process "MODE" nick-or-chan mode))
(rcirc-define-command list (channels)
"Request information on CHANNELS from server."
(interactive "sList Channels: ")
(rcirc-send-string process "LIST" channels))
(rcirc-define-command oper (args)
"Send operator command to server."
(interactive "sOper args: ")
(rcirc-send-string process "OPER" args))
(rcirc-define-command quote (message)
"Send MESSAGE literally to server."
(interactive "sServer message: ")
(rcirc-send-string process message))
(rcirc-define-command kick (nick reason)
"Kick NICK from current channel."
(interactive (list
(completing-read "Kick nick: "
(rcirc-channel-nicks
(rcirc-buffer-process)
rcirc-target))
(read-from-minibuffer "Kick reason: ")))
(rcirc-send-string process "KICK" target nick : reason))
(defun rcirc-cmd-ctcp (args &optional process _target)
"Handle ARGS as a CTCP command.
PROCESS is the process object for the current connection."
(if (string-match "^\\([^ ]+\\)\\s-+\\(.+\\)$" args)
(let* ((target (match-string 1 args))
(request (upcase (match-string 2 args)))
(function (intern-soft (concat "rcirc-ctcp-sender-" request))))
(if (fboundp function) ;; use special function if available
(funcall function process target request)
(rcirc-send-ctcp process target request)))
(rcirc-print process (rcirc-nick process) "ERROR" nil
"usage: /ctcp NICK REQUEST")))
(defun rcirc-ctcp-sender-PING (process target _request)
"Send a CTCP PING message to TARGET.
PROCESS is the process object for the current connection."
(let ((timestamp (format-time-string "%s")))
(rcirc-send-ctcp process target "PING" timestamp)))
(defun rcirc-cmd-me (args process target)
"Send an action message ARGS to TARGET.
PROCESS is the process object for the current connection."
(when target (rcirc-send-ctcp process target "ACTION" args)))
(defun rcirc-add-or-remove (set &rest elements)
"Toggle membership of ELEMENTS in SET."
(dolist (elt elements)
(if (and elt (not (string= "" elt)))
(setq set (if (member-ignore-case elt set)
(delete elt set)
(cons elt set)))))
set)
(rcirc-define-command ignore (nick)
"Manage the ignore list.
Ignore NICK, unignore NICK if already ignored, or list ignored
nicks when no NICK is given. When listing ignored nicks, the
ones added to the list automatically are marked with an asterisk."
(interactive "sToggle ignoring of nick: ")
(setq rcirc-ignore-list
(apply #'rcirc-add-or-remove rcirc-ignore-list
(split-string nick nil t)))
(rcirc-print process nil "IGNORE" target
(mapconcat
(lambda (nick)
(concat nick
(if (member nick rcirc-ignore-list-automatic)
"*" "")))
rcirc-ignore-list " ")))
(rcirc-define-command bright (nick)
"Manage the bright nick list."
(interactive "sToggle emphasis of nick: ")
(setq rcirc-bright-nicks
(apply #'rcirc-add-or-remove rcirc-bright-nicks
(split-string nick nil t)))
(rcirc-print process nil "BRIGHT" target
(mapconcat 'identity rcirc-bright-nicks " ")))
(rcirc-define-command dim (nick)
"Manage the dim nick list."
(interactive "sToggle deemphasis of nick: ")
(setq rcirc-dim-nicks
(apply #'rcirc-add-or-remove rcirc-dim-nicks
(split-string nick nil t)))
(rcirc-print process nil "DIM" target
(mapconcat 'identity rcirc-dim-nicks " ")))
(rcirc-define-command keyword (keyword)
"Manage the keyword list.
Mark KEYWORD, unmark KEYWORD if already marked, or list marked
keywords when no KEYWORD is given."
(interactive "sToggle highlighting of keyword: ")
(setq rcirc-keywords
(apply #'rcirc-add-or-remove rcirc-keywords
(split-string keyword nil t)))
(rcirc-print process nil "KEYWORD" target
(mapconcat 'identity rcirc-keywords " ")))
\f
(defun rcirc-add-face (start end name &optional object)
"Add face NAME to the face text property of the text from START to END."
(when name
(let ((pos start)
next prop)
(while (< pos end)
(setq prop (get-text-property pos 'font-lock-face object)
next (next-single-property-change pos 'font-lock-face object end))
(unless (member name (get-text-property pos 'font-lock-face object))
(add-text-properties pos next
(list 'font-lock-face (cons name prop)) object))
(setq pos next)))))
(defun rcirc-facify (string face)
"Return a copy of STRING with FACE property added."
(let ((string (or string "")))
(rcirc-add-face 0 (length string) face string)
string))
(defvar rcirc-url-regexp
(eval-when-compile
(require 'browse-url)
browse-url-button-regexp)
"Regexp matching URLs. Set to nil to disable URL features in rcirc.")
(defun rcirc-browse-url (&optional arg)
"Prompt for URL to browse based on URLs in buffer before point.
If ARG is given, opens the URL in a new browser window."
(interactive "P")
(let* ((point (point))
(filtered (seq-filter
(lambda (x) (>= point (cdr x)))
rcirc-urls))
(completions (mapcar (lambda (x) (car x)) filtered))
(defaults (mapcar (lambda (x) (car x)) filtered)))
(browse-url (completing-read "Rcirc browse-url: "
completions nil nil (car defaults) nil defaults)
arg)))
\f
(defun rcirc-markup-timestamp (_sender _response)
"Insert a timestamp."
(goto-char (point-min))
(let ((time (and-let* ((time (rcirc-get-tag "time")))
(parse-iso8601-time-string time t))))
(insert (rcirc-facify (format-time-string rcirc-time-format time)
'rcirc-timestamp))))
(defvar-local rcirc-pseudo-nicks '()
"List of virtual nicks detected in a channel.
These are collected by `rcirc-markup-bridge-bots' and don't
constitute actual users in the current channel. Usually these
are bridged via a some bot as described in
`rcirc-bridge-bot-alist'.")
(defcustom rcirc-bridge-bot-alist '()
"Alist for handling bouncers by `rcirc-markup-bridge-bots'.
Each entry has the form (NAME . REGEXP), where NAME is the user
name of a bouncer and REGEXP is a pattern used to match the
message. The matching part of the message will be stripped from
the message, and the first match group will replace the user name
of the bot. Any matched name will noted and used in some cases
for nick completion."
:type '(alist :key-type (string :tag "Bot name")
:value-type regexp)
:version "29.1")
(defface rcirc-bridged-nick
'((t :inherit highlight))
"Face used for pseudo-nick ."
:version "29.1")
(defun rcirc-markup-bridge-bots (sender response)
"Detect and reformat bridged messages to appear more natural.
The user option `rcirc-bridge-bot-alist' specified what SENDER to
handle. This function only operates on direct messages (as
indicated by RESPONSE)."
(catch 'quit
(atomic-change-group
(save-match-data
(when-let* (((string= response "PRIVMSG"))
(regexp (alist-get sender rcirc-bridge-bot-alist
nil nil #'string=))
((search-forward-regexp regexp nil t))
(nick (match-string-no-properties 1)))
(replace-match "") ;delete the bot string
(unless (member nick rcirc-pseudo-nicks)
(push nick rcirc-pseudo-nicks))
(goto-char (point-min))
(let ((fmt (alist-get "PRIVMSG" rcirc-response-formats
nil nil #'string=))
(hl-face (cond ((member sender rcirc-bright-nicks)
'rcirc-bright-nick)
((member sender rcirc-dim-nicks)
'rcirc-dim-nick)
(t 'rcirc-other-nick)))
hl-username-p)
(when (string-match (rx (* "%%") "%" (group (or ?N ?n))) fmt)
(when (string= (match-string 1 fmt) "N")
(setq hl-username-p t))
(search-forward-regexp
(format-spec
(alist-get "PRIVMSG" rcirc-response-formats
nil nil #'string=)
`((?m . "") (?r . "") (?t . "") (?f . "")
(?N . ,(rx (group (+? nonl))))
(?n . ,(rx (group (+? nonl))))))
nil t)
(replace-match
(propertize
nick
'help-echo (format "Message bridged via %s" sender)
'face `(,@(and hl-username-p (list hl-face))
rcirc-bridged-nick))
nil t nil 1))))))))
(defun rcirc-markup-attributes (_sender _response)
"Highlight IRC markup, indicated by ASCII control codes."
(while (re-search-forward
(rx (group (or #x02 #x1d #x1f #x1e #x11))
(*? nonl)
(group (or (backref 1) (+ #x0f) eol)))
nil t)
(rcirc-add-face (match-beginning 0) (match-end 0)
(cl-case (char-after (match-beginning 0))
(#x02 'bold)
(#x1d 'italic)
(#x1f 'underline)
(#x1e '(:strike-through t))
(#x11 'rcirc-monospace-text)))
(goto-char (1+ (match-beginning 0)))))
(defconst rcirc-color-codes
;; Taken from https://modern.ircdocs.horse/formatting.html
["white" "black" "blue" "green" "red" "brown" "magenta"
"orange" "yellow" "light green" "cyan" "light cyan"
"light blue" "pink" "grey" "light grey"
"#470000" "#472100" "#474700" "#324700" "#004700" "#00472c"
"#004747" "#002747" "#000047" "#2e0047" "#470047" "#47002a"
"#740000" "#743a00" "#747400" "#517400" "#007400" "#007449"
"#007474" "#004074" "#000074" "#4b0074" "#740074" "#740045"
"#b50000" "#b56300" "#b5b500" "#7db500" "#00b500" "#00b571"
"#00b5b5" "#0063b5" "#0000b5" "#7500b5" "#b500b5" "#b5006b"
"#ff0000" "#ff8c00" "#ffff00" "#b2ff00" "#00ff00" "#00ffa0"
"#00ffff" "#008cff" "#0000ff" "#a500ff" "#ff00ff" "#ff0098"
"#ff5959" "#ffb459" "#ffff71" "#cfff60" "#6fff6f" "#65ffc9"
"#6dffff" "#59b4ff" "#5959ff" "#c459ff" "#ff66ff" "#ff59bc"
"#ff9c9c" "#ffd39c" "#ffff9c" "#e2ff9c" "#9cff9c" "#9cffdb"
"#9cffff" "#9cd3ff" "#9c9cff" "#dc9cff" "#ff9cff" "#ff94d3"
"#000000" "#131313" "#282828" "#363636" "#4d4d4d" "#656565"
"#818181" "#9f9f9f" "#bcbcbc" "#e2e2e2" "#ffffff"]
"Vector of colors for each IRC color code.")
(defun rcirc-color-attributes (_sender _response)
"Highlight IRC color-codes, indicated by ASCII control codes."
(while (re-search-forward
(rx #x03
(? (group (= 2 digit)) (? "," (group (= 2 digit))))
(*? nonl)
(or #x03 #x0f eol))
nil t)
(let (foreground background)
(when-let* ((fg-raw (match-string 1))
(fg (string-to-number fg-raw))
((<= 0 fg (1- (length rcirc-color-codes)))))
(setq foreground (aref rcirc-color-codes fg)))
(when-let* ((bg-raw (match-string 2))
(bg (string-to-number bg-raw))
((<= 0 bg (1- (length rcirc-color-codes)))))
(setq background (aref rcirc-color-codes bg)))
(rcirc-add-face (match-beginning 0) (match-end 0)
`(face (,@(and foreground (list :foreground foreground))
,@(and background (list :background background))))))))
(defun rcirc-remove-markup-codes (_sender _response)
"Remove ASCII control codes used to designate markup."
(while (re-search-forward
(rx (or #x02 #x1d #x1f #x1e #x11 #x0f
(: #x03 (? (= 2 digit) (? "," (= 2 digit))))))
nil t)
(delete-region (match-beginning 0) (match-end 0))))
(defun rcirc-markup-my-nick (_sender response)
"Highlight the users nick.
If RESPONSE indicates that the nick was mentioned in a message,
highlight the entire line and record the activity."
(with-syntax-table rcirc-nick-syntax-table
(while (re-search-forward (concat "\\b"
(regexp-quote (rcirc-nick
(rcirc-buffer-process)))
"\\b")
nil t)
(rcirc-add-face (match-beginning 0) (match-end 0)
'rcirc-nick-in-message)
(when (string= response "PRIVMSG")
(rcirc-add-face (point-min) (point-max)
'rcirc-nick-in-message-full-line)
(rcirc-record-activity (current-buffer) 'nick)))))
(defun rcirc-markup-urls (_sender _response)
"Highlight and activate URLs."
(while (and rcirc-url-regexp ; nil means disable URL catching.
(re-search-forward rcirc-url-regexp nil t))
(let* ((start (match-beginning 0))
(url (buffer-substring-no-properties start (point))))
(when rcirc-url-max-length
;; Replace match with truncated URL.
(delete-region start (point))
(insert (url-truncate-url-for-viewing url rcirc-url-max-length)))
;; Add a button for the URL. Note that we use `make-text-button',
;; rather than `make-button', as text-buttons are much faster in
;; large buffers.
(make-text-button start (point)
'face 'rcirc-url
'follow-link t
'rcirc-url url
'action (lambda (button)
(browse-url-button-open-url
(button-get button 'rcirc-url))))
;; Record the URL if it is not already the latest stored URL.
(unless (string= url (caar rcirc-urls))
(push (cons url start) rcirc-urls)))))
(defun rcirc-markup-keywords (sender response)
"Highlight keywords as specified by `rcirc-keywords'.
Keywords are only highlighted in messages (as indicated by
RESPONSE) when they were not written by the user (as indicated by
SENDER)."
(when (and (string= response "PRIVMSG")
(not (string= sender (rcirc-nick (rcirc-buffer-process)))))
(let* ((target (or rcirc-target ""))
(keywords (delq nil (mapcar (lambda (keyword)
(when (not (string-match keyword
target))
keyword))
rcirc-keywords))))
(when keywords
(while (re-search-forward (regexp-opt keywords 'words) nil t)
(rcirc-add-face (match-beginning 0) (match-end 0) 'rcirc-keyword)
(rcirc-record-activity (current-buffer) 'keyword))))))
(defun rcirc-markup-bright-nicks (_sender response)
"Highlight nicks brightly as specified by `rcirc-bright-nicks'.
This highlighting only takes place in name lists (as indicated by
RESPONSE)."
(when (and rcirc-bright-nicks
(string= response "NAMES"))
(with-syntax-table rcirc-nick-syntax-table
(while (re-search-forward (regexp-opt rcirc-bright-nicks 'words) nil t)
(rcirc-add-face (match-beginning 0) (match-end 0)
'rcirc-bright-nick)))))
(defun rcirc-markup-fill (_sender response)
"Fill messages as configured by `rcirc-fill-column'.
MOTD messages are not filled (as indicated by RESPONSE)."
(when (not (string= response "372")) ; /motd
(let ((fill-prefix
(or rcirc-fill-prefix
(make-string (- (point) (line-beginning-position)) ?\s)))
(fill-column (- (cond ((null rcirc-fill-column) fill-column)
((functionp rcirc-fill-column)
(funcall rcirc-fill-column))
(t rcirc-fill-column))
;; make sure ... doesn't cause line wrapping
3)))
(fill-region (point) (point-max) nil t))))
\f
;;; handlers
;; these are called with the server PROCESS, the SENDER, which is a
;; server or a user, depending on the command, the ARGS, which is a
;; list of strings, and the TEXT, which is the original server text,
;; verbatim
(defun rcirc-handler-001 (process sender args _text)
"Handle welcome message.
SENDER and ARGS are used to initialize the current connection.
PROCESS is the process object for the current connection."
(rcirc-handler-generic process "001" sender args nil)
(with-rcirc-process-buffer process
(setq rcirc-connecting nil)
(rcirc-reschedule-timeout process)
(setq rcirc-server-name sender)
(setq rcirc-nick (car args))
(rcirc-update-prompt)
(if (and rcirc-auto-authenticate-flag
;; We have to ensure that there's an authentication
;; entry for that server. Otherwise,
;; there's no point in calling authenticate.
(let (auth-required)
(dolist (s rcirc-authinfo auth-required)
(when (string-match (car s) rcirc-server)
(setq auth-required t)))))
(if rcirc-authenticate-before-join
(progn
(add-hook 'rcirc-authenticated-hook 'rcirc-join-channels-post-auth t t)
(rcirc-authenticate))
(rcirc-authenticate)
(rcirc-join-channels process rcirc-startup-channels))
(rcirc-join-channels process rcirc-startup-channels))))
(defun rcirc-join-channels-post-auth (process)
"Join `rcirc-startup-channels' after authenticating.
PROCESS is the process object for the current connection."
(with-rcirc-process-buffer process
(rcirc-join-channels process rcirc-startup-channels)))
(defun rcirc-handler-PRIVMSG (process sender args text)
"Handle a (private) message from SENDER.
ARGS should have the form (TARGET MESSAGE). TEXT is the verbatim
message as received from the server. PROCESS is the process
object for the current connection."
(rcirc-check-auth-status process sender args text)
(let ((target (if (rcirc-channel-p (car args))
(car args)
sender))
(message (or (cadr args) "")))
(if (string-match "^\C-a\\(.*\\)\C-a$" message)
(rcirc-handler-CTCP process target sender (match-string 1 message))
(rcirc-print process sender "PRIVMSG" target message t))
;; update nick linestamp
(with-current-buffer (rcirc-get-buffer process target t)
(rcirc-put-nick-channel process sender target rcirc-current-line))))
(defun rcirc-handler-NOTICE (process sender args text)
"Handle a notice message from SENDER.
ARGS should have the form (TARGET MESSAGE).
TEXT is the verbatim message as received from the server.
PROCESS is the process object for the current connection."
(rcirc-check-auth-status process sender args text)
(let ((target (car args))
(message (cadr args)))
(if (string-match "^\C-a\\(.*\\)\C-a$" message)
(rcirc-handler-CTCP-response process target sender
(match-string 1 message))
(rcirc-print process sender "NOTICE"
(cond ((rcirc-channel-p target)
target)
;; -ChanServ- [#gnu] Welcome...
((string-match "\\[\\(#[^] ]+\\)\\]" message)
(match-string 1 message))
(sender
(if (string= sender (rcirc-server-name process))
nil ; server notice
sender)))
message t))))
(defun rcirc-check-auth-status (process sender args _text)
"Check if the user just authenticated.
If authenticated, runs `rcirc-authenticated-hook' with PROCESS as
the only argument. ARGS should have the form (TARGET MESSAGE).
SENDER is used the determine the authentication method. PROCESS
is the process object for the current connection."
(with-rcirc-process-buffer process
(when (and (not rcirc-user-authenticated)
rcirc-authenticate-before-join
rcirc-auto-authenticate-flag)
(let ((target (car args))
(message (cadr args)))
(when (or
(and ;; nickserv
(string= sender "NickServ")
(string= target rcirc-nick)
(cl-member
message
(list
(format "You are now identified for \C-b%s\C-b." rcirc-nick)
(format "You are successfully identified as \C-b%s\C-b."
rcirc-nick)
"Password accepted - you are now recognized.")
;; The nick may have a different case, so match
;; case-insensitively (Bug#39345).
:test #'cl-equalp))
(and ;; quakenet
(string= sender "Q")
(string= target rcirc-nick)
(string-match "\\`You are now logged in as .+\\.\\'" message)))
(setq rcirc-user-authenticated t)
(run-hook-with-args 'rcirc-authenticated-hook process)
(remove-hook 'rcirc-authenticated-hook 'rcirc-join-channels-post-auth t))))))
(defun rcirc-handler-WALLOPS (process sender args _text)
"Handle WALLOPS message from SENDER.
ARGS should have the form (MESSAGE).
PROCESS is the process object for the current
connection."
(rcirc-print process sender "WALLOPS" sender (car args) t))
(defun rcirc-handler-JOIN (process sender args _text)
"Handle JOIN message from SENDER.
ARGS should have the form (CHANNEL).
PROCESS is the process object for the current
connection."
(let ((channel (car args)))
(with-current-buffer (rcirc-get-buffer-create process channel)
;; when recently rejoining, restore the linestamp
(rcirc-put-nick-channel process sender channel
(let ((last-activity-lines
(rcirc-elapsed-lines process sender channel)))
(when (and last-activity-lines
(< last-activity-lines rcirc-omit-threshold))
(rcirc-last-line process sender channel))))
;; reset mode-line-process in case joining a channel with an
;; already open buffer (after getting kicked e.g.)
(setq mode-line-process nil))
(rcirc-print process sender "JOIN" (funcall rcirc-channel-filter channel) "")
;; print in private chat buffer if it exists
(when (rcirc-get-buffer (rcirc-buffer-process) sender)
(rcirc-print process sender "JOIN" sender (funcall rcirc-channel-filter channel)))))
;; PART and KICK are handled the same way
(defun rcirc-handler-PART-or-KICK (process _response channel _sender nick _args)
"Remove NICK from CHANNEL.
PROCESS is the process object for the current connection."
(rcirc-ignore-update-automatic nick)
(if (not (string= nick (rcirc-nick process)))
;; this is someone else leaving
(progn
(rcirc-maybe-remember-nick-quit process nick channel)
(rcirc-remove-nick-channel process nick channel))
;; this is us leaving
(mapc (lambda (n)
(rcirc-remove-nick-channel process n channel))
(rcirc-channel-nicks process channel))
;; if the buffer is still around, make it inactive
(let ((buffer (rcirc-get-buffer process channel)))
(when buffer
(rcirc-disconnect-buffer buffer)))))
(defun rcirc-handler-PART (process sender args _text)
"Handle PART message from SENDER.
ARGS should have the form (CHANNEL REASON).
PROCESS is the process object for the current connection."
(let* ((channel (car args))
(reason (cadr args))
(message (concat channel " " reason)))
(rcirc-print process sender "PART" (funcall rcirc-channel-filter channel) message)
;; print in private chat buffer if it exists
(when (rcirc-get-buffer (rcirc-buffer-process) sender)
(rcirc-print process sender "PART" (funcall rcirc-channel-filter channel) message))
(rcirc-handler-PART-or-KICK process "PART" channel sender sender reason)))
(defun rcirc-handler-KICK (process sender args _text)
"Handle PART message from SENDER.
ARGS should have the form (CHANNEL NICK REASON).
PROCESS is the process object for the current connection."
(let* ((channel (car args))
(nick (cadr args))
(reason (nth 2 args))
(message (concat nick " " channel " " reason)))
(rcirc-print process sender "KICK" (funcall rcirc-channel-filter channel) message t)
;; print in private chat buffer if it exists
(when (rcirc-get-buffer (rcirc-buffer-process) nick)
(rcirc-print process sender "KICK" nick message))
(rcirc-handler-PART-or-KICK process "KICK" channel sender nick reason)))
(defun rcirc-maybe-remember-nick-quit (process nick channel)
"Remember NICK as leaving CHANNEL if they recently spoke.
PROCESS is the process object for the current connection."
(let ((elapsed-lines (rcirc-elapsed-lines process nick channel)))
(when (and elapsed-lines
(< elapsed-lines rcirc-omit-threshold))
(let ((buffer (rcirc-get-buffer process channel)))
(when buffer
(with-current-buffer buffer
(let ((record (assoc-string nick rcirc-recent-quit-alist t))
(line (rcirc-last-line process nick channel)))
(if record
(setcdr record line)
(setq rcirc-recent-quit-alist
(cons (cons nick line)
rcirc-recent-quit-alist))))))))))
(defun rcirc-handler-QUIT (process sender args _text)
"Handle QUIT message from SENDER.
PROCESS is the process object for the current connection."
(rcirc-ignore-update-automatic sender)
(mapc (lambda (channel)
;; broadcast quit message each channel
(rcirc-print process sender "QUIT" (funcall rcirc-channel-filter channel) (apply 'concat args))
;; record nick in quit table if they recently spoke
(rcirc-maybe-remember-nick-quit process sender channel))
(rcirc-nick-channels process sender))
(rcirc-nick-remove process sender))
(defun rcirc-handler-NICK (process sender args _text)
"Handle NICK message from SENDER.
ARGS should have the form (NEW-NICK).
PROCESS is the process object for the current connection."
(let* ((old-nick sender)
(new-nick (car args))
(channels (rcirc-nick-channels process old-nick)))
;; update list of ignored nicks
(rcirc-ignore-update-automatic old-nick)
(when (member old-nick rcirc-ignore-list)
(add-to-list 'rcirc-ignore-list new-nick)
(add-to-list 'rcirc-ignore-list-automatic new-nick))
;; print message to nick's channels
(dolist (target channels)
(rcirc-print process sender "NICK" target new-nick))
;; update chat buffer, if it exists
(when-let* ((chat-buffer (rcirc-get-buffer process old-nick)))
(with-current-buffer chat-buffer
(rcirc-print process sender "NICK" old-nick new-nick)
(setq rcirc-target new-nick)
(rename-buffer (rcirc-generate-new-buffer-name process new-nick) t))
(setf rcirc-buffer-alist
(cons (cons new-nick chat-buffer)
(delq (assoc-string old-nick rcirc-buffer-alist t)
rcirc-buffer-alist))))
;; remove old nick and add new one
(with-rcirc-process-buffer process
(let ((v (gethash old-nick rcirc-nick-table)))
(remhash old-nick rcirc-nick-table)
(puthash new-nick v rcirc-nick-table))
;; if this is our nick...
(when (string= old-nick rcirc-nick)
(setq rcirc-nick new-nick)
(rcirc-update-prompt t)
;; reauthenticate
(when rcirc-auto-authenticate-flag (rcirc-authenticate))))))
(defun rcirc-handler-PING (process _sender args _text)
"Respond to a PING with a PONG.
ARGS should have the form (MESSAGE). MESSAGE is relayed back to
the server. PROCESS is the process object for the current
connection."
(rcirc-send-string process "PONG" : (car args)))
(defun rcirc-handler-PONG (_process _sender _args _text)
"Ignore all incoming PONG messages.")
(defun rcirc-handler-TOPIC (process sender args _text)
"Note the topic change from SENDER.
PROCESS is the process object for the current connection."
(let ((topic (cadr args)))
(rcirc-print process sender "TOPIC" (car args) topic)
(with-current-buffer (rcirc-get-buffer process (car args))
(setq rcirc-topic topic))))
(defvar rcirc-nick-away-alist nil
"Alist from nicks to away messages.")
(defun rcirc-handler-301 (process _sender args text)
"Handle away messages (RPL_AWAY).
ARGS should have the form (NICK AWAY-MESSAGE).
PROCESS is the process object for the current connection."
(let* ((nick (cadr args))
(rec (assoc-string nick rcirc-nick-away-alist))
(away-message (nth 2 args)))
(when (or (not rec)
(not (string= (cdr rec) away-message)))
;; away message has changed
(rcirc-handler-generic process "AWAY" nick (cdr args) text)
(if rec
(setcdr rec away-message)
(setq rcirc-nick-away-alist (cons (cons nick away-message)
rcirc-nick-away-alist))))))
(defun rcirc-handler-317 (process sender args _text)
"Handle idle messages from SENDER (RPL_WHOISIDLE).
ARGS should have the form (NICK IDLE-SECS SIGNON-TIME).
PROCESS is the process object for the current connection."
(let* ((nick (nth 1 args))
(idle-secs (string-to-number (nth 2 args)))
(idle-string (format-seconds "%yy %dd %hh %mm %z%ss" idle-secs))
(signon-time (string-to-number (nth 3 args)))
(signon-string (format-time-string "%c" signon-time))
(message (format "%s idle for %s, signed on %s"
nick idle-string signon-string)))
(rcirc-print process sender "317" nil message t)))
(defun rcirc-handler-332 (process _sender args _text)
"Update topic when notified by server (RPL_TOPIC).
ARGS should have the form (CHANNEL TOPIC).
PROCESS is the process object for the current connection."
(let ((buffer (or (rcirc-get-buffer process (cadr args))
(rcirc-get-temp-buffer-create process (cadr args)))))
(with-current-buffer buffer
(setq rcirc-topic (nth 2 args)))))
(defun rcirc-handler-333 (process sender args _text)
"Update when and who set the current topic.
ARGS has the form (CHANNEL SETTER TIME). SENDER is passed on to
`rcirc-print'. PROCESS is the process object for the current
connection. This is a non-standard extension, not specified in
RFC1459."
(let ((buffer (or (rcirc-get-buffer process (cadr args))
(rcirc-get-temp-buffer-create process (cadr args)))))
(with-current-buffer buffer
(let ((setter (nth 2 args))
(time (current-time-string
(string-to-number (cadddr args)))))
(rcirc-print process sender "TOPIC" (cadr args)
(format "%s (%s on %s)" rcirc-topic setter time))))))
(defun rcirc-handler-477 (process sender args _text)
"Notify user that CHANNEL does not support modes (ERR_NOCHANMODES).
ARGS has the form (CHANNEL MESSAGE). SENDER is passed on to
`rcirc-print'. PROCESS is the process object for the current
connection."
(rcirc-print process sender "477" (cadr args) (nth 2 args)))
(defun rcirc-handler-MODE (process sender args _text)
"Handle MODE messages.
ARGS should have the form (TARGET . MESSAGE-LIST).
SENDER is passed on to `rcirc-print'.
PROCESS is the process object for the current connection."
(let ((target (car args))
(msg (mapconcat 'identity (cdr args) " ")))
(rcirc-print process sender "MODE"
(if (string= target (rcirc-nick process))
nil
target)
msg)
;; print in private chat buffers if they exist
(mapc (lambda (nick)
(when (rcirc-get-buffer process nick)
(rcirc-print process sender "MODE" nick msg)))
(cddr args))))
(defun rcirc-get-temp-buffer-create (process channel)
"Return a buffer based on PROCESS and CHANNEL."
(let ((tmpnam (concat " " (downcase channel) "TMP" (process-name process))))
(get-buffer-create tmpnam)))
(defun rcirc-handler-353 (process _sender args _text)
"Start handling list of users (RPL_NAMREPLY).
ARGS should have the form (TYPE CHANNEL . NICK-LIST).
PROCESS is the process object for the current connection."
(let ((channel (nth 2 args))
(names (or (nth 3 args) "")))
(mapc (lambda (nick)
(rcirc-put-nick-channel process nick channel))
(split-string names " " t))
;; create a temporary buffer to insert the names into
;; rcirc-handler-366 (RPL_ENDOFNAMES) will handle it
(with-current-buffer (rcirc-get-temp-buffer-create process channel)
(goto-char (point-max))
(insert (car (last args)) " "))))
(defun rcirc-handler-366 (process sender args _text)
"Handle end of user list (RPL_ENDOFNAMES).
SENDER is passed on to `rcirc-print'.
PROCESS is the process object for the current connection."
(let* ((channel (cadr args))
(buffer (rcirc-get-temp-buffer-create process channel)))
(with-current-buffer buffer
(rcirc-print process sender "NAMES" channel
(let ((content (buffer-substring (point-min) (point-max))))
(rcirc-sort-nicknames-join content " "))))
(kill-buffer buffer)))
(defun rcirc-handler-433 (process sender args text)
"Warn user that nick is used (ERR_NICKNAMEINUSE).
ARGS should have the form (NICK CHANNEL WARNING).
SENDER is passed on to `rcirc-handler-generic'.
PROCESS is the process object for the current connection."
(rcirc-handler-generic process "433" sender args text)
(with-rcirc-process-buffer process
(let* ((length (string-to-number
(or (rcirc-server-parameter-value 'nicklen)
"16"))))
(rcirc-cmd-nick (rcirc--make-new-nick (cadr args) length) nil process))))
(defun rcirc--make-new-nick (nick length)
"Attempt to create a unused nickname out of NICK.
A new nick may at most be LENGTH characters long. If we already
have some ` chars at the end, then shorten the non-` bit of the
name."
(when (= (length nick) length)
(setq nick (replace-regexp-in-string "[^`]\\(`+\\)\\'" "\\1" nick)))
(concat
(if (>= (length nick) length)
(substring nick 0 (1- length))
nick)
"`"))
(defun rcirc-handler-005 (process sender args text)
"Register supported server features (RPL_ISUPPORT).
ARGS should be a list of string feature parameters, either of the
form \"PARAMETER\" to enable a feature, \"PARAMETER=VALUE\" to
configure a specific option or \"-PARAMETER\" to disable a
previously specified feature. SENDER is passed on to
`rcirc-handler-generic'. PROCESS is the process object for the
current connection. Note that this is not the behavior as
specified in RFC2812, where 005 stood for RPL_BOUNCE."
(rcirc-handler-generic process "005" sender args text)
(with-rcirc-process-buffer process
(setq rcirc-server-parameters (append rcirc-server-parameters args))))
(defun rcirc-authenticate ()
"Send authentication to process associated with current buffer.
Passwords are stored in `rcirc-authinfo' (which see)."
(interactive)
(with-rcirc-server-buffer
(dolist (i rcirc-authinfo)
(let ((process (rcirc-buffer-process))
(server (car i))
(nick (nth 2 i))
(method (cadr i))
(args (cdddr i)))
(when (and (string-match server rcirc-server))
(if (and (memq method '(nickserv chanserv bitlbee))
(string-match nick rcirc-nick))
;; the following methods rely on the user's nickname.
(cl-case method
(nickserv
(rcirc-send-privmsg
process
(or (cadr args) "NickServ")
(concat "IDENTIFY " (car args))))
(chanserv
(rcirc-send-privmsg
process
"ChanServ"
(format "IDENTIFY %s %s" (car args) (cadr args))))
(bitlbee
(rcirc-send-privmsg
process
"&bitlbee"
(concat "IDENTIFY " (car args))))
(sasl nil))
;; quakenet authentication doesn't rely on the user's nickname.
;; the variable `nick' here represents the Q account name.
(when (eq method 'quakenet)
(rcirc-send-privmsg
process
"Q@CServe.quakenet.org"
(format "AUTH %s %s" nick (car args))))))))))
(defun rcirc-handler-INVITE (process sender args _text)
"Notify user of an invitation from SENDER.
ARGS should have the form (TARGET CHANNEL). PROCESS is the
process object for the current connection."
(let ((self (with-rcirc-process-buffer process rcirc-nick))
(target (car args))
(chan (cadr args)))
;; `rcirc-channel-filter' is not used here because joining
;; requires an unfiltered name.
(if (string= target self)
(rcirc-print process sender "INVITE" nil
(format "%s invited you to %s"
sender chan)
t)
(rcirc-print process sender "INVITE" chan
(format "%s invited %s"
sender target)
t))))
(defun rcirc-handler-ERROR (process sender args _text)
"Print a error message.
SENDER and ARGS (in concatenated form) are passed on to
`rcirc-print'. PROCESS is the process object for the current
connection."
(rcirc-print process sender "ERROR" nil (mapconcat 'identity args " ")))
(defun rcirc-handler-CTCP (process target sender text)
"Handle Client-To-Client-Protocol message TEXT.
The message is addressed from SENDER to TARGET. Attempt to find
an appropriate handler, by invoicing the function
`rcirc-handler-ctcp-REQUEST', where REQUEST is the message type
as extracted from TEXT. If no handler was found, an error
message will be printed. PROCESS is the process object for the
current connection."
(if (string-match "^\\([^ ]+\\) *\\(.*\\)$" text)
(let* ((request (upcase (match-string 1 text)))
(args (match-string 2 text))
(handler (intern-soft (concat "rcirc-handler-ctcp-" request))))
(if (not (fboundp handler))
(rcirc-print process sender "ERROR" target
(format "%s sent unsupported ctcp: %s" sender text)
t)
(funcall handler process target sender args)
(unless (or (string= request "ACTION")
(string= request "KEEPALIVE"))
(rcirc-print process sender "CTCP" target
(format "%s" text) t))))))
(defun rcirc-handler-ctcp-VERSION (process _target sender _message)
"Handle a CTCP VERSION message from SENDER.
PROCESS is the process object for the current connection."
(rcirc-send-string process "NOTICE" sender :
(rcirc-ctcp-wrap "VERSION" rcirc-id-string)))
(defun rcirc-handler-ctcp-ACTION (process target sender message)
"Handle a CTCP ACTION MESSAGE from SENDER to TARGET.
PROCESS is the process object for the current connection."
(rcirc-print process sender "ACTION" target message t))
(defun rcirc-handler-ctcp-TIME (process _target sender _message)
"Respond to CTCP TIME message from SENDER.
PROCESS is the process object for the current connection."
(rcirc-send-string process "NOTICE" sender :
(rcirc-ctcp-wrap "TIME" (current-time-string))))
(defun rcirc-handler-CTCP-response (process _target sender message)
"Handle CTCP response MESSAGE from SENDER.
PROCESS is the process object for the current connection."
(rcirc-print process sender "CTCP" nil message t))
(defun rcirc-handler-CAP (process _sender args _text)
"Handle capability negotiation messages.
ARGS should have the form (USER SUBCOMMAND . ARGUMENTS). PROCESS
is the process object for the current connection."
(with-rcirc-process-buffer process
(let ((subcmd (cadr args)))
(dolist (cap (cddr args))
(cond ((string= subcmd "ACK")
(push (intern (downcase cap)) rcirc-acked-capabilities)
(setq rcirc-requested-capabilities
(delete cap rcirc-requested-capabilities)))
((string= subcmd "NAK")
(setq rcirc-requested-capabilities
(delete cap rcirc-requested-capabilities))))))
(when (and (null rcirc-requested-capabilities) rcirc-finished-sasl)
;; All requested capabilities have been responded to
(rcirc-send-string process "CAP" "END"))))
(defun rcirc-handler-TAGMSG (process sender _args _text)
"Handle a empty tag message from SENDER.
PROCESS is the process object for the current connection."
(dolist (tag rcirc-message-tags)
(when-let* ((handler (intern-soft (concat "rcirc-tag-handler-" (car tag))))
((fboundp handler)))
(funcall handler process sender (cdr tag)))))
(defun rcirc-handler-BATCH (process _sender args _text)
"Open or close a batch.
ARGS should have the form (tag type . parameters) when starting a
batch, or (tag) when closing a batch. PROCESS is the process
object for the current connection."
(with-rcirc-process-buffer process
(let ((type (cadr args))
(id (substring (car args) 1)))
(cond
((= (aref (car args) 0) ?+) ;start a new batch
(when (assoc id rcirc-batch-attributes)
(error "Starting batch with already used ID"))
(setf (alist-get id rcirc-batch-attributes nil nil #'string=)
(cons type (cddr args))))
((= (aref (car args) 0) ?-) ;close a batch
(unless (assoc id rcirc-batch-attributes)
(error "Closing a unknown batch"))
(let ((type (car (alist-get id rcirc-batch-attributes
nil nil #'string=))))
(when (eq (car (alist-get type rcirc-supported-batch-types
nil nil #'string=))
'deferred)
(let ((messages (alist-get id rcirc-batched-messages
nil nil #'string=))
(bhandler (intern-soft (concat "rcirc-batch-handler-" type))))
(if (fboundp bhandler)
(funcall bhandler process id (nreverse messages))
(dolist (message (nreverse messages))
(let ((cmd (nth 0 message))
(process (nth 1 message))
(sender (nth 2 message))
(args (nth 3 message))
(text (nth 4 message))
(rcirc-message-tags (nth 5 message)))
(if-let* ((handler (intern-soft (concat "rcirc-handler-" cmd))))
(funcall handler process sender args text)
(rcirc-handler-generic process cmd sender args text))))))))
(setq rcirc-batch-attributes
(delq (assoc id rcirc-batch-attributes)
rcirc-batch-attributes)
rcirc-batched-messages
(delq (assoc id rcirc-batched-messages)
rcirc-batched-messages)))))))
(defun rcirc-handler-AUTHENTICATE (process _cmd _args _text)
"Respond to authentication request.
PROCESS is the process object for the current connection."
(rcirc-send-string
process
"AUTHENTICATE"
(base64-encode-string
;; use connection user-name
(concat "\0" (nth 3 rcirc-connection-info)
"\0" (rcirc-get-server-password rcirc-server)))))
(defun rcirc-handler-900 (process sender args _text)
"Respond to a successful authentication response.
SENDER is passed on to `rcirc-handler-generic'. PROCESS is the
process object for the current connection."
(rcirc-handler-generic process "900" sender args nil)
(when (not rcirc-finished-sasl)
(setq-local rcirc-finished-sasl t)
(rcirc-send-string process "CAP" "END"))
(rcirc-join-channels-post-auth process))
(defun rcirc-handler-FAIL (process _sender args _text)
"Display a FAIL message, as indicated by ARGS.
PROCESS is the process object for the current connection."
(rcirc-print process nil "FAIL" nil
(mapconcat #'identity args " ")
t))
(defun rcirc-handler-WARN (process _sender args _text)
"Display a WARN message, as indicated by ARGS.
PROCESS is the process object for the current connection."
(rcirc-print process nil "WARN" nil
(mapconcat #'identity args " ")
t))
(defun rcirc-handler-NOTE (process _sender args _text)
"Display a NOTE message, as indicated by ARGS.
PROCESS is the process object for the current connection."
(rcirc-print process nil "NOTE" nil
(mapconcat #'identity args " ")
t))
\f
(defgroup rcirc-faces nil
"Faces for rcirc."
:group 'rcirc
:group 'faces)
(defface rcirc-monospace-text
'((t :family "Monospace"))
"Face used for monospace text in messages.")
(defface rcirc-my-nick ; font-lock-function-name-face
'((((class color) (min-colors 88) (background light)) :foreground "Blue1")
(((class color) (min-colors 88) (background dark)) :foreground "LightSkyBlue")
(((class color) (min-colors 16) (background light)) :foreground "Blue")
(((class color) (min-colors 16) (background dark)) :foreground "LightSkyBlue")
(((class color) (min-colors 8)) :foreground "blue" :weight bold)
(t :inverse-video t :weight bold))
"Rcirc face for my messages.")
(defface rcirc-other-nick ; font-lock-variable-name-face
'((((class grayscale) (background light))
:foreground "Gray90" :weight bold :slant italic)
(((class grayscale) (background dark))
:foreground "DimGray" :weight bold :slant italic)
(((class color) (min-colors 88) (background light)) :foreground "DarkGoldenrod")
(((class color) (min-colors 88) (background dark)) :foreground "LightGoldenrod")
(((class color) (min-colors 16) (background light)) :foreground "DarkGoldenrod")
(((class color) (min-colors 16) (background dark)) :foreground "LightGoldenrod")
(((class color) (min-colors 8)) :foreground "yellow" :weight light)
(t :weight bold :slant italic))
"Rcirc face for other users' messages.")
(defface rcirc-bright-nick
'((((class grayscale) (background light))
:foreground "LightGray" :weight bold :underline t)
(((class grayscale) (background dark))
:foreground "Gray50" :weight bold :underline t)
(((class color) (min-colors 88) (background light)) :foreground "CadetBlue")
(((class color) (min-colors 88) (background dark)) :foreground "Aquamarine")
(((class color) (min-colors 16) (background light)) :foreground "CadetBlue")
(((class color) (min-colors 16) (background dark)) :foreground "Aquamarine")
(((class color) (min-colors 8)) :foreground "magenta")
(t :weight bold :underline t))
"Rcirc face for nicks matched by `rcirc-bright-nicks'.")
(defface rcirc-dim-nick
'((t :inherit default))
"Rcirc face for nicks in `rcirc-dim-nicks'.")
(defface rcirc-server ; font-lock-comment-face
'((((class grayscale) (background light))
:foreground "DimGray" :weight bold :slant italic)
(((class grayscale) (background dark))
:foreground "LightGray" :weight bold :slant italic)
(((class color) (min-colors 88) (background light))
:foreground "Firebrick")
(((class color) (min-colors 88) (background dark))
:foreground "chocolate1")
(((class color) (min-colors 16) (background light))
:foreground "red")
(((class color) (min-colors 16) (background dark))
:foreground "red1")
(((class color) (min-colors 8) (background light)))
(((class color) (min-colors 8) (background dark)))
(t :weight bold :slant italic))
"Rcirc face for server messages.")
(defface rcirc-server-prefix ; font-lock-comment-delimiter-face
'((default :inherit rcirc-server)
(((class grayscale)))
(((class color) (min-colors 16)))
(((class color) (min-colors 8) (background light))
:foreground "red")
(((class color) (min-colors 8) (background dark))
:foreground "red1"))
"Rcirc face for server prefixes.")
(defface rcirc-timestamp
'((t :inherit default))
"Rcirc face for timestamps.")
(defface rcirc-nick-in-message ; font-lock-keyword-face
'((((class grayscale) (background light)) :foreground "LightGray" :weight bold)
(((class grayscale) (background dark)) :foreground "DimGray" :weight bold)
(((class color) (min-colors 88) (background light)) :foreground "Purple")
(((class color) (min-colors 88) (background dark)) :foreground "Cyan1")
(((class color) (min-colors 16) (background light)) :foreground "Purple")
(((class color) (min-colors 16) (background dark)) :foreground "Cyan")
(((class color) (min-colors 8)) :foreground "cyan" :weight bold)
(t :weight bold))
"Rcirc face for instances of your nick within messages.")
(defface rcirc-nick-in-message-full-line '((t :weight bold))
"Rcirc face for emphasizing the entire message when your nick is mentioned.")
(defface rcirc-prompt ; comint-highlight-prompt
'((((min-colors 88) (background dark)) :foreground "cyan1")
(((background dark)) :foreground "cyan")
(t :foreground "dark blue"))
"Rcirc face for prompts.")
(defface rcirc-track-nick
'((((type tty)) :inherit default)
(t :inverse-video t))
"Rcirc face used in the mode-line when your nick is mentioned.")
(defface rcirc-track-keyword '((t :weight bold))
"Rcirc face used in the mode-line when keywords are mentioned.")
(defface rcirc-url '((t :weight bold))
"Rcirc face used to highlight urls.")
(defface rcirc-keyword '((t :inherit highlight))
"Rcirc face used to highlight keywords.")
\f
;; When using M-x flyspell-mode, only check words after the prompt
(put 'rcirc-mode 'flyspell-mode-predicate 'rcirc-looking-at-input)
(defun rcirc-looking-at-input ()
"Return non-nil if point is past the input marker."
(>= (point) rcirc-prompt-end-marker))
\f
(defun rcirc-server-parameter-value (parameter)
"Traverse `rcirc-server-parameters' for PARAMETER."
(cl-loop for elem in rcirc-server-parameters
for setting = (split-string elem "=")
when (and (= (length setting) 2)
(string-equal (downcase (car setting)) parameter))
return (cadr setting)))
(define-obsolete-function-alias 'rcirc-format-strike-trough
'rcirc-format-strike-through "30.1")
(define-obsolete-function-alias 'rcirc-condition-filter #'seq-filter "30.1")
(provide 'rcirc)
;;; rcirc.el ends here
|