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
| | ;;; ffap.el --- find file (or url) at point
;; Copyright (C) 1995-1997, 2000-2017 Free Software Foundation, Inc.
;; Author: Michelangelo Grigni <mic@mathcs.emory.edu>
;; Maintainer: emacs-devel@gnu.org
;; Created: 29 Mar 1993
;; Keywords: files, hypermedia, matching, mouse, convenience
;; X-URL: ftp://ftp.mathcs.emory.edu/pub/mic/emacs/
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
\f
;;; Commentary:
;;
;; Command find-file-at-point replaces find-file. With a prefix, it
;; behaves exactly like find-file. Without a prefix, it first tries
;; to guess a default file or URL from the text around the point
;; (`ffap-require-prefix' swaps these behaviors). This is useful for
;; following references in situations such as mail or news buffers,
;; README's, MANIFEST's, and so on. Submit bugs or suggestions with
;; M-x report-emacs-bug.
;;
;; For the default installation, add this line to your init file:
;;
;; (ffap-bindings) ; do default key bindings
;;
;; ffap-bindings makes the following global key bindings:
;;
;; C-x C-f find-file-at-point (abbreviated as ffap)
;; C-x C-r ffap-read-only
;; C-x C-v ffap-alternate-file
;;
;; C-x d dired-at-point
;; C-x C-d ffap-list-directory
;;
;; C-x 4 f ffap-other-window
;; C-x 4 r ffap-read-only-other-window
;; C-x 4 d ffap-dired-other-window
;;
;; C-x 5 f ffap-other-frame
;; C-x 5 r ffap-read-only-other-frame
;; C-x 5 d ffap-dired-other-frame
;;
;; S-mouse-3 ffap-at-mouse
;; C-S-mouse-3 ffap-menu
;;
;; ffap-bindings also adds hooks to make the following local bindings
;; in vm, gnus, and rmail:
;;
;; M-l ffap-next, or ffap-gnus-next in gnus (l == "link")
;; M-m ffap-menu, or ffap-gnus-menu in gnus (m == "menu")
;;
;; If you do not like these bindings, modify the variable
;; `ffap-bindings', or write your own.
;;
;; If you use ange-ftp, browse-url, complete, efs, or w3, it is best
;; to load or autoload them before ffap. If you use ff-paths, load it
;; afterwards. Try apropos {C-h a ffap RET} to get a list of the many
;; option variables. In particular, if ffap is slow, try these:
;;
;; (setq ffap-alist nil) ; faster, dumber prompting
;; (setq ffap-machine-p-known 'accept) ; no pinging
;; (setq ffap-url-regexp nil) ; disable URL features in ffap
;; (setq ffap-shell-prompt-regexp nil) ; disable shell prompt stripping
;;
;; ffap uses `browse-url' (if found, else `w3-fetch') to fetch URL's.
;; For a hairier `ffap-url-fetcher', try ffap-url.el (same ftp site).
;; Also, you can add `ffap-menu-rescan' to various hooks to fontify
;; the file and URL references within a buffer.
\f
;;; Change Log:
;;
;; The History and Contributors moved to ffap.LOG (same ftp site),
;; which also has some old examples and commentary from ffap 1.5.
\f
;;; Todo list:
;; * let "/dir/file#key" jump to key (tag or regexp) in /dir/file
;; * find file of symbol if TAGS is loaded (like above)
;; * break long menus into multiple panes (like imenu?)
;; * notice node in "(dired)Virtual Dired" (quotes, parentheses, whitespace)
;; * notice "machine.dom blah blah blah dir/file" (how?)
;; * as w3 becomes standard, rewrite to rely more on its functions
;; * regexp options for ffap-string-at-point, like font-lock (MCOOK)
;; * v19: could replace `ffap-locate-file' with a quieter `locate-library'
;; * handle "$(VAR)" in Makefiles
;; * use the font-lock machinery
\f
;;; Code:
(require 'url-parse)
(require 'thingatpt)
(define-obsolete-variable-alias 'ffap-version 'emacs-version "23.2")
(defgroup ffap nil
"Find file or URL at point."
;; Dead 2009/07/05.
;; :link '(url-link :tag "URL" "ftp://ftp.mathcs.emory.edu/pub/mic/emacs/")
:group 'matching
:group 'convenience)
;; The code is organized in pages, separated by formfeed characters.
;; See the next two pages for standard customization ideas.
\f
;;; User Variables:
(defun ffap-symbol-value (sym &optional default)
"Return value of symbol SYM, if bound, or DEFAULT otherwise."
(if (boundp sym) (symbol-value sym) default))
(defcustom ffap-shell-prompt-regexp
;; This used to test for some shell prompts that don't have a space
;; after them. The common root shell prompt (#) is not listed since it
;; also doubles up as a valid URL character.
"[$%><]*"
"Paths matching this regexp are stripped off the shell prompt.
If nil, ffap doesn't do shell prompt stripping."
:type '(choice (const :tag "Disable" nil)
(const :tag "Standard" "[$%><]*")
regexp)
:group 'ffap)
(defcustom ffap-ftp-regexp "\\`/[^/:]+:"
"File names matching this regexp are treated as remote ffap.
If nil, ffap neither recognizes nor generates such names."
:type '(choice (const :tag "Disable" nil)
(const :tag "Standard" "\\`/[^/:]+:")
regexp)
:group 'ffap)
(defcustom ffap-url-unwrap-local t
"If non-nil, convert some URLs to local file names before prompting.
Only \"file:\" and \"ftp:\" URLs are converted, and only if they
do not specify a host, or the host is either \"localhost\" or
equal to `system-name'."
:type 'boolean
:group 'ffap)
(defcustom ffap-url-unwrap-remote '("ftp")
"If non-nil, convert URLs to remote file names before prompting.
If the value is a list of strings, that specifies a list of URL
schemes (e.g. \"ftp\"); in that case, only convert those URLs."
:type '(choice (repeat string) boolean)
:group 'ffap
:version "24.3")
(defcustom ffap-lax-url t
"If non-nil, allow lax URL matching.
The default non-nil value might produce false URLs in C++ code
with symbols like \"std::find\". On the other hand, setting
this to nil will disable recognition of URLs that are not
well-formed, such as \"user@host\" or \"<user@host>\"."
:type 'boolean
:group 'ffap
:version "25.1")
(defcustom ffap-ftp-default-user "anonymous"
"User name in FTP file names generated by `ffap-host-to-path'.
Note this name may be omitted if it equals the default
\(either `efs-default-user' or `ange-ftp-default-user')."
:type 'string
:group 'ffap)
(defcustom ffap-rfs-regexp
;; Remote file access built into file system? HP rfa or Andrew afs:
"\\`/\\(afs\\|net\\)/."
;; afs only: (and (file-exists-p "/afs") "\\`/afs/.")
"Matching file names are treated as remote. Use nil to disable."
:type 'regexp
:group 'ffap)
(defvar ffap-url-regexp
(concat
"\\("
"news\\(post\\)?:\\|mailto:\\|file:" ; no host ok
"\\|"
"\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host
"\\)")
"Regexp matching the beginning of a URI, for ffap.
If the value is nil, disable URL-matching features in ffap.")
(defcustom ffap-foo-at-bar-prefix "mailto"
"Presumed URL prefix type of strings like \"<foo.9z@bar>\".
Sensible values are nil, \"news\", or \"mailto\"."
:type '(choice (const "mailto")
(const "news")
(const :tag "Disable" nil)
;; string -- possible, but not really useful
)
:group 'ffap)
\f
;;; Peanut Gallery (More User Variables):
;;
;; Users of ffap occasionally suggest new features. If I consider
;; those features interesting but not clear winners (a matter of
;; personal taste) I try to leave options to enable them. Read
;; through this section for features that you like, put an appropriate
;; enabler in your init file.
(defcustom ffap-dired-wildcards "[*?][^/]*\\'"
"A regexp matching filename wildcard characters, or nil.
If `find-file-at-point' gets a filename matching this pattern,
and `ffap-pass-wildcards-to-dired' is nil, it passes it on to
`find-file' with non-nil WILDCARDS argument, which expands
wildcards and visits multiple files. To visit a file whose name
contains wildcard characters you can suppress wildcard expansion
by setting `find-file-wildcards'. If `find-file-at-point' gets a
filename matching this pattern and `ffap-pass-wildcards-to-dired'
is non-nil, it passes it on to `dired'.
If `dired-at-point' gets a filename matching this pattern,
it passes it on to `dired'."
:type '(choice (const :tag "Disable" nil)
(const :tag "Enable" "[*?][^/]*\\'")
;; regexp -- probably not useful
)
:group 'ffap)
(defcustom ffap-pass-wildcards-to-dired nil
"If non-nil, pass filenames matching `ffap-dired-wildcards' to Dired."
:type 'boolean
:group 'ffap)
(defcustom ffap-newfile-prompt nil
;; Suggestion from RHOGEE, 11 Jul 1994. Disabled, I think this is
;; better handled by `find-file-not-found-hooks'.
"Whether `find-file-at-point' prompts about a nonexistent file."
:type 'boolean
:group 'ffap)
(defcustom ffap-require-prefix nil
;; Suggestion from RHOGEE, 20 Oct 1994.
"If set, reverses the prefix argument to `find-file-at-point'.
This is nil so neophytes notice ffap. Experts may prefer to disable
ffap most of the time."
:type 'boolean
:group 'ffap)
(defcustom ffap-file-finder 'find-file
"The command called by `find-file-at-point' to find a file."
:type 'function
:group 'ffap
:risky t)
(defcustom ffap-directory-finder 'dired
"The command called by `dired-at-point' to find a directory."
:type 'function
:group 'ffap
:risky t)
(defcustom ffap-url-fetcher 'browse-url
"A function of one argument, called by ffap to fetch an URL.
For a fancy alternative, get `ffap-url.el'."
:type '(choice (const browse-url)
function)
:group 'ffap
:risky t)
(defcustom ffap-next-regexp
;; If you want ffap-next to find URL's only, try this:
;; (and ffap-url-regexp (string-match "\\\\`" ffap-url-regexp)
;; (concat "\\<" (substring ffap-url-regexp 2))))
;;
;; It pays to put a big fancy regexp here, since ffap-guesser is
;; much more time-consuming than regexp searching:
"[/:.~[:alpha:]]/\\|@[[:alpha:]][-[:alnum:]]*\\."
"Regular expression governing movements of `ffap-next'."
:type 'regexp
:group 'ffap)
(defcustom dired-at-point-require-prefix nil
"If non-nil, reverse the prefix argument to `dired-at-point'.
This is nil so neophytes notice ffap. Experts may prefer to
disable ffap most of the time."
:type 'boolean
:group 'ffap
:version "20.3")
\f
;;; Compatibility:
;;
;; This version of ffap supports only the Emacs it is distributed in.
;; See the ftp site for a more general version. The following
;; functions are necessary "leftovers" from the more general version.
(defun ffap-mouse-event () ; current mouse event, or nil
(and (listp last-nonmenu-event) last-nonmenu-event))
(defun ffap-event-buffer (event)
(window-buffer (car (event-start event))))
\f
;;; Find Next Thing in buffer (`ffap-next'):
;;
;; Original ffap-next-url (URL's only) from RPECK 30 Mar 1995. Since
;; then, broke it up into ffap-next-guess (noninteractive) and
;; ffap-next (a command). It now work on files as well as url's.
(defvar ffap-next-guess nil
"Last value returned by `ffap-next-guess'.")
(defvar ffap-string-at-point-region '(1 1)
"List (BEG END), last region returned by the function `ffap-string-at-point'.")
(defun ffap-next-guess (&optional back lim)
"Move point to next file or URL, and return it as a string.
If nothing is found, leave point at limit and return nil.
Optional BACK argument makes search backwards.
Optional LIM argument limits the search.
Only considers strings that match `ffap-next-regexp'."
(or lim (setq lim (if back (point-min) (point-max))))
(let (guess)
(while (not (or guess (eq (point) lim)))
(funcall (if back 're-search-backward 're-search-forward)
ffap-next-regexp lim 'move)
(setq guess (ffap-guesser)))
;; Go to end, so we do not get same guess twice:
(goto-char (nth (if back 0 1) ffap-string-at-point-region))
(setq ffap-next-guess guess)))
;;;###autoload
(defun ffap-next (&optional back wrap)
"Search buffer for next file or URL, and run ffap.
Optional argument BACK says to search backwards.
Optional argument WRAP says to try wrapping around if necessary.
Interactively: use a single prefix \\[universal-argument] to search backwards,
double prefix to wrap forward, triple to wrap backwards.
Actual search is done by the function `ffap-next-guess'."
(interactive
(cdr (assq (prefix-numeric-value current-prefix-arg)
'((1) (4 t) (16 nil t) (64 t t)))))
(let ((pt (point))
(guess (ffap-next-guess back)))
;; Try wraparound if necessary:
(and (not guess) wrap
(goto-char (if back (point-max) (point-min)))
(setq guess (ffap-next-guess back pt)))
(if guess
(progn
(sit-for 0) ; display point movement
(find-file-at-point (ffap-prompter guess)))
(goto-char pt) ; restore point
(message "No %sfiles or URL's found"
(if wrap "" "more ")))))
(defun ffap-next-url (&optional back wrap)
"Like `ffap-next', but search with `ffap-url-regexp'."
(interactive)
(let ((ffap-next-regexp ffap-url-regexp))
(if (called-interactively-p 'interactive)
(call-interactively 'ffap-next)
(ffap-next back wrap))))
\f
;;; Machines (`ffap-machine-p'):
;; I cannot decide a "best" strategy here, so these are variables. In
;; particular, if `Pinging...' is broken or takes too long on your
;; machine, try setting these all to accept or reject.
(defcustom ffap-machine-p-local 'reject ; this happens often
"What `ffap-machine-p' does with hostnames that have no domain.
Value should be a symbol, one of `ping', `accept', and `reject'."
:type '(choice (const ping)
(const accept)
(const reject))
:group 'ffap)
(defcustom ffap-machine-p-known 'ping ; `accept' for higher speed
"What `ffap-machine-p' does with hostnames that have a known domain.
Value should be a symbol, one of `ping', `accept', and `reject'.
See `mail-extr.el' for the known domains."
:type '(choice (const ping)
(const accept)
(const reject))
:group 'ffap)
(defcustom ffap-machine-p-unknown 'reject
"What `ffap-machine-p' does with hostnames that have an unknown domain.
Value should be a symbol, one of `ping', `accept', and `reject'.
See `mail-extr.el' for the known domains."
:type '(choice (const ping)
(const accept)
(const reject))
:group 'ffap)
(defun ffap-what-domain (domain)
;; Like what-domain in mail-extr.el, returns string or nil.
(require 'mail-extr)
(let ((ob (or (ffap-symbol-value 'mail-extr-all-top-level-domains)
(ffap-symbol-value 'all-top-level-domains)))) ; XEmacs
(and ob (get (intern-soft (downcase domain) ob) 'domain-name))))
(defun ffap-machine-p (host &optional service quiet strategy)
"Decide whether HOST is the name of a real, reachable machine.
Depending on the domain (none, known, or unknown), follow the strategy
named by the variable `ffap-machine-p-local', `ffap-machine-p-known',
or `ffap-machine-p-unknown'. Pinging uses `open-network-stream'.
Optional SERVICE specifies the port used (default \"discard\").
Optional QUIET flag suppresses the \"Pinging...\" message.
Optional STRATEGY overrides the three variables above.
Returned values:
t means that HOST answered.
`accept' means the relevant variable told us to accept.
\"mesg\" means HOST exists, but does not respond for some reason."
;; Try some (Emory local):
;; (ffap-machine-p "ftp" nil nil 'ping)
;; (ffap-machine-p "nonesuch" nil nil 'ping)
;; (ffap-machine-p "ftp.mathcs.emory.edu" nil nil 'ping)
;; (ffap-machine-p "mathcs" 5678 nil 'ping)
;; (ffap-machine-p "foo.bonk" nil nil 'ping)
;; (ffap-machine-p "foo.bonk.com" nil nil 'ping)
(if (or (string-match "[^-[:alnum:].]" host) ; Invalid chars (?)
(not (string-match "[^0-9]" host))) ; 1: a number? 2: quick reject
nil
(let* ((domain
(and (string-match "\\.[^.]*$" host)
(downcase (substring host (1+ (match-beginning 0))))))
(what-domain (if domain (ffap-what-domain domain) "Local")))
(or strategy
(setq strategy
(cond ((not domain) ffap-machine-p-local)
((not what-domain) ffap-machine-p-unknown)
(t ffap-machine-p-known))))
(cond
((eq strategy 'accept) 'accept)
((eq strategy 'reject) nil)
((not (fboundp 'open-network-stream)) nil)
;; assume (eq strategy 'ping)
(t
(or quiet
(if (stringp what-domain)
(message "Pinging %s (%s)..." host what-domain)
(message "Pinging %s ..." host)))
(condition-case error
(progn
(delete-process
(open-network-stream
"ffap-machine-p" nil host (or service "discard")))
t)
(error
(let ((mesg (car (cdr error))))
(cond
;; v18:
((string-match "\\(^Unknown host\\|Name or service not known$\\)"
mesg) nil)
((string-match "not responding$" mesg) mesg)
;; v19:
;; (file-error "connection failed" "permission denied"
;; "nonesuch" "ffap-machine-p")
;; (file-error "connection failed" "host is unreachable"
;; "gopher.house.gov" "ffap-machine-p")
;; (file-error "connection failed" "address already in use"
;; "ftp.uu.net" "ffap-machine-p")
((equal mesg "connection failed")
(if (string= (downcase (nth 2 error)) "permission denied")
nil ; host does not exist
;; Other errors mean the host exists:
(nth 2 error)))
;; Could be "Unknown service":
(t (signal (car error) (cdr error))))))))))))
\f
;;; Possibly Remote Resources:
(defun ffap-replace-file-component (fullname name)
"In remote FULLNAME, replace path with NAME. May return nil."
;; Use efs if loaded, but do not load it otherwise.
(if (fboundp 'efs-replace-path-component)
(funcall 'efs-replace-path-component fullname name)
(and (stringp fullname)
(stringp name)
(concat (file-remote-p fullname) name))))
;; (ffap-replace-file-component "/who@foo.com:/whatever" "/new")
(defun ffap-file-suffix (file)
"Return trailing `.foo' suffix of FILE, or nil if none."
(let ((pos (string-match "\\.[^./]*\\'" file)))
(and pos (substring file pos nil))))
(defvar ffap-compression-suffixes '(".gz" ".Z") ; .z is mostly dead
"List of suffixes tried by `ffap-file-exists-string'.")
(defun ffap-file-exists-string (file &optional nomodify)
;; Early jka-compr versions modified file-exists-p to return the
;; filename, maybe modified by adding a suffix like ".gz". That
;; broke the interface of file-exists-p, so it was later dropped.
;; Here we document and simulate the old behavior.
"Return FILE (maybe modified) if the file exists, else nil.
When using jka-compr (a.k.a. `auto-compression-mode'), the returned
name may have a suffix added from `ffap-compression-suffixes'.
The optional NOMODIFY argument suppresses the extra search."
(cond
((not file) nil) ; quietly reject nil
((file-exists-p file) file) ; try unmodified first
;; three reasons to suppress search:
(nomodify nil)
((not (rassq 'jka-compr-handler file-name-handler-alist)) nil)
((member (ffap-file-suffix file) ffap-compression-suffixes) nil)
(t ; ok, do the search
(let ((list ffap-compression-suffixes) try ret)
(while list
(if (file-exists-p (setq try (concat file (car list))))
(setq ret try list nil)
(setq list (cdr list))))
ret))))
(defun ffap-file-remote-p (filename)
"If FILENAME looks remote, return it (maybe slightly improved)."
;; (ffap-file-remote-p "/user@foo.bar.com:/pub")
;; (ffap-file-remote-p "/cssun.mathcs.emory.edu://dir")
;; (ffap-file-remote-p "/ffap.el:80")
(or (and ffap-ftp-regexp
(string-match ffap-ftp-regexp filename)
;; Convert "/host.com://dir" to "/host:/dir", to handle a dying
;; practice of advertising ftp files as "host.dom://filename".
(if (string-match "//" filename)
;; (replace-match "/" nil nil filename)
(concat (substring filename 0 (1+ (match-beginning 0)))
(substring filename (match-end 0)))
filename))
(and ffap-rfs-regexp
(string-match ffap-rfs-regexp filename)
filename)))
(defun ffap-machine-at-point ()
"Return machine name at point if it exists, or nil."
(let ((mach (ffap-string-at-point 'machine)))
(and (ffap-machine-p mach) mach)))
(defsubst ffap-host-to-filename (host)
"Convert HOST to something like \"/USER@HOST:\" or \"/HOST:\".
Looks at `ffap-ftp-default-user', returns \"\" for \"localhost\"."
(if (equal host "localhost")
""
(let ((user ffap-ftp-default-user))
;; Avoid including the user if it is same as default:
(if (or (equal user (ffap-symbol-value 'ange-ftp-default-user))
(equal user (ffap-symbol-value 'efs-default-user)))
(setq user nil))
(concat "/" user (and user "@") host ":"))))
(defun ffap-fixup-machine (mach)
;; Convert a hostname into an url, an ftp file name, or nil.
(cond
((not (and ffap-url-regexp (stringp mach))) nil)
;; gopher.well.com
((string-match "\\`gopher[-.]" mach) ; or "info"?
(concat "gopher://" mach "/"))
;; www.ncsa.uiuc.edu
((and (string-match "\\`w\\(ww\\|eb\\)[-.]" mach))
(concat "http://" mach "/"))
;; More cases? Maybe "telnet:" for archie?
(ffap-ftp-regexp (ffap-host-to-filename mach))
))
(defvaralias 'ffap-newsgroup-regexp 'thing-at-point-newsgroup-regexp)
(defvaralias 'ffap-newsgroup-heads 'thing-at-point-newsgroup-heads)
(defalias 'ffap-newsgroup-p 'thing-at-point-newsgroup-p)
(defsubst ffap-url-p (string)
"If STRING looks like an URL, return it (maybe improved), else nil."
(when (and (stringp string) ffap-url-regexp)
(let* ((case-fold-search t)
(match (string-match ffap-url-regexp string)))
(cond ((eq match 0) string)
(match (substring string match))))))
;; Broke these out of ffap-fixup-url, for use of ffap-url package.
(defun ffap-url-unwrap-local (url)
"Return URL as a local file name, or nil."
(let* ((obj (url-generic-parse-url url))
(host (url-host obj))
(filename (car (url-path-and-query obj))))
(when (and (member (url-type obj) '("ftp" "file"))
(member host `("" "localhost" ,(system-name))))
;; On Windows, "file:///C:/foo" should unwrap to "C:/foo"
(if (and (memq system-type '(ms-dos windows-nt cygwin))
(string-match "\\`/[a-zA-Z]:" filename))
(substring filename 1)
filename))))
(defun ffap-url-unwrap-remote (url)
"Return URL as a remote file name, or nil."
(let* ((obj (url-generic-parse-url url))
(scheme (url-type obj))
(valid-schemes (if (listp ffap-url-unwrap-remote)
ffap-url-unwrap-remote
'("ftp")))
(host (url-host obj))
(port (url-port-if-non-default obj))
(user (url-user obj))
(filename (car (url-path-and-query obj))))
(when (and (member scheme valid-schemes)
(string-match "\\`[a-zA-Z][-a-zA-Z0-9+.]*\\'" scheme)
(not (equal host "")))
(concat "/" scheme ":"
(if user (concat user "@"))
host
(if port (concat "#" (number-to-string port)))
":" filename))))
(defun ffap-fixup-url (url)
"Clean up URL and return it, maybe as a file name."
(cond
((not (stringp url)) nil)
((and ffap-url-unwrap-local (ffap-url-unwrap-local url)))
((and ffap-url-unwrap-remote (ffap-url-unwrap-remote url)))
(url)))
\f
;;; File Name Handling:
;;
;; The upcoming ffap-alist actions need various utilities to prepare
;; and search directories. Too many features here.
;; (defun ffap-last (l) (while (cdr l) (setq l (cdr l))) l)
;; (defun ffap-splice (func inlist)
;; "Equivalent to (apply 'nconc (mapcar FUNC INLIST)), but less consing."
;; (let* ((head (cons 17 nil)) (last head))
;; (while inlist
;; (setcdr last (funcall func (car inlist)))
;; (setq last (ffap-last last) inlist (cdr inlist)))
;; (cdr head)))
(defun ffap-list-env (env &optional empty)
"Return a list of strings parsed from environment variable ENV.
Optional EMPTY is the default list if (getenv ENV) is undefined, and
also is substituted for the first empty-string component, if there is one.
Uses `path-separator' to separate the path into substrings."
;; We cannot use parse-colon-path (files.el), since it kills
;; "//" entries using file-name-as-directory.
;; Similar: dired-split, TeX-split-string, and RHOGEE's psg-list-env
;; in ff-paths and bib-cite. The EMPTY arg may help mimic kpathsea.
(if (or empty (getenv env)) ; should return something
(let ((start 0) match dir ret)
(setq env (concat (getenv env) path-separator))
(while (setq match (string-match path-separator env start))
(setq dir (substring env start match) start (1+ match))
;;(and (file-directory-p dir) (not (member dir ret)) ...)
(setq ret (cons dir ret)))
(setq ret (nreverse ret))
(and empty (setq match (member "" ret))
(progn ; allow string or list here
(setcdr match (append (cdr-safe empty) (cdr match)))
(setcar match (or (car-safe empty) empty))))
ret)))
(defun ffap-reduce-path (path)
"Remove duplicates and non-directories from PATH list."
(let (ret tem)
(while path
(setq tem path path (cdr path))
(if (equal (car tem) ".") (setcar tem ""))
(or (member (car tem) ret)
(not (file-directory-p (car tem)))
(progn (setcdr tem ret) (setq ret tem))))
(nreverse ret)))
(defun ffap-all-subdirs (dir &optional depth)
"Return list of all subdirectories under DIR, starting with itself.
Directories beginning with \".\" are ignored, and directory symlinks
are listed but never searched (to avoid loops).
Optional DEPTH limits search depth."
(and (file-exists-p dir)
(ffap-all-subdirs-loop (expand-file-name dir) (or depth -1))))
(defun ffap-all-subdirs-loop (dir depth) ; internal
(setq depth (1- depth))
(cons dir
(and (not (eq depth -1))
(apply 'nconc
(mapcar
(function
(lambda (d)
(cond
((not (file-directory-p d)) nil)
((file-symlink-p d) (list d))
(t (ffap-all-subdirs-loop d depth)))))
(directory-files dir t "\\`[^.]")
)))))
(defvar ffap-kpathsea-depth 1
"Bound on depth of subdirectory search in `ffap-kpathsea-expand-path'.
Set to 0 to avoid all searching, or nil for no limit.")
(defun ffap-kpathsea-expand-path (path)
"Replace each \"//\"-suffixed dir in PATH by a list of its subdirs.
The subdirs begin with the original directory, and the depth of the
search is bounded by `ffap-kpathsea-depth'. This is intended to mimic
kpathsea, a library used by some versions of TeX."
(apply 'nconc
(mapcar
(function
(lambda (dir)
(if (string-match "[^/]//\\'" dir)
(ffap-all-subdirs (substring dir 0 -2) ffap-kpathsea-depth)
(list dir))))
path)))
(defun ffap-locate-file (file nosuffix path)
;; The current version of locate-library could almost replace this,
;; except it does not let us override the suffix list. The
;; compression-suffixes search moved to ffap-file-exists-string.
"A generic path-searching function.
Returns the name of file in PATH, or nil.
Optional NOSUFFIX, if nil or t, is like the fourth argument
for `load': whether to try the suffixes (\".elc\" \".el\" \"\").
If a nonempty list, it is a list of suffixes to try instead.
PATH is a list of directories.
This uses `ffap-file-exists-string', which may try adding suffixes from
`ffap-compression-suffixes'."
(if (file-name-absolute-p file)
(setq path (list (file-name-directory file))
file (file-name-nondirectory file)))
(let ((dir-ok (equal "" (file-name-nondirectory file)))
(suffixes-to-try
(cond
((consp nosuffix) nosuffix)
(nosuffix '(""))
(t '(".elc" ".el" ""))))
suffixes try found)
(while path
(setq suffixes suffixes-to-try)
(while suffixes
(setq try (ffap-file-exists-string
(expand-file-name
(concat file (car suffixes)) (car path))))
(if (and try (or dir-ok (not (file-directory-p try))))
(setq found try suffixes nil path nil)
(setq suffixes (cdr suffixes))))
(setq path (cdr path)))
found))
\f
;;; Action List (`ffap-alist'):
;;
;; These search actions depend on the major-mode or regexps matching
;; the current name. The little functions and their variables are
;; deferred to the next section, at some loss of "code locality". A
;; good example of featuritis. Trim this list for speed.
(defvar ffap-alist
'(
("" . ffap-completable) ; completion, slow on some systems
("\\.info\\'" . ffap-info) ; gzip.info
("\\`info/" . ffap-info-2) ; info/emacs
("\\`[-[:lower:]]+\\'" . ffap-info-3) ; (emacs)Top [only in the parentheses]
("\\.elc?\\'" . ffap-el) ; simple.el, simple.elc
(emacs-lisp-mode . ffap-el-mode) ; rmail, gnus, simple, custom
;; (lisp-interaction-mode . ffap-el-mode) ; maybe
(finder-mode . ffap-el-mode) ; type {C-h p} and try it
(help-mode . ffap-el-mode) ; maybe useful
(c++-mode . ffap-c++-mode) ; search ffap-c++-path
(cc-mode . ffap-c-mode) ; same
("\\.\\([chCH]\\|cc\\|hh\\)\\'" . ffap-c-mode) ; stdio.h
(fortran-mode . ffap-fortran-mode) ; FORTRAN requested by MDB
("\\.[fF]\\'" . ffap-fortran-mode)
(tex-mode . ffap-tex-mode) ; search ffap-tex-path
(latex-mode . ffap-latex-mode) ; similar
("\\.\\(tex\\|sty\\|doc\\|cls\\)\\'" . ffap-tex)
("\\.bib\\'" . ffap-bib) ; search ffap-bib-path
("\\`\\." . ffap-home) ; .emacs, .bashrc, .profile
("\\`~/" . ffap-lcd) ; |~/misc/ffap.el.Z|
;; This used to have a blank, but ffap-string-at-point doesn't
;; handle blanks.
;; http://lists.gnu.org/archive/html/emacs-devel/2008-01/msg01058.html
("\\`[Rr][Ff][Cc][-#]?\\([0-9]+\\)" ; no $
. ffap-rfc) ; "100% RFC2100 compliant"
(dired-mode . ffap-dired) ; maybe in a subdirectory
)
"Alist of (KEY . FUNCTION) pairs parsed by `ffap-file-at-point'.
If string NAME at point (maybe \"\") is not a file or URL, these pairs
specify actions to try creating such a string. A pair matches if either
KEY is a symbol, and it equals `major-mode', or
KEY is a string, it should match NAME as a regexp.
On a match, (FUNCTION NAME) is called and should return a file, an
URL, or nil. If nil, search the alist for further matches.
While calling FUNCTION, the match data is set according to KEY if KEY
is a string, so that FUNCTION can use `match-string' and friends
to extract substrings.")
(put 'ffap-alist 'risky-local-variable t)
;; Example `ffap-alist' modifications:
;;
;; (setq ffap-alist ; remove a feature in `ffap-alist'
;; (delete (assoc 'c-mode ffap-alist) ffap-alist))
;;
;; (setq ffap-alist ; add something to `ffap-alist'
;; (cons
;; (cons "^YSN[0-9]+$"
;; (defun ffap-ysn (name)
;; (concat
;; "http://www.physics.uiuc.edu/"
;; "ysn/httpd/htdocs/ysnarchive/issuefiles/"
;; (substring name 3) ".html")))
;; ffap-alist))
\f
;;; Action Definitions:
;;
;; Define various default members of `ffap-alist'.
(defun ffap-completable (name)
(let* ((dir (or (file-name-directory name) default-directory))
(cmp (file-name-completion (file-name-nondirectory name) dir)))
(and cmp (concat dir cmp))))
(defun ffap-home (name) (ffap-locate-file name t '("~")))
(defun ffap-info (name)
(ffap-locate-file
name '("" ".info")
(or (ffap-symbol-value 'Info-directory-list)
(ffap-symbol-value 'Info-default-directory-list)
)))
(defun ffap-info-2 (name) (ffap-info (substring name 5)))
(defun ffap-info-3 (name)
;; This ignores the node! "(emacs)Top" same as "(emacs)Intro"
(and (equal (ffap-string-around) "()") (ffap-info name)))
(defun ffap-el (name) (ffap-locate-file name t load-path))
(defun ffap-el-mode (name)
;; If name == "foo.el" we will skip it, since ffap-el already
;; searched for it once. (This assumes the default ffap-alist.)
(and (not (string-match "\\.el\\'" name))
(ffap-locate-file name '(".el") load-path)))
;; FIXME this duplicates the logic of Man-header-file-path.
;; There should be a single central variable or function for this.
;; See also (bug#10702):
;; cc-search-directories, semantic-c-dependency-system-include-path,
;; semantic-gcc-setup
(defvar ffap-c-path
(let ((arch (with-temp-buffer
(when (eq 0 (ignore-errors
(call-process "gcc" nil '(t nil) nil
"-print-multiarch")))
(goto-char (point-min))
(buffer-substring (point) (line-end-position)))))
(base '("/usr/include" "/usr/local/include")))
(if (zerop (length arch))
base
(append base (list (expand-file-name arch "/usr/include")))))
"List of directories to search for include files.")
(defun ffap-c-mode (name)
(ffap-locate-file name t ffap-c-path))
(defvar ffap-c++-path
(let ((c++-include-dir (with-temp-buffer
(when (eq 0 (ignore-errors
(call-process "g++" nil t nil "-v")))
(goto-char (point-min))
(if (re-search-forward "--with-gxx-include-dir=\
\\([^[:space:]]+\\)"
nil 'noerror)
(match-string 1)
(when (re-search-forward "gcc version \
\\([[:digit:]]+.[[:digit:]]+.[[:digit:]]+\\)"
nil 'noerror)
(expand-file-name (match-string 1)
"/usr/include/c++/")))))))
(if c++-include-dir
(cons c++-include-dir ffap-c-path)
ffap-c-path))
"List of directories to search for include files.")
(defun ffap-c++-mode (name)
(ffap-locate-file name t ffap-c++-path))
(defvar ffap-fortran-path '("../include" "/usr/include"))
(defun ffap-fortran-mode (name)
(ffap-locate-file name t ffap-fortran-path))
(defvar ffap-tex-path
t ; delayed initialization
"Path where `ffap-tex-mode' looks for TeX files.
If t, `ffap-tex-init' will initialize this when needed.")
(defvar ffap-latex-guess-rules '(("" . ".sty")
("" . ".cls")
("" . ".ltx")
("" . ".tex")
("" . "") ;; in some rare cases the
;; extension is already in
;; the buffer.
("beamertheme" . ".sty")
("beamercolortheme". ".sty")
("beamerfonttheme". ".sty")
("beamerinnertheme". ".sty")
("beameroutertheme". ".sty")
("" . ".ldf"))
"List of rules for guessing a filename.
Each rule is a cons (PREFIX . SUFFIX) used for guessing a
filename from the word at point by prepending PREFIX and
appending SUFFIX.")
(defun ffap-tex-init ()
;; Compute ffap-tex-path if it is now t.
(and (eq t ffap-tex-path)
;; this may be slow, so say something
(message "Initializing ffap-tex-path ...")
(setq ffap-tex-path
(ffap-reduce-path
(cons
"."
(ffap-kpathsea-expand-path
(append
(ffap-list-env "TEXINPUTS")
;; (ffap-list-env "BIBINPUTS")
(ffap-symbol-value
'TeX-macro-global ; AUCTeX
'("/usr/local/lib/tex/macros"
"/usr/local/lib/tex/inputs")))))))))
(defun ffap-tex-mode (name)
(ffap-tex-init)
(ffap-locate-file name '(".tex" "") ffap-tex-path))
(defun ffap-latex-mode (name)
"`ffap' function suitable for latex buffers.
This uses the program kpsewhich if available. In this case, the
variable `ffap-latex-guess-rules' is used for building a filename
out of NAME."
(cond ((file-exists-p name)
name)
((not (executable-find "kpsewhich"))
(ffap-tex-init)
(ffap-locate-file name '(".cls" ".sty" ".tex" "") ffap-tex-path))
(t
(let ((curbuf (current-buffer))
(guess-rules ffap-latex-guess-rules)
(preferred-suffix-rules '(("input" . ".tex")
("include" . ".tex")
("usepackage" . ".sty")
("RequirePackageWithOptions" . ".sty")
("RequirePackage" . ".sty")
("documentclass" . ".cls")
("documentstyle" . ".cls")
("LoadClass" . ".cls")
("LoadClassWithOptions" . ".cls")
("bibliography" . ".bib")
("addbibresource" . ""))))
;; We now add preferred suffix in front of suffixes.
(when
;; The condition is essentially:
;; (assoc (TeX-current-macro)
;; (mapcar 'car preferred-suffix-rules))
;; but (TeX-current-macro) can take time, so we just
;; check if one of the `car' in preferred-suffix-rules
;; is found before point on the current line. It
;; should cover most cases.
(save-excursion
(re-search-backward (regexp-opt
(mapcar 'car preferred-suffix-rules))
(point-at-bol)
t))
(push (cons "" (cdr (assoc (match-string 0) ; i.e. "(TeX-current-macro)"
preferred-suffix-rules)))
guess-rules))
(with-temp-buffer
(let ((process-environment (buffer-local-value
'process-environment curbuf))
(exec-path (buffer-local-value 'exec-path curbuf)))
(apply #'call-process "kpsewhich" nil t nil
(mapcar (lambda (rule)
(concat (car rule) name (cdr rule)))
guess-rules)))
(when (< (point-min) (point-max))
(buffer-substring (goto-char (point-min)) (point-at-eol))))))))
(defun ffap-tex (name)
(ffap-tex-init)
(ffap-locate-file name t ffap-tex-path))
(defvar ffap-bib-path
(ffap-list-env "BIBINPUTS"
(ffap-reduce-path
'(
;; a few wild guesses, need better
"/usr/local/lib/tex/macros/bib" ; Solaris?
"/usr/lib/texmf/bibtex/bib" ; Linux?
))))
(defun ffap-bib (name)
(ffap-locate-file name t ffap-bib-path))
(defun ffap-dired (name)
(let ((pt (point)) try)
(save-excursion
(and (progn
(beginning-of-line)
(looking-at " *[-d]r[-w][-x][-r][-w][-x][-r][-w][-x] "))
(re-search-backward "^ *$" nil t)
(re-search-forward "^ *\\([^ \t\n:]*\\):\n *total " pt t)
(file-exists-p
(setq try
(expand-file-name
name
(buffer-substring
(match-beginning 1) (match-end 1)))))
try))))
;; Maybe a "Lisp Code Directory" reference:
(defun ffap-lcd (name)
;; FIXME: Is this still in use?
(and
(or
;; lisp-dir-apropos output buffer:
(string-match "Lisp Code Dir" (buffer-name))
;; Inside an LCD entry like |~/misc/ffap.el.Z|,
;; or maybe the holy LCD-Datafile itself:
(member (ffap-string-around) '("||" "|\n")))
(concat
;; lispdir.el may not be loaded yet:
(ffap-host-to-filename
(ffap-symbol-value 'elisp-archive-host
"archive.cis.ohio-state.edu"))
(file-name-as-directory
(ffap-symbol-value 'elisp-archive-directory
"/pub/gnu/emacs/elisp-archive/"))
(substring name 2))))
(defcustom ffap-rfc-path
(concat (ffap-host-to-filename "ftp.rfc-editor.org") "/in-notes/rfc%s.txt")
"A `format' string making a filename for RFC documents.
This can be an ange-ftp or Tramp remote filename to download, or
a local filename if you have full set of RFCs locally. See also
`ffap-rfc-directories'."
:type 'string
:version "23.1"
:group 'ffap)
(defcustom ffap-rfc-directories nil
"A list of directories to look for RFC files.
If a given RFC isn't in these then `ffap-rfc-path' is offered."
:type '(repeat directory)
:version "23.1"
:group 'ffap)
(defun ffap-rfc (name)
(let ((num (match-string 1 name)))
(or (ffap-locate-file (format "rfc%s.txt" num) t ffap-rfc-directories)
(format ffap-rfc-path num))))
\f
;;; At-Point Functions:
(defvar ffap-string-at-point-mode-alist
'(
;; The default, used when the `major-mode' is not found.
;; Slightly controversial decisions:
;; * strip trailing "@" and ":"
;; * no commas (good for latex)
(file "--:\\\\${}+<>@-Z_[:alpha:]~*?" "<@" "@>;.,!:")
;; An url, or maybe a email/news message-id:
(url "--:=&?$+@-Z_[:alpha:]~#,%;*()!'" "^[0-9a-zA-Z]" ":;.,!?")
;; Find a string that does *not* contain a colon:
(nocolon "--9$+<>@-Z_[:alpha:]~" "<@" "@>;.,!?")
;; A machine:
(machine "-[:alnum:]." "" ".")
;; Mathematica paths: allow backquotes
(math-mode ",-:$+<>@-Z_[:lower:]~`" "<" "@>;.,!?`:")
;; (La)TeX: don't allow braces
(latex-mode "--:\\\\$+<>@-Z_[:alpha:]~*?" "<@" "@>;.,!:")
(tex-mode "--:\\\\$+<>@-Z_[:alpha:]~*?" "<@" "@>;.,!:")
)
"Alist of (MODE CHARS BEG END), where MODE is a symbol,
possibly a major-mode name, or one of the symbols
`file', `url', `machine', and `nocolon'.
Function `ffap-string-at-point' uses the data fields as follows:
1. find a maximal string of CHARS around point,
2. strip BEG chars before point from the beginning,
3. strip END chars after point from the end.
The arguments CHARS, BEG and END are handled as described in
`skip-chars-forward'.")
(defvar ffap-string-at-point nil
;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95.
"Last string returned by the function `ffap-string-at-point'.")
(defun ffap-string-at-point (&optional mode)
"Return a string of characters from around point.
MODE (defaults to value of `major-mode') is a symbol used to look up
string syntax parameters in `ffap-string-at-point-mode-alist'.
If MODE is not found, we use `file' instead of MODE.
If the region is active, return a string from the region.
Sets the variable `ffap-string-at-point' and the variable
`ffap-string-at-point-region'."
(let* ((args
(cdr
(or (assq (or mode major-mode) ffap-string-at-point-mode-alist)
(assq 'file ffap-string-at-point-mode-alist))))
(pt (point))
(beg (if (use-region-p)
(region-beginning)
(save-excursion
(skip-chars-backward (car args))
(skip-chars-forward (nth 1 args) pt)
(point))))
(end (if (use-region-p)
(region-end)
(save-excursion
(skip-chars-forward (car args))
(skip-chars-backward (nth 2 args) pt)
(point)))))
(setq ffap-string-at-point
(buffer-substring-no-properties
(setcar ffap-string-at-point-region beg)
(setcar (cdr ffap-string-at-point-region) end)))))
(defun ffap-string-around ()
;; Sometimes useful to decide how to treat a string.
"Return string of two chars around last result of function
`ffap-string-at-point'.
Assumes the buffer has not changed."
(save-excursion
(format "%c%c"
(progn
(goto-char (car ffap-string-at-point-region))
(preceding-char)) ; maybe 0
(progn
(goto-char (nth 1 ffap-string-at-point-region))
(following-char)) ; maybe 0
)))
(defun ffap-copy-string-as-kill (&optional mode)
;; Requested by MCOOK. Useful?
"Call function `ffap-string-at-point', and copy result to `kill-ring'."
(interactive)
(let ((str (ffap-string-at-point mode)))
(if (equal "" str)
(message "No string found around point.")
(kill-new str)
;; Older: (apply 'copy-region-as-kill ffap-string-at-point-region)
(message "Copied to kill ring: %s" str))))
;; External.
(declare-function w3-view-this-url "ext:w3" (&optional no-show))
(defun ffap-url-at-point ()
"Return URL from around point if it exists, or nil.
Sets the variable `ffap-string-at-point-region' to the bounds of URL, if any."
(when ffap-url-regexp
(or (and (eq major-mode 'w3-mode) ; In a w3 buffer button?
(w3-view-this-url t))
(let ((thing-at-point-beginning-of-url-regexp ffap-url-regexp)
(thing-at-point-default-mail-uri-scheme ffap-foo-at-bar-prefix)
val)
(setq val (thing-at-point-url-at-point ffap-lax-url
(if (use-region-p)
(cons (region-beginning)
(region-end)))))
(if val
(let ((bounds (thing-at-point-bounds-of-url-at-point
ffap-lax-url)))
(setq ffap-string-at-point-region
(list (car bounds) (cdr bounds)))))
val))))
(defvar ffap-gopher-regexp
"^.*\\<\\(Type\\|Name\\|Path\\|Host\\|Port\\) *= *\\(.*\\) *$"
"Regexp matching a line in a gopher bookmark (maybe indented).
The two subexpressions are the KEY and VALUE.")
(defun ffap-gopher-at-point ()
"If point is inside a gopher bookmark block, return its URL.
Sets the variable `ffap-string-at-point-region' to the bounds of URL, if any."
;; `gopher-parse-bookmark' from gopher.el is not so robust
(save-excursion
(beginning-of-line)
(if (looking-at ffap-gopher-regexp)
(progn
(while (and (looking-at ffap-gopher-regexp) (not (bobp)))
(forward-line -1))
(or (looking-at ffap-gopher-regexp) (forward-line 1))
(setq ffap-string-at-point-region (list (point) (point)))
(let ((type "1") path host (port "70"))
(while (looking-at ffap-gopher-regexp)
(let ((var (intern
(downcase
(buffer-substring (match-beginning 1)
(match-end 1)))))
(val (buffer-substring (match-beginning 2)
(match-end 2))))
(set var val)
(forward-line 1)))
(setcdr ffap-string-at-point-region (list (point)))
(if (and path (string-match "^ftp:.*@" path))
(concat "ftp://"
(substring path 4 (1- (match-end 0)))
(substring path (match-end 0)))
(and (= (length type) 1)
host;; (ffap-machine-p host)
(concat "gopher://" host
(if (equal port "70") "" (concat ":" port))
"/" type path))))))))
(defvar ffap-ftp-sans-slash-regexp
(and
ffap-ftp-regexp
;; Note: by now, we know it is not an url.
;; Icky regexp avoids: default: 123: foo::bar cs:pub
;; It does match on: mic@cs: cs:/pub mathcs.emory.edu: (point at end)
"\\`\\([^:@]+@[^:@]+:\\|[^@.:]+\\.[^@:]+:\\|[^:]+:[~/]\\)\\([^:]\\|\\'\\)")
"Strings matching this are coerced to FTP file names by ffap.
That is, ffap just prepends \"/\". Set to nil to disable.")
(defun ffap-file-at-point ()
"Return filename from around point if it exists, or nil.
Existence test is skipped for names that look remote.
If the filename is not obvious, it also tries `ffap-alist',
which may actually result in an URL rather than a filename."
;; Note: this function does not need to look for url's, just
;; filenames. On the other hand, it is responsible for converting
;; a pseudo-url "site.com://dir" to an ftp file name
(let* ((case-fold-search t) ; url prefixes are case-insensitive
(data (match-data))
(string (ffap-string-at-point)) ; uses mode alist
(name
(or (condition-case nil
(and (not (string-match "//" string)) ; foo.com://bar
(substitute-in-file-name string))
(error nil))
string))
(abs (file-name-absolute-p name))
(default-directory default-directory)
(oname name))
(unwind-protect
(cond
;; Immediate rejects (/ and // and /* are too common in C/C++):
((member name '("" "/" "//" "/*" ".")) nil)
;; Immediately test local filenames. If default-directory is
;; remote, you probably already have a connection.
((and (not abs) (ffap-file-exists-string name)))
;; Try stripping off line numbers; good for compilation/grep output.
((and (not abs) (string-match ":[0-9]" name)
(ffap-file-exists-string (substring name 0 (match-beginning 0)))))
;; Try stripping off prominent (non-root - #) shell prompts
;; if the ffap-shell-prompt-regexp is non-nil.
((and ffap-shell-prompt-regexp
(not abs) (string-match ffap-shell-prompt-regexp name)
(ffap-file-exists-string (substring name (match-end 0)))))
;; Accept remote names without actual checking (too slow):
((and abs (ffap-file-remote-p name)))
;; Ok, not remote, try the existence test even if it is absolute:
((and abs (ffap-file-exists-string name)))
;; Try stripping off line numbers.
((and abs (string-match ":[0-9]" name)
(ffap-file-exists-string (substring name 0 (match-beginning 0)))))
;; If it contains a colon, get rid of it (and return if exists)
((and (string-match path-separator name)
(setq name (ffap-string-at-point 'nocolon))
(ffap-file-exists-string name)))
;; File does not exist, try the alist:
((let ((alist ffap-alist) tem try case-fold-search)
(while (and alist (not try))
(setq tem (car alist) alist (cdr alist))
(if (or (eq major-mode (car tem))
(and (stringp (car tem))
(string-match (car tem) name)))
(and (setq try
(condition-case nil
(funcall (cdr tem) name)
(error nil)))
(setq try (or
(ffap-url-p try) ; not a file!
(ffap-file-remote-p try)
(ffap-file-exists-string try))))))
try))
;; Try adding a leading "/" (common omission in ftp file names).
;; Note that this uses oname, which still has any colon part.
;; This should have a lower priority than the alist stuff,
;; else it matches things like "ffap.el:1234:56:Warning".
((and (not abs)
ffap-ftp-sans-slash-regexp
(string-match ffap-ftp-sans-slash-regexp oname)
(ffap-file-remote-p (concat "/" oname))))
;; Alist failed? Try to guess an active remote connection
;; from buffer variables, and try once more, both as an
;; absolute and relative file name on that remote host.
((let* (ffap-rfs-regexp ; suppress
(remote-dir
(cond
((ffap-file-remote-p default-directory))
((and (eq major-mode 'internal-ange-ftp-mode)
(string-match "^\\*ftp \\(.*\\)@\\(.*\\)\\*$"
(buffer-name)))
(concat "/" (substring (buffer-name) 5 -1) ":"))
;; This is too often a bad idea:
;;((and (eq major-mode 'w3-mode)
;; (stringp url-current-server))
;; (host-to-ange-path url-current-server))
)))
(and remote-dir
(or
(and (string-match "\\`\\(/?~?ftp\\)/" name)
(ffap-file-exists-string
(ffap-replace-file-component
remote-dir (substring name (match-end 1)))))
(ffap-file-exists-string
(ffap-replace-file-component remote-dir name))))))
((and ffap-dired-wildcards
(string-match ffap-dired-wildcards name)
abs
(ffap-file-exists-string (file-name-directory
(directory-file-name name)))
name))
;; Try all parent directories by deleting the trailing directory
;; name until existing directory is found or name stops changing
((let ((dir name))
(while (and dir
(not (ffap-file-exists-string dir))
(not (equal dir (setq dir (file-name-directory
(directory-file-name dir)))))))
(and (not (string= dir "/"))
(ffap-file-exists-string dir))))
)
(set-match-data data))))
\f
;;; Prompting (`ffap-read-file-or-url'):
;;
;; We want to complete filenames as in read-file-name, but also url's
;; which read-file-name-internal would truncate at the "//" string.
;; The solution here is to replace read-file-name-internal with
;; `ffap-read-file-or-url-internal', which checks the minibuffer
;; contents before attempting to complete filenames.
(defun ffap-read-file-or-url (prompt guess)
"Read file or URL from minibuffer, with PROMPT and initial GUESS."
(or guess (setq guess default-directory))
(let (dir)
;; Tricky: guess may have or be a local directory, like "w3/w3.elc"
;; or "w3/" or "../el/ffap.el" or "../../../"
(unless (ffap-url-p guess)
(unless (ffap-file-remote-p guess)
(setq guess
(abbreviate-file-name (expand-file-name guess))))
(setq dir (file-name-directory guess)))
(let ((minibuffer-completing-file-name t)
(completion-ignore-case read-file-name-completion-ignore-case)
(fnh-elem (cons ffap-url-regexp 'url-file-handler)))
;; Explain to `rfn-eshadow' that we can use URLs here.
(push fnh-elem file-name-handler-alist)
(unwind-protect
(setq guess
(let ((default-directory (if dir (expand-file-name dir)
default-directory)))
(completing-read
prompt
'ffap-read-file-or-url-internal
nil
nil
(if dir (cons guess (length dir)) guess)
'file-name-history
(and buffer-file-name
(abbreviate-file-name buffer-file-name)))))
;; Remove the special handler manually. We used to just let-bind
;; file-name-handler-alist to preserve its value, but that caused
;; other modifications to be lost (e.g. when Tramp gets loaded
;; during the completing-read call).
(setq file-name-handler-alist (delq fnh-elem file-name-handler-alist))))
(or (ffap-url-p guess)
(substitute-in-file-name guess))))
(defun ffap-read-url-internal (string pred action)
"Complete URLs from history, treating given string as valid."
(let ((hist (ffap-symbol-value 'url-global-history-hash-table)))
(cond
((not action)
(or (try-completion string hist pred) string))
((eq action t)
(or (all-completions string hist pred) (list string)))
;; action == lambda, documented where? Tests whether string is a
;; valid "match". Let us always say yes.
(t t))))
(defun ffap-read-file-or-url-internal (string pred action)
(let ((url (ffap-url-p string)))
(if url
(ffap-read-url-internal url pred action)
(read-file-name-internal (or string default-directory) pred action))))
;; The rest of this page is just to work with package complete.el.
;; This code assumes that you load ffap.el after complete.el.
;;
;; We must inform complete about whether our completion function
;; will do filename style completion.
\f
;;; Highlighting (`ffap-highlight'):
(defvar ffap-highlight t
"If non-nil, ffap highlights the current buffer substring.")
(defface ffap
'((t :inherit highlight))
"Face used to highlight the current buffer substring."
:group 'ffap
:version "22.1")
(defvar ffap-highlight-overlay nil
"Overlay used by function `ffap-highlight'.")
(defun ffap-highlight (&optional remove)
"If `ffap-highlight' is set, highlight the guess in this buffer.
That is, the last buffer substring found by `ffap-string-at-point'.
Optional argument REMOVE means to remove any such highlighting.
Uses the face `ffap' if it is defined, or else `highlight'."
(cond
(remove
(and ffap-highlight-overlay
(delete-overlay ffap-highlight-overlay))
)
((not ffap-highlight) nil)
(ffap-highlight-overlay
(move-overlay
ffap-highlight-overlay
(car ffap-string-at-point-region)
(nth 1 ffap-string-at-point-region)
(current-buffer)))
(t
(setq ffap-highlight-overlay
(apply 'make-overlay ffap-string-at-point-region))
(overlay-put ffap-highlight-overlay 'face 'ffap))))
\f
;;; Main Entrance (`find-file-at-point' == `ffap'):
(defun ffap-guesser ()
"Return file or URL or nil, guessed from text around point."
(or (and ffap-url-regexp
(ffap-fixup-url (or (ffap-url-at-point)
(ffap-gopher-at-point))))
(ffap-file-at-point) ; may yield url!
(ffap-fixup-machine (ffap-machine-at-point))))
(defun ffap-prompter (&optional guess)
;; Does guess and prompt step for find-file-at-point.
;; Extra complication for the temporary highlighting.
(unwind-protect
;; This catch will let ffap-alist entries do their own prompting
;; and then maybe skip over this prompt (ff-paths, for example).
(catch 'ffap-prompter
(ffap-read-file-or-url
(if ffap-url-regexp "Find file or URL: " "Find file: ")
(prog1
(let ((mark-active nil))
;; Don't use the region here, since it can be something
;; completely unwieldy. If the user wants that, she could
;; use M-w before and then C-y. --Stef
(setq guess (or guess (ffap-guesser)))) ; using ffap-alist here
(and guess (ffap-highlight))
)))
(ffap-highlight t)))
;;;###autoload
(defun find-file-at-point (&optional filename)
"Find FILENAME, guessing a default from text around point.
If `ffap-url-regexp' is not nil, the FILENAME may also be an URL.
With a prefix, this command behaves exactly like `ffap-file-finder'.
If `ffap-require-prefix' is set, the prefix meaning is reversed.
See also the variables `ffap-dired-wildcards', `ffap-newfile-prompt',
and the functions `ffap-file-at-point' and `ffap-url-at-point'."
(interactive)
(if (and (called-interactively-p 'interactive)
(if ffap-require-prefix (not current-prefix-arg)
current-prefix-arg))
;; Do exactly the ffap-file-finder command, even the prompting:
(let (current-prefix-arg) ; we already interpreted it
(call-interactively ffap-file-finder))
(or filename (setq filename (ffap-prompter)))
(let ((url (ffap-url-p filename)))
(cond
(url
(let (current-prefix-arg)
(funcall ffap-url-fetcher url)))
((and ffap-pass-wildcards-to-dired
ffap-dired-wildcards
(string-match ffap-dired-wildcards filename))
(funcall ffap-directory-finder filename))
((and ffap-dired-wildcards
(string-match ffap-dired-wildcards filename)
find-file-wildcards
;; Check if it's find-file that supports wildcards arg
(memq ffap-file-finder '(find-file find-alternate-file)))
(funcall ffap-file-finder (expand-file-name filename) t))
((or (not ffap-newfile-prompt)
(file-exists-p filename)
(y-or-n-p "File does not exist, create buffer? "))
(funcall ffap-file-finder
;; expand-file-name fixes "~/~/.emacs" bug sent by CHUCKR.
(expand-file-name filename)))
;; User does not want to find a non-existent file:
((signal 'file-error (list "Opening file buffer"
"No such file or directory"
filename)))))))
;; Shortcut: allow {M-x ffap} rather than {M-x find-file-at-point}.
;;;###autoload
(defalias 'ffap 'find-file-at-point)
\f
;;; Menu support (`ffap-menu'):
(defcustom ffap-menu-regexp nil
"If non-nil, regexp overriding `ffap-next-regexp' in `ffap-menu'.
Make this more restrictive for faster menu building.
For example, try \":/\" for URL (and some FTP) references."
:type '(choice (const nil) regexp)
:group 'ffap)
(defvar ffap-menu-alist nil
"Buffer local cache of menu presented by `ffap-menu'.")
(make-variable-buffer-local 'ffap-menu-alist)
(defvar ffap-menu-text-plist
(cond
((display-mouse-p) '(face bold mouse-face highlight)) ; keymap <mousy-map>
(t nil))
"Text properties applied to strings found by `ffap-menu-rescan'.
These properties may be used to fontify the menu references.")
;;;###autoload
(defun ffap-menu (&optional rescan)
"Put up a menu of files and URLs mentioned in this buffer.
Then set mark, jump to choice, and try to fetch it. The menu is
cached in `ffap-menu-alist', and rebuilt by `ffap-menu-rescan'.
The optional RESCAN argument (a prefix, interactively) forces
a rebuild. Searches with `ffap-menu-regexp'."
(interactive "P")
;; (require 'imenu) -- no longer used, but roughly emulated
(if (or (not ffap-menu-alist) rescan
;; or if the first entry is wrong:
(and ffap-menu-alist
(let ((first (car ffap-menu-alist)))
(save-excursion
(goto-char (cdr first))
(not (equal (car first) (ffap-guesser)))))))
(ffap-menu-rescan))
;; Tail recursive:
(ffap-menu-ask
(if ffap-url-regexp "Find file or URL" "Find file")
(cons (cons "*Rescan Buffer*" -1) ffap-menu-alist)
'ffap-menu-cont))
(defun ffap-menu-cont (choice) ; continuation of ffap-menu
(if (< (cdr choice) 0)
(ffap-menu t) ; *Rescan*
(push-mark)
(goto-char (cdr choice))
;; Momentary highlight:
(unwind-protect
(progn
(and ffap-highlight (ffap-guesser) (ffap-highlight))
(sit-for 0) ; display
(find-file-at-point (car choice)))
(ffap-highlight t))))
(defun ffap-menu-ask (title alist cont)
"Prompt from a menu of choices, and then apply some action.
Arguments are TITLE, ALIST, and CONT (a continuation function).
This uses either a menu or the minibuffer depending on invocation.
The TITLE string is used as either the prompt or menu title.
Each ALIST entry looks like (STRING . DATA) and defines one choice.
Function CONT is applied to the entry chosen by the user."
;; Note: this function is used with a different continuation
;; by the ffap-url add-on package.
;; Could try rewriting to use easymenu.el or lmenu.el.
(let (choice)
(cond
;; Emacs mouse:
((and (fboundp 'x-popup-menu) (ffap-mouse-event))
(setq choice
(x-popup-menu
t
(list "" (cons title
(mapcar (lambda (i) (cons (car i) i))
alist))))))
;; minibuffer with completion buffer:
(t
(let ((minibuffer-setup-hook 'minibuffer-completion-help))
;; Bug: prompting may assume unique strings, no "".
(setq choice
(completing-read
(format "%s (default %s): " title (car (car alist)))
alist nil t
;; (cons (car (car alist)) 0)
nil)))
(sit-for 0) ; redraw original screen
;; Convert string to its entry, or else the default:
(setq choice (or (assoc choice alist) (car alist)))))
(if choice
(funcall cont choice)
(message "No choice made!") ; possible with menus
nil)))
(defun ffap-menu-rescan ()
"Search buffer for `ffap-menu-regexp' to build `ffap-menu-alist'.
Applies `ffap-menu-text-plist' text properties at all matches."
(interactive)
(let ((ffap-next-regexp (or ffap-menu-regexp ffap-next-regexp))
(range (- (point-max) (point-min)))
(mod (buffer-modified-p)) ; was buffer modified?
;; inhibit-read-only works on read-only text properties
;; as well as read-only buffers.
(inhibit-read-only t) ; to set text-properties
item
;; Avoid repeated searches of the *mode-alist:
(major-mode (if (assq major-mode ffap-string-at-point-mode-alist)
major-mode
'file)))
(setq ffap-menu-alist nil)
(unwind-protect
(save-excursion
(goto-char (point-min))
(while (setq item (ffap-next-guess))
(setq ffap-menu-alist (cons (cons item (point)) ffap-menu-alist))
(add-text-properties (car ffap-string-at-point-region) (point)
ffap-menu-text-plist)
(message "Scanning...%2d%% <%s>"
(floor (* 100.0 (- (point) (point-min))) range) item)))
(or mod (restore-buffer-modified-p nil))))
(message "Scanning...done")
;; Remove duplicates.
(setq ffap-menu-alist ; sort by item
(sort ffap-menu-alist
(function
(lambda (a b) (string-lessp (car a) (car b))))))
(let ((ptr ffap-menu-alist)) ; remove duplicates
(while (cdr ptr)
(if (equal (car (car ptr)) (car (car (cdr ptr))))
(setcdr ptr (cdr (cdr ptr)))
(setq ptr (cdr ptr)))))
(setq ffap-menu-alist ; sort by position
(sort ffap-menu-alist
(function
(lambda (a b) (< (cdr a) (cdr b)))))))
\f
;;; Mouse Support (`ffap-at-mouse'):
;;
;; See the suggested binding in ffap-bindings (near eof).
(defvar ffap-at-mouse-fallback nil ; ffap-menu? too time-consuming
"Command invoked by `ffap-at-mouse' if nothing found at click, or nil.
Ignored when `ffap-at-mouse' is called programmatically.")
(put 'ffap-at-mouse-fallback 'risky-local-variable t)
;;;###autoload
(defun ffap-at-mouse (e)
"Find file or URL guessed from text around mouse click.
Interactively, calls `ffap-at-mouse-fallback' if no guess is found.
Return value:
* if a guess string is found, return it (after finding it)
* if the fallback is called, return whatever it returns
* otherwise, nil"
(interactive "e")
(let ((guess
;; Maybe less surprising without the save-excursion?
(save-excursion
(mouse-set-point e)
;; Would prefer to do nothing unless click was *on* text. How
;; to tell that the click was beyond the end of current line?
(ffap-guesser))))
(cond
(guess
(set-buffer (ffap-event-buffer e))
(ffap-highlight)
(unwind-protect
(progn
(sit-for 0) ; display
(message "Finding `%s'" guess)
(find-file-at-point guess)
guess) ; success: return non-nil
(ffap-highlight t)))
((called-interactively-p 'interactive)
(if ffap-at-mouse-fallback
(call-interactively ffap-at-mouse-fallback)
(message "No file or URL found at mouse click.")
nil)) ; no fallback, return nil
;; failure: return nil
)))
\f
;;; ffap-other-*, ffap-read-only-*, ffap-alternate-* commands:
;; There could be a real `ffap-noselect' function, but we would need
;; at least two new user variables, and there is no w3-fetch-noselect.
;; So instead, we just fake it with a slow save-window-excursion.
(defun ffap-other-window ()
"Like `ffap', but put buffer in another window.
Only intended for interactive use."
(interactive)
(let (value)
(switch-to-buffer-other-window
(save-window-excursion
(setq value (call-interactively 'ffap))
(unless (or (bufferp value) (bufferp (car-safe value)))
(setq value (current-buffer)))
(current-buffer)))
value))
(defun ffap-other-frame ()
"Like `ffap', but put buffer in another frame.
Only intended for interactive use."
(interactive)
;; Extra code works around dedicated windows (noted by JENS, 7/96):
(let* ((win (selected-window))
(wdp (window-dedicated-p win))
value)
(unwind-protect
(progn
(set-window-dedicated-p win nil)
(switch-to-buffer-other-frame
(save-window-excursion
(setq value (call-interactively 'ffap))
(unless (or (bufferp value) (bufferp (car-safe value)))
(setq value (current-buffer)))
(current-buffer))))
(set-window-dedicated-p win wdp))
value))
(defun ffap--toggle-read-only (buffer-or-list)
(dolist (buffer (if (listp buffer-or-list)
buffer-or-list
(list buffer-or-list)))
(with-current-buffer buffer
(read-only-mode 1))))
(defun ffap-read-only ()
"Like `ffap', but mark buffer as read-only.
Only intended for interactive use."
(interactive)
(let ((value (call-interactively 'ffap)))
(unless (or (bufferp value) (bufferp (car-safe value)))
(setq value (current-buffer)))
(ffap--toggle-read-only value)
value))
(defun ffap-read-only-other-window ()
"Like `ffap', but put buffer in another window and mark as read-only.
Only intended for interactive use."
(interactive)
(let ((value (ffap-other-window)))
(ffap--toggle-read-only value)
value))
(defun ffap-read-only-other-frame ()
"Like `ffap', but put buffer in another frame and mark as read-only.
Only intended for interactive use."
(interactive)
(let ((value (ffap-other-frame)))
(ffap--toggle-read-only value)
value))
(defun ffap-alternate-file ()
"Like `ffap' and `find-alternate-file'.
Only intended for interactive use."
(interactive)
(let ((ffap-file-finder 'find-alternate-file))
(call-interactively 'ffap)))
(defun ffap-alternate-file-other-window ()
"Like `ffap' and `find-alternate-file-other-window'.
Only intended for interactive use."
(interactive)
(let ((ffap-file-finder 'find-alternate-file-other-window))
(call-interactively 'ffap)))
(defun ffap-literally ()
"Like `ffap' and command `find-file-literally'.
Only intended for interactive use."
(interactive)
(let ((ffap-file-finder 'find-file-literally))
(call-interactively 'ffap)))
(defalias 'find-file-literally-at-point 'ffap-literally)
\f
;;; Bug Reporter:
(define-obsolete-function-alias 'ffap-bug 'report-emacs-bug "23.1")
(define-obsolete-function-alias 'ffap-submit-bug 'report-emacs-bug "23.1")
\f
;;; Hooks for Gnus, VM, Rmail:
;;
;; If you do not like these bindings, write versions with whatever
;; bindings you would prefer.
(defun ffap-ro-mode-hook ()
"Bind `ffap-next' and `ffap-menu' to M-l and M-m, resp."
(local-set-key "\M-l" 'ffap-next)
(local-set-key "\M-m" 'ffap-menu))
(defun ffap-gnus-hook ()
"Bind `ffap-gnus-next' and `ffap-gnus-menu' to M-l and M-m, resp."
;; message-id's
(setq-local thing-at-point-default-mail-uri-scheme "news")
;; Note "l", "L", "m", "M" are taken:
(local-set-key "\M-l" 'ffap-gnus-next)
(local-set-key "\M-m" 'ffap-gnus-menu))
(defvar gnus-summary-buffer)
(defvar gnus-article-buffer)
;; This code is called from gnus.
(declare-function gnus-summary-select-article "gnus-sum"
(&optional all-headers force pseudo article))
(declare-function gnus-configure-windows "gnus-win"
(setting &optional force))
(defun ffap-gnus-wrapper (form) ; used by both commands below
(and (eq (current-buffer) (get-buffer gnus-summary-buffer))
(gnus-summary-select-article)) ; get article of current line
;; Preserve selected buffer, but do not do save-window-excursion,
;; since we want to see any window created by the form. Temporarily
;; select the article buffer, so we can see any point movement.
(let ((sb (window-buffer)))
(gnus-configure-windows 'article)
(pop-to-buffer gnus-article-buffer)
(widen)
;; Skip headers for ffap-gnus-next (which will wrap around)
(if (eq (point) (point-min)) (search-forward "\n\n" nil t))
(unwind-protect
(eval form)
(pop-to-buffer sb))))
(defun ffap-gnus-next ()
"Run `ffap-next' in the gnus article buffer."
(interactive) (ffap-gnus-wrapper '(ffap-next nil t)))
(defun ffap-gnus-menu ()
"Run `ffap-menu' in the gnus article buffer."
(interactive) (ffap-gnus-wrapper '(ffap-menu)))
\f
;;;###autoload
(defun dired-at-point (&optional filename)
"Start Dired, defaulting to file at point. See `ffap'.
If `dired-at-point-require-prefix' is set, the prefix meaning is reversed."
(interactive)
(if (and (called-interactively-p 'interactive)
(if dired-at-point-require-prefix
(not current-prefix-arg)
current-prefix-arg))
(let (current-prefix-arg) ; already interpreted
(call-interactively ffap-directory-finder))
(or filename (setq filename (dired-at-point-prompter)))
(let ((url (ffap-url-p filename)))
(cond
(url
(funcall ffap-url-fetcher url))
((and ffap-dired-wildcards
(string-match ffap-dired-wildcards filename))
(funcall ffap-directory-finder filename))
((file-exists-p filename)
(if (file-directory-p filename)
(funcall ffap-directory-finder
(expand-file-name filename))
(funcall ffap-directory-finder
(concat (expand-file-name filename) "*"))))
((and (file-writable-p
(or (file-name-directory (directory-file-name filename))
filename))
(y-or-n-p "Directory does not exist, create it? "))
(make-directory filename)
(funcall ffap-directory-finder filename))
((error "No such file or directory `%s'" filename))))))
(defun dired-at-point-prompter (&optional guess)
;; Does guess and prompt step for find-file-at-point.
;; Extra complication for the temporary highlighting.
(unwind-protect
(ffap-read-file-or-url
(cond
((eq ffap-directory-finder 'list-directory)
"List directory (brief): ")
(ffap-url-regexp "Dired file or URL: ")
(t "Dired file: "))
(prog1
(setq guess
(let ((guess (or guess (ffap-guesser))))
(cond
((null guess) nil)
((ffap-url-p guess))
((ffap-file-remote-p guess)
guess)
((progn
(setq guess (abbreviate-file-name
(expand-file-name guess)))
;; Interpret local directory as a directory.
(file-directory-p guess))
(file-name-as-directory guess))
;; Get directory component from local files.
((file-regular-p guess)
(file-name-directory guess))
(guess))))
(and guess (ffap-highlight))))
(ffap-highlight t)))
\f
;;; ffap-dired-other-*, ffap-list-directory commands:
(defun ffap-dired-other-window ()
"Like `dired-at-point', but put buffer in another window.
Only intended for interactive use."
(interactive)
(let (value)
(switch-to-buffer-other-window
(save-window-excursion
(setq value (call-interactively 'dired-at-point))
(current-buffer)))
value))
(defun ffap-dired-other-frame ()
"Like `dired-at-point', but put buffer in another frame.
Only intended for interactive use."
(interactive)
;; Extra code works around dedicated windows (noted by JENS, 7/96):
(let* ((win (selected-window))
(wdp (window-dedicated-p win))
value)
(unwind-protect
(progn
(set-window-dedicated-p win nil)
(switch-to-buffer-other-frame
(save-window-excursion
(setq value (call-interactively 'dired-at-point))
(current-buffer))))
(set-window-dedicated-p win wdp))
value))
(defun ffap-list-directory ()
"Like `dired-at-point' and `list-directory'.
Only intended for interactive use."
(interactive)
(let ((ffap-directory-finder 'list-directory))
(call-interactively 'dired-at-point)))
\f
;;; Hooks to put in `file-name-at-point-functions':
;;;###autoload
(defun ffap-guess-file-name-at-point ()
"Try to get a file name at point.
This hook is intended to be put in `file-name-at-point-functions'."
;; ffap-guesser can signal an error, and we don't want that when,
;; e.g., the user types M-n at the "C-x C-f" prompt.
(let ((guess (ignore-errors (ffap-guesser))))
(when (stringp guess)
(let ((url (ffap-url-p guess)))
(or url
(progn
(unless (ffap-file-remote-p guess)
(setq guess
(abbreviate-file-name (expand-file-name guess))))
(if (file-directory-p guess)
(file-name-as-directory guess)
guess)))))))
\f
;;; Offer default global bindings (`ffap-bindings'):
(defvar ffap-bindings
'((global-set-key [S-mouse-3] 'ffap-at-mouse)
(global-set-key [C-S-mouse-3] 'ffap-menu)
(global-set-key "\C-x\C-f" 'find-file-at-point)
(global-set-key "\C-x\C-r" 'ffap-read-only)
(global-set-key "\C-x\C-v" 'ffap-alternate-file)
(global-set-key "\C-x4f" 'ffap-other-window)
(global-set-key "\C-x5f" 'ffap-other-frame)
(global-set-key "\C-x4r" 'ffap-read-only-other-window)
(global-set-key "\C-x5r" 'ffap-read-only-other-frame)
(global-set-key "\C-xd" 'dired-at-point)
(global-set-key "\C-x4d" 'ffap-dired-other-window)
(global-set-key "\C-x5d" 'ffap-dired-other-frame)
(global-set-key "\C-x\C-d" 'ffap-list-directory)
(add-hook 'gnus-summary-mode-hook 'ffap-gnus-hook)
(add-hook 'gnus-article-mode-hook 'ffap-gnus-hook)
(add-hook 'vm-mode-hook 'ffap-ro-mode-hook)
(add-hook 'rmail-mode-hook 'ffap-ro-mode-hook))
"List of binding forms evaluated by function `ffap-bindings'.
A reasonable ffap installation needs just this one line:
(ffap-bindings)
Of course if you do not like these bindings, just roll your own!")
;;;###autoload
(defun ffap-bindings ()
"Evaluate the forms in variable `ffap-bindings'."
(interactive)
(eval (cons 'progn ffap-bindings)))
\f
(provide 'ffap)
;;; ffap.el ends here
|