Merge from emacs-24; up to 2012-12-23T02:41:17Z!rgm@gnu.org
[bpt/emacs.git] / lisp / ffap.el
CommitLineData
0f76d837
JL
1;;; ffap.el --- find file (or url) at point
2
ab422c4d 3;; Copyright (C) 1995-1997, 2000-2013 Free Software Foundation, Inc.
0f76d837 4
b578f267 5;; Author: Michelangelo Grigni <mic@mathcs.emory.edu>
c45f4fd9 6;; Maintainer: FSF
87e2d039 7;; Created: 29 Mar 1993
f5f727f8 8;; Keywords: files, hypermedia, matching, mouse, convenience
3788c735 9;; X-URL: ftp://ftp.mathcs.emory.edu/pub/mic/emacs/
213d9a4f
RS
10
11;; This file is part of GNU Emacs.
12
eb3fa2cf 13;; GNU Emacs is free software: you can redistribute it and/or modify
213d9a4f 14;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
15;; the Free Software Foundation, either version 3 of the License, or
16;; (at your option) any later version.
213d9a4f
RS
17
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
eb3fa2cf 24;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
213d9a4f 25
213d9a4f 26\f
87e2d039 27;;; Commentary:
213d9a4f 28;;
87e2d039
RS
29;; Command find-file-at-point replaces find-file. With a prefix, it
30;; behaves exactly like find-file. Without a prefix, it first tries
41d34bed 31;; to guess a default file or URL from the text around the point
87e2d039
RS
32;; (`ffap-require-prefix' swaps these behaviors). This is useful for
33;; following references in situations such as mail or news buffers,
34;; README's, MANIFEST's, and so on. Submit bugs or suggestions with
35;; M-x ffap-bug.
213d9a4f 36;;
865fe16f 37;; For the default installation, add this line to your init file:
213d9a4f 38;;
87e2d039 39;; (ffap-bindings) ; do default key bindings
213d9a4f 40;;
87e2d039 41;; ffap-bindings makes the following global key bindings:
213d9a4f 42;;
c99310d5
JL
43;; C-x C-f find-file-at-point (abbreviated as ffap)
44;; C-x C-r ffap-read-only
45;; C-x C-v ffap-alternate-file
46;;
47;; C-x d dired-at-point
48;; C-x C-d ffap-list-directory
49;;
50;; C-x 4 f ffap-other-window
51;; C-x 4 r ffap-read-only-other-window
52;; C-x 4 d ffap-dired-other-window
53;;
54;; C-x 5 f ffap-other-frame
55;; C-x 5 r ffap-read-only-other-frame
56;; C-x 5 d ffap-dired-other-frame
57;;
87e2d039 58;; S-mouse-3 ffap-at-mouse
0948761d 59;; C-S-mouse-3 ffap-menu
213d9a4f 60;;
87e2d039
RS
61;; ffap-bindings also adds hooks to make the following local bindings
62;; in vm, gnus, and rmail:
213d9a4f 63;;
0948761d
KH
64;; M-l ffap-next, or ffap-gnus-next in gnus (l == "link")
65;; M-m ffap-menu, or ffap-gnus-menu in gnus (m == "menu")
213d9a4f 66;;
87e2d039
RS
67;; If you do not like these bindings, modify the variable
68;; `ffap-bindings', or write your own.
213d9a4f 69;;
87e2d039
RS
70;; If you use ange-ftp, browse-url, complete, efs, or w3, it is best
71;; to load or autoload them before ffap. If you use ff-paths, load it
72;; afterwards. Try apropos {C-h a ffap RET} to get a list of the many
73;; option variables. In particular, if ffap is slow, try these:
213d9a4f 74;;
87e2d039
RS
75;; (setq ffap-alist nil) ; faster, dumber prompting
76;; (setq ffap-machine-p-known 'accept) ; no pinging
41d34bed 77;; (setq ffap-url-regexp nil) ; disable URL features in ffap
c98ddbe5 78;; (setq ffap-shell-prompt-regexp nil) ; disable shell prompt stripping
213d9a4f 79;;
3788c735
KH
80;; ffap uses `browse-url' (if found, else `w3-fetch') to fetch URL's.
81;; For a hairier `ffap-url-fetcher', try ffap-url.el (same ftp site).
87e2d039 82;; Also, you can add `ffap-menu-rescan' to various hooks to fontify
71296446 83;; the file and URL references within a buffer.
87e2d039 84
0948761d
KH
85\f
86;;; Change Log:
87;;
88;; The History and Contributors moved to ffap.LOG (same ftp site),
89;; which also has some old examples and commentary from ffap 1.5.
90
91\f
87e2d039 92;;; Todo list:
0948761d 93;; * use kpsewhich
95a85681 94;; * let "/dir/file#key" jump to key (tag or regexp) in /dir/file
87e2d039 95;; * find file of symbol if TAGS is loaded (like above)
0948761d
KH
96;; * break long menus into multiple panes (like imenu?)
97;; * notice node in "(dired)Virtual Dired" (quotes, parentheses, whitespace)
95a85681 98;; * notice "machine.dom blah blah blah dir/file" (how?)
0948761d 99;; * as w3 becomes standard, rewrite to rely more on its functions
87e2d039
RS
100;; * regexp options for ffap-string-at-point, like font-lock (MCOOK)
101;; * v19: could replace `ffap-locate-file' with a quieter `locate-library'
0948761d
KH
102;; * handle "$(VAR)" in Makefiles
103;; * use the font-lock machinery
213d9a4f
RS
104
105\f
106;;; Code:
107
9f9aa044 108(require 'url-parse)
6e5c1569 109(require 'thingatpt)
9f9aa044 110
4648ccdf 111(define-obsolete-variable-alias 'ffap-version 'emacs-version "23.2")
213d9a4f 112
41d34bed
RS
113(defgroup ffap nil
114 "Find file or URL at point."
359d3f49
GM
115 ;; Dead 2009/07/05.
116;; :link '(url-link :tag "URL" "ftp://ftp.mathcs.emory.edu/pub/mic/emacs/")
f5f727f8
DN
117 :group 'matching
118 :group 'convenience)
41d34bed 119
3788c735
KH
120;; The code is organized in pages, separated by formfeed characters.
121;; See the next two pages for standard customization ideas.
122
123\f
124;;; User Variables:
41d34bed 125
a0d1aadf
SM
126(defun ffap-symbol-value (sym &optional default)
127 "Return value of symbol SYM, if bound, or DEFAULT otherwise."
128 (if (boundp sym) (symbol-value sym) default))
213d9a4f 129
c98ddbe5
RV
130(defcustom ffap-shell-prompt-regexp
131 ;; This used to test for some shell prompts that don't have a space
132 ;; after them. The common root shell prompt (#) is not listed since it
133 ;; also doubles up as a valid URL character.
134 "[$%><]*"
4454adab 135 "Paths matching this regexp are stripped off the shell prompt.
c98ddbe5
RV
136If nil, ffap doesn't do shell prompt stripping."
137 :type '(choice (const :tag "Disable" nil)
138 (const :tag "Standard" "[$%><]*")
139 regexp)
140 :group 'ffap)
141
9f9aa044 142(defcustom ffap-ftp-regexp "\\`/[^/:]+:"
9201cc28 143 "File names matching this regexp are treated as remote ffap.
95a85681 144If nil, ffap neither recognizes nor generates such names."
41d34bed 145 :type '(choice (const :tag "Disable" nil)
0948761d 146 (const :tag "Standard" "\\`/[^/:]+:")
41d34bed
RS
147 regexp)
148 :group 'ffap)
149
150(defcustom ffap-url-unwrap-local t
9f9aa044
CY
151 "If non-nil, convert some URLs to local file names before prompting.
152Only \"file:\" and \"ftp:\" URLs are converted, and only if they
153do not specify a host, or the host is either \"localhost\" or
154equal to `system-name'."
41d34bed
RS
155 :type 'boolean
156 :group 'ffap)
157
9f9aa044
CY
158(defcustom ffap-url-unwrap-remote '("ftp")
159 "If non-nil, convert URLs to remote file names before prompting.
160If the value is a list of strings, that specifies a list of URL
161schemes (e.g. \"ftp\"); in that case, only convert those URLs."
162 :type '(choice (repeat string) boolean)
163 :group 'ffap
2a1e2476 164 :version "24.3")
41d34bed 165
0948761d 166(defcustom ffap-ftp-default-user "anonymous"
9201cc28 167 "User name in ftp file names generated by `ffap-host-to-path'.
0948761d
KH
168Note this name may be omitted if it equals the default
169\(either `efs-default-user' or `ange-ftp-default-user'\)."
170 :type 'string
41d34bed 171 :group 'ffap)
213d9a4f 172
41d34bed 173(defcustom ffap-rfs-regexp
213d9a4f
RS
174 ;; Remote file access built into file system? HP rfa or Andrew afs:
175 "\\`/\\(afs\\|net\\)/."
176 ;; afs only: (and (file-exists-p "/afs") "\\`/afs/.")
9201cc28 177 "Matching file names are treated as remote. Use nil to disable."
41d34bed
RS
178 :type 'regexp
179 :group 'ffap)
213d9a4f
RS
180
181(defvar ffap-url-regexp
213d9a4f 182 (concat
a3680194 183 "\\("
213d9a4f
RS
184 "news\\(post\\)?:\\|mailto:\\|file:" ; no host ok
185 "\\|"
1d34daae 186 "\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host
6e5c1569
CY
187 "\\)")
188 "Regexp matching the beginning of a URI, for FFAP.
189If the value is nil, disable URL-matching features in ffap.")
213d9a4f 190
41d34bed 191(defcustom ffap-foo-at-bar-prefix "mailto"
9201cc28 192 "Presumed URL prefix type of strings like \"<foo.9z@bar>\".
41d34bed 193Sensible values are nil, \"news\", or \"mailto\"."
0948761d
KH
194 :type '(choice (const "mailto")
195 (const "news")
196 (const :tag "Disable" nil)
197 ;; string -- possible, but not really useful
198 )
41d34bed 199 :group 'ffap)
213d9a4f
RS
200
201\f
0948761d 202;;; Peanut Gallery (More User Variables):
87e2d039 203;;
213d9a4f
RS
204;; Users of ffap occasionally suggest new features. If I consider
205;; those features interesting but not clear winners (a matter of
206;; personal taste) I try to leave options to enable them. Read
87e2d039 207;; through this section for features that you like, put an appropriate
865fe16f 208;; enabler in your init file.
213d9a4f 209
c99310d5 210(defcustom ffap-dired-wildcards "[*?][^/]*\\'"
9201cc28 211 "A regexp matching filename wildcard characters, or nil.
c99310d5 212
87e2d039 213If `find-file-at-point' gets a filename matching this pattern,
5b523a77
JL
214and `ffap-pass-wildcards-to-dired' is nil, it passes it on to
215`find-file' with non-nil WILDCARDS argument, which expands
216wildcards and visits multiple files. To visit a file whose name
217contains wildcard characters you can suppress wildcard expansion
218by setting `find-file-wildcards'. If `find-file-at-point' gets a
219filename matching this pattern and `ffap-pass-wildcards-to-dired'
220is non-nil, it passes it on to `dired'.
c99310d5
JL
221
222If `dired-at-point' gets a filename matching this pattern,
223it passes it on to `dired'."
0948761d
KH
224 :type '(choice (const :tag "Disable" nil)
225 (const :tag "Enable" "[*?][^/]*\\'")
226 ;; regexp -- probably not useful
227 )
41d34bed 228 :group 'ffap)
213d9a4f 229
5b523a77 230(defcustom ffap-pass-wildcards-to-dired nil
9201cc28 231 "If non-nil, pass filenames matching `ffap-dired-wildcards' to dired."
5b523a77
JL
232 :type 'boolean
233 :group 'ffap)
234
0948761d 235(defcustom ffap-newfile-prompt nil
87e2d039
RS
236 ;; Suggestion from RHOGEE, 11 Jul 1994. Disabled, I think this is
237 ;; better handled by `find-file-not-found-hooks'.
9201cc28 238 "Whether `find-file-at-point' prompts about a nonexistent file."
41d34bed
RS
239 :type 'boolean
240 :group 'ffap)
213d9a4f 241
41d34bed 242(defcustom ffap-require-prefix nil
87e2d039 243 ;; Suggestion from RHOGEE, 20 Oct 1994.
9201cc28 244 "If set, reverses the prefix argument to `find-file-at-point'.
87e2d039 245This is nil so neophytes notice ffap. Experts may prefer to disable
41d34bed
RS
246ffap most of the time."
247 :type 'boolean
248 :group 'ffap)
249
250(defcustom ffap-file-finder 'find-file
9201cc28 251 "The command called by `find-file-at-point' to find a file."
41d34bed 252 :type 'function
9f9aa044
CY
253 :group 'ffap
254 :risky t)
213d9a4f 255
c99310d5 256(defcustom ffap-directory-finder 'dired
9201cc28 257 "The command called by `dired-at-point' to find a directory."
c99310d5 258 :type 'function
9f9aa044
CY
259 :group 'ffap
260 :risky t)
c99310d5 261
41d34bed 262(defcustom ffap-url-fetcher
3788c735
KH
263 (if (fboundp 'browse-url)
264 'browse-url ; rely on browse-url-browser-function
265 'w3-fetch)
87e2d039 266 ;; Remote control references:
213d9a4f
RS
267 ;; http://www.ncsa.uiuc.edu/SDG/Software/XMosaic/remote-control.html
268 ;; http://home.netscape.com/newsref/std/x-remote.html
9201cc28 269 "A function of one argument, called by ffap to fetch an URL.
3788c735 270Reasonable choices are `w3-fetch' or a `browse-url-*' function.
ee79ced8 271For a fancy alternative, get `ffap-url.el'."
0948761d 272 :type '(choice (const w3-fetch)
3788c735 273 (const browse-url) ; in recent versions of browse-url
0948761d
KH
274 (const browse-url-netscape)
275 (const browse-url-mosaic)
276 function)
9f9aa044
CY
277 :group 'ffap
278 :risky t)
279
280(defcustom ffap-next-regexp
281 ;; If you want ffap-next to find URL's only, try this:
282 ;; (and ffap-url-regexp (string-match "\\\\`" ffap-url-regexp)
283 ;; (concat "\\<" (substring ffap-url-regexp 2))))
284 ;;
285 ;; It pays to put a big fancy regexp here, since ffap-guesser is
286 ;; much more time-consuming than regexp searching:
287 "[/:.~[:alpha:]]/\\|@[[:alpha:]][-[:alnum:]]*\\."
288 "Regular expression governing movements of `ffap-next'."
289 :type 'regexp
41d34bed 290 :group 'ffap)
9f9aa044
CY
291
292(defcustom dired-at-point-require-prefix nil
293 "If non-nil, reverse the prefix argument to `dired-at-point'.
294This is nil so neophytes notice FFAP. Experts may prefer to
295disable FFAP most of the time."
296 :type 'boolean
297 :group 'ffap
298 :version "20.3")
213d9a4f
RS
299
300\f
3788c735
KH
301;;; Compatibility:
302;;
516bf0ee
RS
303;; This version of ffap supports only the Emacs it is distributed in.
304;; See the ftp site for a more general version. The following
305;; functions are necessary "leftovers" from the more general version.
3788c735 306
a0d1aadf 307(defun ffap-mouse-event () ; current mouse event, or nil
3788c735
KH
308 (and (listp last-nonmenu-event) last-nonmenu-event))
309(defun ffap-event-buffer (event)
310 (window-buffer (car (event-start event))))
0948761d
KH
311
312\f
313;;; Find Next Thing in buffer (`ffap-next'):
213d9a4f 314;;
87e2d039
RS
315;; Original ffap-next-url (URL's only) from RPECK 30 Mar 1995. Since
316;; then, broke it up into ffap-next-guess (noninteractive) and
317;; ffap-next (a command). It now work on files as well as url's.
213d9a4f 318
c9ae9869
RS
319(defvar ffap-next-guess nil
320 "Last value returned by `ffap-next-guess'.")
321
322(defvar ffap-string-at-point-region '(1 1)
9fc9a531 323 "List (BEG END), last region returned by the function `ffap-string-at-point'.")
c9ae9869 324
213d9a4f 325(defun ffap-next-guess (&optional back lim)
41d34bed 326 "Move point to next file or URL, and return it as a string.
87e2d039 327If nothing is found, leave point at limit and return nil.
213d9a4f
RS
328Optional BACK argument makes search backwards.
329Optional LIM argument limits the search.
330Only considers strings that match `ffap-next-regexp'."
331 (or lim (setq lim (if back (point-min) (point-max))))
332 (let (guess)
333 (while (not (or guess (eq (point) lim)))
334 (funcall (if back 're-search-backward 're-search-forward)
335 ffap-next-regexp lim 'move)
336 (setq guess (ffap-guesser)))
337 ;; Go to end, so we do not get same guess twice:
338 (goto-char (nth (if back 0 1) ffap-string-at-point-region))
339 (setq ffap-next-guess guess)))
340
341;;;###autoload
342(defun ffap-next (&optional back wrap)
41d34bed 343 "Search buffer for next file or URL, and run ffap.
213d9a4f
RS
344Optional argument BACK says to search backwards.
345Optional argument WRAP says to try wrapping around if necessary.
346Interactively: use a single prefix to search backwards,
347double prefix to wrap forward, triple to wrap backwards.
9fc9a531 348Actual search is done by the function `ffap-next-guess'."
213d9a4f
RS
349 (interactive
350 (cdr (assq (prefix-numeric-value current-prefix-arg)
351 '((1) (4 t) (16 nil t) (64 t t)))))
352 (let ((pt (point))
353 (guess (ffap-next-guess back)))
354 ;; Try wraparound if necessary:
355 (and (not guess) wrap
356 (goto-char (if back (point-max) (point-min)))
357 (setq guess (ffap-next-guess back pt)))
358 (if guess
359 (progn
360 (sit-for 0) ; display point movement
361 (find-file-at-point (ffap-prompter guess)))
362 (goto-char pt) ; restore point
41d34bed 363 (message "No %sfiles or URL's found"
213d9a4f
RS
364 (if wrap "" "more ")))))
365
366(defun ffap-next-url (&optional back wrap)
87e2d039 367 "Like `ffap-next', but search with `ffap-url-regexp'."
213d9a4f
RS
368 (interactive)
369 (let ((ffap-next-regexp ffap-url-regexp))
32226619 370 (if (called-interactively-p 'interactive)
213d9a4f
RS
371 (call-interactively 'ffap-next)
372 (ffap-next back wrap))))
373
374\f
0948761d 375;;; Machines (`ffap-machine-p'):
213d9a4f
RS
376
377;; I cannot decide a "best" strategy here, so these are variables. In
378;; particular, if `Pinging...' is broken or takes too long on your
379;; machine, try setting these all to accept or reject.
41d34bed 380(defcustom ffap-machine-p-local 'reject ; this happens often
9201cc28 381 "What `ffap-machine-p' does with hostnames that have no domain.
88b5c6b3 382Value should be a symbol, one of `ping', `accept', and `reject'."
41d34bed
RS
383 :type '(choice (const ping)
384 (const accept)
385 (const reject))
386 :group 'ffap)
ee79ced8 387(defcustom ffap-machine-p-known 'ping ; `accept' for higher speed
9201cc28 388 "What `ffap-machine-p' does with hostnames that have a known domain.
ee79ced8
KH
389Value should be a symbol, one of `ping', `accept', and `reject'.
390See `mail-extr.el' for the known domains."
41d34bed
RS
391 :type '(choice (const ping)
392 (const accept)
393 (const reject))
394 :group 'ffap)
395(defcustom ffap-machine-p-unknown 'reject
9201cc28 396 "What `ffap-machine-p' does with hostnames that have an unknown domain.
ee79ced8
KH
397Value should be a symbol, one of `ping', `accept', and `reject'.
398See `mail-extr.el' for the known domains."
41d34bed
RS
399 :type '(choice (const ping)
400 (const accept)
401 (const reject))
402 :group 'ffap)
87e2d039
RS
403
404(defun ffap-what-domain (domain)
405 ;; Like what-domain in mail-extr.el, returns string or nil.
406 (require 'mail-extr)
a0d1aadf
SM
407 (let ((ob (or (ffap-symbol-value 'mail-extr-all-top-level-domains)
408 (ffap-symbol-value 'all-top-level-domains)))) ; XEmacs
3788c735 409 (and ob (get (intern-soft (downcase domain) ob) 'domain-name))))
87e2d039
RS
410
411(defun ffap-machine-p (host &optional service quiet strategy)
412 "Decide whether HOST is the name of a real, reachable machine.
413Depending on the domain (none, known, or unknown), follow the strategy
414named by the variable `ffap-machine-p-local', `ffap-machine-p-known',
415or `ffap-machine-p-unknown'. Pinging uses `open-network-stream'.
416Optional SERVICE specifies the port used \(default \"discard\"\).
213d9a4f 417Optional QUIET flag suppresses the \"Pinging...\" message.
87e2d039 418Optional STRATEGY overrides the three variables above.
213d9a4f 419Returned values:
87e2d039
RS
420 t means that HOST answered.
421'accept means the relevant variable told us to accept.
422\"mesg\" means HOST exists, but does not respond for some reason."
423 ;; Try some (Emory local):
424 ;; (ffap-machine-p "ftp" nil nil 'ping)
425 ;; (ffap-machine-p "nonesuch" nil nil 'ping)
426 ;; (ffap-machine-p "ftp.mathcs.emory.edu" nil nil 'ping)
427 ;; (ffap-machine-p "mathcs" 5678 nil 'ping)
428 ;; (ffap-machine-p "foo.bonk" nil nil 'ping)
429 ;; (ffap-machine-p "foo.bonk.com" nil nil 'ping)
9b9a4122 430 (if (or (string-match "[^-[:alnum:].]" host) ; Invalid chars (?)
87e2d039 431 (not (string-match "[^0-9]" host))) ; 1: a number? 2: quick reject
213d9a4f
RS
432 nil
433 (let* ((domain
434 (and (string-match "\\.[^.]*$" host)
435 (downcase (substring host (1+ (match-beginning 0))))))
87e2d039
RS
436 (what-domain (if domain (ffap-what-domain domain) "Local")))
437 (or strategy
438 (setq strategy
439 (cond ((not domain) ffap-machine-p-local)
440 ((not what-domain) ffap-machine-p-unknown)
441 (t ffap-machine-p-known))))
213d9a4f
RS
442 (cond
443 ((eq strategy 'accept) 'accept)
444 ((eq strategy 'reject) nil)
e75e894b 445 ((not (fboundp 'open-network-stream)) nil)
213d9a4f
RS
446 ;; assume (eq strategy 'ping)
447 (t
448 (or quiet
87e2d039
RS
449 (if (stringp what-domain)
450 (message "Pinging %s (%s)..." host what-domain)
213d9a4f
RS
451 (message "Pinging %s ..." host)))
452 (condition-case error
453 (progn
454 (delete-process
455 (open-network-stream
456 "ffap-machine-p" nil host (or service "discard")))
457 t)
458 (error
459 (let ((mesg (car (cdr error))))
460 (cond
461 ;; v18:
462 ((string-match "^Unknown host" mesg) nil)
463 ((string-match "not responding$" mesg) mesg)
464 ;; v19:
465 ;; (file-error "connection failed" "permission denied"
466 ;; "nonesuch" "ffap-machine-p")
467 ;; (file-error "connection failed" "host is unreachable"
468 ;; "gopher.house.gov" "ffap-machine-p")
469 ;; (file-error "connection failed" "address already in use"
470 ;; "ftp.uu.net" "ffap-machine-p")
471 ((equal mesg "connection failed")
472 (if (equal (nth 2 error) "permission denied")
473 nil ; host does not exist
87e2d039 474 ;; Other errors mean the host exists:
213d9a4f
RS
475 (nth 2 error)))
476 ;; Could be "Unknown service":
477 (t (signal (car error) (cdr error))))))))))))
478
0948761d
KH
479\f
480;;; Possibly Remote Resources:
481
95a85681 482(defun ffap-replace-file-component (fullname name)
0948761d 483 "In remote FULLNAME, replace path with NAME. May return nil."
775a132d
MA
484 ;; Use efs if loaded, but do not load it otherwise.
485 (if (fboundp 'efs-replace-path-component)
a3680194 486 (funcall 'efs-replace-path-component fullname name)
775a132d
MA
487 (and (stringp fullname)
488 (stringp name)
489 (concat (file-remote-p fullname) name))))
95a85681 490;; (ffap-replace-file-component "/who@foo.com:/whatever" "/new")
0948761d 491
3788c735 492(defun ffap-file-suffix (file)
ee79ced8 493 "Return trailing `.foo' suffix of FILE, or nil if none."
3788c735
KH
494 (let ((pos (string-match "\\.[^./]*\\'" file)))
495 (and pos (substring file pos nil))))
496
497(defvar ffap-compression-suffixes '(".gz" ".Z") ; .z is mostly dead
498 "List of suffixes tried by `ffap-file-exists-string'.")
499
500(defun ffap-file-exists-string (file &optional nomodify)
501 ;; Early jka-compr versions modified file-exists-p to return the
502 ;; filename, maybe modified by adding a suffix like ".gz". That
503 ;; broke the interface of file-exists-p, so it was later dropped.
504 ;; Here we document and simulate the old behavior.
ee79ced8 505 "Return FILE (maybe modified) if the file exists, else nil.
3788c735
KH
506When using jka-compr (a.k.a. `auto-compression-mode'), the returned
507name may have a suffix added from `ffap-compression-suffixes'.
508The optional NOMODIFY argument suppresses the extra search."
509 (cond
510 ((not file) nil) ; quietly reject nil
511 ((file-exists-p file) file) ; try unmodified first
512 ;; three reasons to suppress search:
513 (nomodify nil)
514 ((not (rassq 'jka-compr-handler file-name-handler-alist)) nil)
515 ((member (ffap-file-suffix file) ffap-compression-suffixes) nil)
516 (t ; ok, do the search
517 (let ((list ffap-compression-suffixes) try ret)
518 (while list
519 (if (file-exists-p (setq try (concat file (car list))))
520 (setq ret try list nil)
521 (setq list (cdr list))))
522 ret))))
0948761d 523
213d9a4f 524(defun ffap-file-remote-p (filename)
ee79ced8 525 "If FILENAME looks remote, return it (maybe slightly improved)."
213d9a4f 526 ;; (ffap-file-remote-p "/user@foo.bar.com:/pub")
95a85681 527 ;; (ffap-file-remote-p "/cssun.mathcs.emory.edu://dir")
87e2d039 528 ;; (ffap-file-remote-p "/ffap.el:80")
213d9a4f
RS
529 (or (and ffap-ftp-regexp
530 (string-match ffap-ftp-regexp filename)
4c36be58 531 ;; Convert "/host.com://dir" to "/host:/dir", to handle a dying
95a85681 532 ;; practice of advertising ftp files as "host.dom://filename".
213d9a4f 533 (if (string-match "//" filename)
87e2d039
RS
534 ;; (replace-match "/" nil nil filename)
535 (concat (substring filename 0 (1+ (match-beginning 0)))
536 (substring filename (match-end 0)))
213d9a4f
RS
537 filename))
538 (and ffap-rfs-regexp
539 (string-match ffap-rfs-regexp filename)
540 filename)))
541
a0d1aadf 542(defun ffap-machine-at-point ()
87e2d039
RS
543 "Return machine name at point if it exists, or nil."
544 (let ((mach (ffap-string-at-point 'machine)))
213d9a4f
RS
545 (and (ffap-machine-p mach) mach)))
546
95a85681 547(defsubst ffap-host-to-filename (host)
0948761d 548 "Convert HOST to something like \"/USER@HOST:\" or \"/HOST:\".
87e2d039 549Looks at `ffap-ftp-default-user', returns \"\" for \"localhost\"."
0948761d
KH
550 (if (equal host "localhost")
551 ""
552 (let ((user ffap-ftp-default-user))
553 ;; Avoid including the user if it is same as default:
a0d1aadf
SM
554 (if (or (equal user (ffap-symbol-value 'ange-ftp-default-user))
555 (equal user (ffap-symbol-value 'efs-default-user)))
0948761d
KH
556 (setq user nil))
557 (concat "/" user (and user "@") host ":"))))
87e2d039 558
213d9a4f 559(defun ffap-fixup-machine (mach)
95a85681 560 ;; Convert a hostname into an url, an ftp file name, or nil.
213d9a4f
RS
561 (cond
562 ((not (and ffap-url-regexp (stringp mach))) nil)
87e2d039 563 ;; gopher.well.com
213d9a4f
RS
564 ((string-match "\\`gopher[-.]" mach) ; or "info"?
565 (concat "gopher://" mach "/"))
87e2d039 566 ;; www.ncsa.uiuc.edu
213d9a4f
RS
567 ((and (string-match "\\`w\\(ww\\|eb\\)[-.]" mach))
568 (concat "http://" mach "/"))
569 ;; More cases? Maybe "telnet:" for archie?
95a85681 570 (ffap-ftp-regexp (ffap-host-to-filename mach))
213d9a4f
RS
571 ))
572
6e5c1569
CY
573(defvaralias 'ffap-newsgroup-regexp 'thing-at-point-newsgroup-regexp)
574(defvaralias 'ffap-newsgroup-heads 'thing-at-point-newsgroup-heads)
575(defalias 'ffap-newsgroup-p 'thing-at-point-newsgroup-p)
213d9a4f 576
87e2d039 577(defsubst ffap-url-p (string)
4454adab 578 "If STRING looks like an URL, return it (maybe improved), else nil."
a3680194
CY
579 (when (and (stringp string) ffap-url-regexp)
580 (let* ((case-fold-search t)
581 (match (string-match ffap-url-regexp string)))
582 (cond ((eq match 0) string)
583 (match (substring string match))))))
213d9a4f 584
87e2d039 585;; Broke these out of ffap-fixup-url, for use of ffap-url package.
9f9aa044
CY
586(defun ffap-url-unwrap-local (url)
587 "Return URL as a local file name, or nil."
588 (let* ((obj (url-generic-parse-url url))
589 (host (url-host obj))
590 (filename (car (url-path-and-query obj))))
591 (when (and (member (url-type obj) '("ftp" "file"))
592 (member host `("" "localhost" ,(system-name))))
593 ;; On Windows, "file:///C:/foo" should unwrap to "C:/foo"
594 (if (and (memq system-type '(ms-dos windows-nt cygwin))
595 (string-match "\\`/[a-zA-Z]:" filename))
596 (substring filename 1)
597 filename))))
598
599(defun ffap-url-unwrap-remote (url)
600 "Return URL as a remote file name, or nil."
601 (let* ((obj (url-generic-parse-url url))
602 (scheme (url-type obj))
603 (valid-schemes (if (listp ffap-url-unwrap-remote)
604 ffap-url-unwrap-remote
605 '("ftp")))
606 (host (url-host obj))
607 (port (url-port-if-non-default obj))
608 (user (url-user obj))
609 (filename (car (url-path-and-query obj))))
610 (when (and (member scheme valid-schemes)
611 (string-match "\\`[a-zA-Z][-a-zA-Z0-9+.]*\\'" scheme)
612 (not (equal host "")))
613 (concat "/" scheme ":"
614 (if user (concat user "@"))
615 host
616 (if port (concat "#" (number-to-string port)))
617 ":" filename))))
213d9a4f
RS
618
619(defun ffap-fixup-url (url)
87e2d039 620 "Clean up URL and return it, maybe as a file name."
213d9a4f
RS
621 (cond
622 ((not (stringp url)) nil)
9f9aa044
CY
623 ((and ffap-url-unwrap-local (ffap-url-unwrap-local url)))
624 ((and ffap-url-unwrap-remote (ffap-url-unwrap-remote url)))
3788c735 625 (url)))
213d9a4f
RS
626
627\f
95a85681 628;;; File Name Handling:
213d9a4f 629;;
0948761d 630;; The upcoming ffap-alist actions need various utilities to prepare
95a85681 631;; and search directories. Too many features here.
0948761d
KH
632
633;; (defun ffap-last (l) (while (cdr l) (setq l (cdr l))) l)
634;; (defun ffap-splice (func inlist)
635;; "Equivalent to (apply 'nconc (mapcar FUNC INLIST)), but less consing."
636;; (let* ((head (cons 17 nil)) (last head))
637;; (while inlist
638;; (setcdr last (funcall func (car inlist)))
639;; (setq last (ffap-last last) inlist (cdr inlist)))
640;; (cdr head)))
213d9a4f
RS
641
642(defun ffap-list-env (env &optional empty)
0948761d
KH
643 "Return a list of strings parsed from environment variable ENV.
644Optional EMPTY is the default list if \(getenv ENV\) is undefined, and
645also is substituted for the first empty-string component, if there is one.
646Uses `path-separator' to separate the path into substrings."
647 ;; We cannot use parse-colon-path (files.el), since it kills
648 ;; "//" entries using file-name-as-directory.
649 ;; Similar: dired-split, TeX-split-string, and RHOGEE's psg-list-env
650 ;; in ff-paths and bib-cite. The EMPTY arg may help mimic kpathsea.
213d9a4f
RS
651 (if (or empty (getenv env)) ; should return something
652 (let ((start 0) match dir ret)
87e2d039 653 (setq env (concat (getenv env) path-separator))
8c1001f6 654 (while (setq match (string-match path-separator env start))
213d9a4f
RS
655 (setq dir (substring env start match) start (1+ match))
656 ;;(and (file-directory-p dir) (not (member dir ret)) ...)
657 (setq ret (cons dir ret)))
658 (setq ret (nreverse ret))
659 (and empty (setq match (member "" ret))
0948761d 660 (progn ; allow string or list here
213d9a4f
RS
661 (setcdr match (append (cdr-safe empty) (cdr match)))
662 (setcar match (or (car-safe empty) empty))))
663 ret)))
664
665(defun ffap-reduce-path (path)
87e2d039 666 "Remove duplicates and non-directories from PATH list."
213d9a4f
RS
667 (let (ret tem)
668 (while path
669 (setq tem path path (cdr path))
87e2d039 670 (if (equal (car tem) ".") (setcar tem ""))
213d9a4f
RS
671 (or (member (car tem) ret)
672 (not (file-directory-p (car tem)))
673 (progn (setcdr tem ret) (setq ret tem))))
674 (nreverse ret)))
675
0948761d 676(defun ffap-all-subdirs (dir &optional depth)
4454adab 677 "Return list of all subdirectories under DIR, starting with itself.
0948761d
KH
678Directories beginning with \".\" are ignored, and directory symlinks
679are listed but never searched (to avoid loops).
680Optional DEPTH limits search depth."
681 (and (file-exists-p dir)
682 (ffap-all-subdirs-loop (expand-file-name dir) (or depth -1))))
683
684(defun ffap-all-subdirs-loop (dir depth) ; internal
685 (setq depth (1- depth))
686 (cons dir
687 (and (not (eq depth -1))
688 (apply 'nconc
689 (mapcar
690 (function
691 (lambda (d)
692 (cond
693 ((not (file-directory-p d)) nil)
694 ((file-symlink-p d) (list d))
695 (t (ffap-all-subdirs-loop d depth)))))
696 (directory-files dir t "\\`[^.]")
697 )))))
698
699(defvar ffap-kpathsea-depth 1
700 "Bound on depth of subdirectory search in `ffap-kpathsea-expand-path'.
701Set to 0 to avoid all searching, or nil for no limit.")
702
703(defun ffap-kpathsea-expand-path (path)
704 "Replace each \"//\"-suffixed dir in PATH by a list of its subdirs.
705The subdirs begin with the original directory, and the depth of the
706search is bounded by `ffap-kpathsea-depth'. This is intended to mimic
707kpathsea, a library used by some versions of TeX."
708 (apply 'nconc
709 (mapcar
710 (function
711 (lambda (dir)
712 (if (string-match "[^/]//\\'" dir)
713 (ffap-all-subdirs (substring dir 0 -2) ffap-kpathsea-depth)
714 (list dir))))
715 path)))
716
a0d1aadf 717(defun ffap-locate-file (file nosuffix path)
516bf0ee 718 ;; The current version of locate-library could almost replace this,
0f76d837 719 ;; except it does not let us override the suffix list. The
3788c735 720 ;; compression-suffixes search moved to ffap-file-exists-string.
a0d1aadf
SM
721 "A generic path-searching function.
722Returns the name of file in PATH, or nil.
0948761d 723Optional NOSUFFIX, if nil or t, is like the fourth argument
a0d1aadf 724for `load': whether to try the suffixes (\".elc\" \".el\" \"\").
0948761d 725If a nonempty list, it is a list of suffixes to try instead.
a0d1aadf 726PATH is a list of directories.
3788c735 727
a0d1aadf 728This uses `ffap-file-exists-string', which may try adding suffixes from
3788c735 729`ffap-compression-suffixes'."
0948761d
KH
730 (if (file-name-absolute-p file)
731 (setq path (list (file-name-directory file))
732 file (file-name-nondirectory file)))
a0d1aadf
SM
733 (let ((dir-ok (equal "" (file-name-nondirectory file)))
734 (suffixes-to-try
0948761d
KH
735 (cond
736 ((consp nosuffix) nosuffix)
737 (nosuffix '(""))
3788c735
KH
738 (t '(".elc" ".el" ""))))
739 suffixes try found)
740 (while path
741 (setq suffixes suffixes-to-try)
742 (while suffixes
743 (setq try (ffap-file-exists-string
744 (expand-file-name
745 (concat file (car suffixes)) (car path))))
746 (if (and try (or dir-ok (not (file-directory-p try))))
747 (setq found try suffixes nil path nil)
748 (setq suffixes (cdr suffixes))))
749 (setq path (cdr path)))
750 found))
0948761d
KH
751
752\f
753;;; Action List (`ffap-alist'):
754;;
755;; These search actions depend on the major-mode or regexps matching
756;; the current name. The little functions and their variables are
757;; deferred to the next section, at some loss of "code locality". A
758;; good example of featuritis. Trim this list for speed.
213d9a4f 759
213d9a4f 760(defvar ffap-alist
c9ae9869 761 '(
0948761d
KH
762 ("" . ffap-completable) ; completion, slow on some systems
763 ("\\.info\\'" . ffap-info) ; gzip.info
764 ("\\`info/" . ffap-info-2) ; info/emacs
5362ba53 765 ("\\`[-[:lower:]]+\\'" . ffap-info-3) ; (emacs)Top [only in the parentheses]
0948761d
KH
766 ("\\.elc?\\'" . ffap-el) ; simple.el, simple.elc
767 (emacs-lisp-mode . ffap-el-mode) ; rmail, gnus, simple, custom
3788c735 768 ;; (lisp-interaction-mode . ffap-el-mode) ; maybe
0948761d
KH
769 (finder-mode . ffap-el-mode) ; type {C-h p} and try it
770 (help-mode . ffap-el-mode) ; maybe useful
771 (c++-mode . ffap-c-mode) ; search ffap-c-path
772 (cc-mode . ffap-c-mode) ; same
773 ("\\.\\([chCH]\\|cc\\|hh\\)\\'" . ffap-c-mode) ; stdio.h
774 (fortran-mode . ffap-fortran-mode) ; FORTRAN requested by MDB
775 ("\\.[fF]\\'" . ffap-fortran-mode)
776 (tex-mode . ffap-tex-mode) ; search ffap-tex-path
777 (latex-mode . ffap-latex-mode) ; similar
c9ae9869 778 ("\\.\\(tex\\|sty\\|doc\\|cls\\)\\'" . ffap-tex)
0948761d
KH
779 ("\\.bib\\'" . ffap-bib) ; search ffap-bib-path
780 ("\\`\\." . ffap-home) ; .emacs, .bashrc, .profile
781 ("\\`~/" . ffap-lcd) ; |~/misc/ffap.el.Z|
a0d1aadf 782 ;; This used to have a blank, but ffap-string-at-point doesn't
d4f7fdc6
GM
783 ;; handle blanks.
784 ;; http://lists.gnu.org/archive/html/emacs-devel/2008-01/msg01058.html
a0d1aadf 785 ("\\`[Rr][Ff][Cc][-#]?\\([0-9]+\\)" ; no $
0948761d
KH
786 . ffap-rfc) ; "100% RFC2100 compliant"
787 (dired-mode . ffap-dired) ; maybe in a subdirectory
788 )
87e2d039 789 "Alist of \(KEY . FUNCTION\) pairs parsed by `ffap-file-at-point'.
4454adab 790If string NAME at point (maybe \"\") is not a file or URL, these pairs
87e2d039
RS
791specify actions to try creating such a string. A pair matches if either
792 KEY is a symbol, and it equals `major-mode', or
4454adab 793 KEY is a string, it should match NAME as a regexp.
87e2d039 794On a match, \(FUNCTION NAME\) is called and should return a file, an
4454adab 795URL, or nil. If nil, search the alist for further matches.")
87e2d039 796
213d9a4f 797(put 'ffap-alist 'risky-local-variable t)
0948761d 798
3788c735
KH
799;; Example `ffap-alist' modifications:
800;;
801;; (setq ffap-alist ; remove a feature in `ffap-alist'
802;; (delete (assoc 'c-mode ffap-alist) ffap-alist))
803;;
804;; (setq ffap-alist ; add something to `ffap-alist'
805;; (cons
806;; (cons "^YSN[0-9]+$"
807;; (defun ffap-ysn (name)
808;; (concat
809;; "http://www.physics.uiuc.edu/"
810;; "ysn/httpd/htdocs/ysnarchive/issuefiles/"
811;; (substring name 3) ".html")))
812;; ffap-alist))
813
c9ae9869 814\f
0948761d
KH
815;;; Action Definitions:
816;;
817;; Define various default members of `ffap-alist'.
818
819(defun ffap-completable (name)
820 (let* ((dir (or (file-name-directory name) default-directory))
821 (cmp (file-name-completion (file-name-nondirectory name) dir)))
822 (and cmp (concat dir cmp))))
823
824(defun ffap-home (name) (ffap-locate-file name t '("~")))
c9ae9869
RS
825
826(defun ffap-info (name)
0948761d 827 (ffap-locate-file
c9ae9869 828 name '("" ".info")
a0d1aadf
SM
829 (or (ffap-symbol-value 'Info-directory-list)
830 (ffap-symbol-value 'Info-default-directory-list)
0948761d 831 )))
c9ae9869
RS
832
833(defun ffap-info-2 (name) (ffap-info (substring name 5)))
834
c9ae9869 835(defun ffap-info-3 (name)
0948761d 836 ;; This ignores the node! "(emacs)Top" same as "(emacs)Intro"
c9ae9869
RS
837 (and (equal (ffap-string-around) "()") (ffap-info name)))
838
a0d1aadf 839(defun ffap-el (name) (ffap-locate-file name t load-path))
c9ae9869
RS
840
841(defun ffap-el-mode (name)
0948761d
KH
842 ;; If name == "foo.el" we will skip it, since ffap-el already
843 ;; searched for it once. (This assumes the default ffap-alist.)
c9ae9869 844 (and (not (string-match "\\.el\\'" name))
a0d1aadf 845 (ffap-locate-file name '(".el") load-path)))
0948761d 846
ac2eceee
GM
847;; FIXME this duplicates the logic of Man-header-file-path.
848;; There should be a single central variable or function for this.
849;; See also (bug#10702):
850;; cc-search-directories, semantic-c-dependency-system-include-path,
851;; semantic-gcc-setup
0948761d 852(defvar ffap-c-path
ac2eceee
GM
853 (let ((arch (with-temp-buffer
854 (when (eq 0 (ignore-errors
855 (call-process "gcc" nil '(t nil) nil
856 "-print-multiarch")))
857 (goto-char (point-min))
858 (buffer-substring (point) (line-end-position)))))
859 (base '("/usr/include" "/usr/local/include")))
860 (if (zerop (length arch))
861 base
862 (append base (list (expand-file-name arch "/usr/include")))))
863 "List of directories to search for include files.")
864
0948761d
KH
865(defun ffap-c-mode (name)
866 (ffap-locate-file name t ffap-c-path))
867
868(defvar ffap-fortran-path '("../include" "/usr/include"))
869
870(defun ffap-fortran-mode (name)
871 (ffap-locate-file name t ffap-fortran-path))
c9ae9869 872
c9ae9869
RS
873(defvar ffap-tex-path
874 t ; delayed initialization
4454adab 875 "Path where `ffap-tex-mode' looks for TeX files.
c9ae9869 876If t, `ffap-tex-init' will initialize this when needed.")
213d9a4f 877
a0d1aadf 878(defun ffap-tex-init ()
c9ae9869
RS
879 ;; Compute ffap-tex-path if it is now t.
880 (and (eq t ffap-tex-path)
0948761d 881 ;; this may be slow, so say something
c9ae9869
RS
882 (message "Initializing ffap-tex-path ...")
883 (setq ffap-tex-path
884 (ffap-reduce-path
0948761d
KH
885 (cons
886 "."
887 (ffap-kpathsea-expand-path
888 (append
889 (ffap-list-env "TEXINPUTS")
890 ;; (ffap-list-env "BIBINPUTS")
a0d1aadf
SM
891 (ffap-symbol-value
892 'TeX-macro-global ; AUCTeX
0948761d
KH
893 '("/usr/local/lib/tex/macros"
894 "/usr/local/lib/tex/inputs")))))))))
c9ae9869
RS
895
896(defun ffap-tex-mode (name)
897 (ffap-tex-init)
0948761d 898 (ffap-locate-file name '(".tex" "") ffap-tex-path))
c9ae9869
RS
899
900(defun ffap-latex-mode (name)
901 (ffap-tex-init)
0948761d
KH
902 ;; only rare need for ""
903 (ffap-locate-file name '(".cls" ".sty" ".tex" "") ffap-tex-path))
c9ae9869
RS
904
905(defun ffap-tex (name)
906 (ffap-tex-init)
0948761d
KH
907 (ffap-locate-file name t ffap-tex-path))
908
909(defvar ffap-bib-path
910 (ffap-list-env "BIBINPUTS"
911 (ffap-reduce-path
912 '(
913 ;; a few wild guesses, need better
914 "/usr/local/lib/tex/macros/bib" ; Solaris?
915 "/usr/lib/texmf/bibtex/bib" ; Linux?
916 ))))
c9ae9869
RS
917
918(defun ffap-bib (name)
0948761d 919 (ffap-locate-file name t ffap-bib-path))
c9ae9869
RS
920
921(defun ffap-dired (name)
984ddcbc 922 (let ((pt (point)) try)
c9ae9869
RS
923 (save-excursion
924 (and (progn
925 (beginning-of-line)
926 (looking-at " *[-d]r[-w][-x][-r][-w][-x][-r][-w][-x] "))
927 (re-search-backward "^ *$" nil t)
928 (re-search-forward "^ *\\([^ \t\n:]*\\):\n *total " pt t)
929 (file-exists-p
930 (setq try
931 (expand-file-name
932 name
933 (buffer-substring
934 (match-beginning 1) (match-end 1)))))
935 try))))
936
937;; Maybe a "Lisp Code Directory" reference:
938(defun ffap-lcd (name)
a0d1aadf 939 ;; FIXME: Is this still in use?
c9ae9869
RS
940 (and
941 (or
942 ;; lisp-dir-apropos output buffer:
943 (string-match "Lisp Code Dir" (buffer-name))
944 ;; Inside an LCD entry like |~/misc/ffap.el.Z|,
945 ;; or maybe the holy LCD-Datafile itself:
946 (member (ffap-string-around) '("||" "|\n")))
947 (concat
948 ;; lispdir.el may not be loaded yet:
95a85681 949 (ffap-host-to-filename
a0d1aadf
SM
950 (ffap-symbol-value 'elisp-archive-host
951 "archive.cis.ohio-state.edu"))
c9ae9869 952 (file-name-as-directory
a0d1aadf
SM
953 (ffap-symbol-value 'elisp-archive-directory
954 "/pub/gnu/emacs/elisp-archive/"))
c9ae9869
RS
955 (substring name 2))))
956
990a9cb1
KR
957(defcustom ffap-rfc-path
958 (concat (ffap-host-to-filename "ftp.rfc-editor.org") "/in-notes/rfc%s.txt")
959 "A `format' string making a filename for RFC documents.
960This can be an ange-ftp or tramp remote filename to download, or
961a local filename if you have full set of RFCs locally. See also
962`ffap-rfc-directories'."
963 :type 'string
964 :version "23.1"
965 :group 'ffap)
966
8a798137
GM
967(defcustom ffap-rfc-directories nil
968 "A list of directories to look for RFC files.
969If a given RFC isn't in these then `ffap-rfc-path' is offered."
970 :type '(repeat directory)
0a66ac10 971 :version "23.1"
8a798137
GM
972 :group 'ffap)
973
c9ae9869 974(defun ffap-rfc (name)
8a798137
GM
975 (let ((num (match-string 1 name)))
976 (or (ffap-locate-file (format "rfc%s.txt" num) t ffap-rfc-directories)
977 (format ffap-rfc-path num))))
0948761d 978
213d9a4f
RS
979\f
980;;; At-Point Functions:
981
982(defvar ffap-string-at-point-mode-alist
983 '(
87e2d039 984 ;; The default, used when the `major-mode' is not found.
213d9a4f
RS
985 ;; Slightly controversial decisions:
986 ;; * strip trailing "@" and ":"
987 ;; * no commas (good for latex)
b251c649 988 (file "--:\\\\$+<>@-Z_[:alpha:]~*?" "<@" "@>;.,!:")
87e2d039 989 ;; An url, or maybe a email/news message-id:
6e5c1569 990 (url "--:=&?$+@-Z_[:alpha:]~#,%;*()!'" "^[0-9a-zA-Z]" ":;.,!?")
87e2d039 991 ;; Find a string that does *not* contain a colon:
b251c649 992 (nocolon "--9$+<>@-Z_[:alpha:]~" "<@" "@>;.,!?")
87e2d039 993 ;; A machine:
5362ba53 994 (machine "-[:alnum:]." "" ".")
87e2d039 995 ;; Mathematica paths: allow backquotes
5362ba53 996 (math-mode ",-:$+<>@-Z_[:lower:]~`" "<" "@>;.,!?`:")
213d9a4f 997 )
87e2d039 998 "Alist of \(MODE CHARS BEG END\), where MODE is a symbol,
ee79ced8
KH
999possibly a major-mode name, or one of the symbol
1000`file', `url', `machine', and `nocolon'.
9fc9a531 1001Function `ffap-string-at-point' uses the data fields as follows:
87e2d039
RS
10021. find a maximal string of CHARS around point,
10032. strip BEG chars before point from the beginning,
6e5c1569 10043. strip END chars after point from the end.")
213d9a4f 1005
213d9a4f
RS
1006(defvar ffap-string-at-point nil
1007 ;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95.
9fc9a531 1008 "Last string returned by the function `ffap-string-at-point'.")
87e2d039
RS
1009
1010(defun ffap-string-at-point (&optional mode)
1011 "Return a string of characters from around point.
ee79ced8 1012MODE (defaults to value of `major-mode') is a symbol used to look up string
87e2d039 1013syntax parameters in `ffap-string-at-point-mode-alist'.
ee79ced8 1014If MODE is not found, we use `file' instead of MODE.
0f76d837 1015If the region is active, return a string from the region.
9fc9a531
AH
1016Sets the variable `ffap-string-at-point' and the variable
1017`ffap-string-at-point-region'."
87e2d039
RS
1018 (let* ((args
1019 (cdr
1020 (or (assq (or mode major-mode) ffap-string-at-point-mode-alist)
1021 (assq 'file ffap-string-at-point-mode-alist))))
1022 (pt (point))
6e5c1569
CY
1023 (beg (if (use-region-p)
1024 (region-beginning)
1025 (save-excursion
1026 (skip-chars-backward (car args))
1027 (skip-chars-forward (nth 1 args) pt)
1028 (point))))
1029 (end (if (use-region-p)
1030 (region-end)
1031 (save-excursion
1032 (skip-chars-forward (car args))
1033 (skip-chars-backward (nth 2 args) pt)
1034 (point)))))
1035 (setq ffap-string-at-point
1036 (buffer-substring-no-properties
1037 (setcar ffap-string-at-point-region beg)
1038 (setcar (cdr ffap-string-at-point-region) end)))))
213d9a4f 1039
a0d1aadf 1040(defun ffap-string-around ()
213d9a4f 1041 ;; Sometimes useful to decide how to treat a string.
9fc9a531
AH
1042 "Return string of two chars around last result of function
1043`ffap-string-at-point'.
87e2d039 1044Assumes the buffer has not changed."
213d9a4f
RS
1045 (save-excursion
1046 (format "%c%c"
1047 (progn
1048 (goto-char (car ffap-string-at-point-region))
1049 (preceding-char)) ; maybe 0
1050 (progn
1051 (goto-char (nth 1 ffap-string-at-point-region))
1052 (following-char)) ; maybe 0
1053 )))
1054
87e2d039
RS
1055(defun ffap-copy-string-as-kill (&optional mode)
1056 ;; Requested by MCOOK. Useful?
9fc9a531 1057 "Call function `ffap-string-at-point', and copy result to `kill-ring'."
87e2d039
RS
1058 (interactive)
1059 (let ((str (ffap-string-at-point mode)))
1060 (if (equal "" str)
1061 (message "No string found around point.")
1062 (kill-new str)
1063 ;; Older: (apply 'copy-region-as-kill ffap-string-at-point-region)
1064 (message "Copied to kill ring: %s" str))))
1065
36b5be6b 1066;; External.
eb22a8c3 1067(declare-function w3-view-this-url "ext:w3" (&optional no-show))
36b5be6b 1068
a0d1aadf 1069(defun ffap-url-at-point ()
4454adab 1070 "Return URL from around point if it exists, or nil."
9f9aa044
CY
1071 (when ffap-url-regexp
1072 (or (and (eq major-mode 'w3-mode) ; In a w3 buffer button?
1073 (w3-view-this-url t))
6e5c1569
CY
1074 (let ((thing-at-point-beginning-of-url-regexp ffap-url-regexp)
1075 (thing-at-point-default-mail-scheme ffap-foo-at-bar-prefix))
1076 (thing-at-point-url-at-point t
1077 (if (use-region-p)
1078 (cons (region-beginning)
1079 (region-end))))))))
213d9a4f
RS
1080
1081(defvar ffap-gopher-regexp
1082 "^.*\\<\\(Type\\|Name\\|Path\\|Host\\|Port\\) *= *\\(.*\\) *$"
4454adab 1083 "Regexp matching a line in a gopher bookmark (maybe indented).
87e2d039 1084The two subexpressions are the KEY and VALUE.")
213d9a4f 1085
a0d1aadf 1086(defun ffap-gopher-at-point ()
4454adab 1087 "If point is inside a gopher bookmark block, return its URL."
87e2d039 1088 ;; `gopher-parse-bookmark' from gopher.el is not so robust
213d9a4f
RS
1089 (save-excursion
1090 (beginning-of-line)
1091 (if (looking-at ffap-gopher-regexp)
1092 (progn
1093 (while (and (looking-at ffap-gopher-regexp) (not (bobp)))
1094 (forward-line -1))
1095 (or (looking-at ffap-gopher-regexp) (forward-line 1))
a0d1aadf 1096 (let ((type "1") path host (port "70"))
213d9a4f
RS
1097 (while (looking-at ffap-gopher-regexp)
1098 (let ((var (intern
1099 (downcase
1100 (buffer-substring (match-beginning 1)
1101 (match-end 1)))))
1102 (val (buffer-substring (match-beginning 2)
1103 (match-end 2))))
1104 (set var val)
1105 (forward-line 1)))
1106 (if (and path (string-match "^ftp:.*@" path))
1107 (concat "ftp://"
1108 (substring path 4 (1- (match-end 0)))
1109 (substring path (match-end 0)))
1110 (and (= (length type) 1)
1111 host;; (ffap-machine-p host)
1112 (concat "gopher://" host
1113 (if (equal port "70") "" (concat ":" port))
1114 "/" type path))))))))
1115
1116(defvar ffap-ftp-sans-slash-regexp
1117 (and
1118 ffap-ftp-regexp
87e2d039 1119 ;; Note: by now, we know it is not an url.
213d9a4f
RS
1120 ;; Icky regexp avoids: default: 123: foo::bar cs:pub
1121 ;; It does match on: mic@cs: cs:/pub mathcs.emory.edu: (point at end)
213d9a4f 1122 "\\`\\([^:@]+@[^:@]+:\\|[^@.:]+\\.[^@:]+:\\|[^:]+:[~/]\\)\\([^:]\\|\\'\\)")
95a85681 1123 "Strings matching this are coerced to ftp file names by ffap.
213d9a4f
RS
1124That is, ffap just prepends \"/\". Set to nil to disable.")
1125
a0d1aadf 1126(defun ffap-file-at-point ()
213d9a4f
RS
1127 "Return filename from around point if it exists, or nil.
1128Existence test is skipped for names that look remote.
1129If the filename is not obvious, it also tries `ffap-alist',
4454adab 1130which may actually result in an URL rather than a filename."
87e2d039 1131 ;; Note: this function does not need to look for url's, just
213d9a4f 1132 ;; filenames. On the other hand, it is responsible for converting
95a85681 1133 ;; a pseudo-url "site.com://dir" to an ftp file name
213d9a4f
RS
1134 (let* ((case-fold-search t) ; url prefixes are case-insensitive
1135 (data (match-data))
87e2d039 1136 (string (ffap-string-at-point)) ; uses mode alist
213d9a4f 1137 (name
87e2d039
RS
1138 (or (condition-case nil
1139 (and (not (string-match "//" string)) ; foo.com://bar
1140 (substitute-in-file-name string))
1141 (error nil))
1142 string))
213d9a4f 1143 (abs (file-name-absolute-p name))
d35829ff
GM
1144 (default-directory default-directory)
1145 (oname name))
213d9a4f
RS
1146 (unwind-protect
1147 (cond
c99310d5
JL
1148 ;; Immediate rejects (/ and // and /* are too common in C/C++):
1149 ((member name '("" "/" "//" "/*" ".")) nil)
8005ea3f
RS
1150 ;; Immediately test local filenames. If default-directory is
1151 ;; remote, you probably already have a connection.
1152 ((and (not abs) (ffap-file-exists-string name)))
1153 ;; Try stripping off line numbers; good for compilation/grep output.
1154 ((and (not abs) (string-match ":[0-9]" name)
1155 (ffap-file-exists-string (substring name 0 (match-beginning 0)))))
c98ddbe5
RV
1156 ;; Try stripping off prominent (non-root - #) shell prompts
1157 ;; if the ffap-shell-prompt-regexp is non-nil.
1158 ((and ffap-shell-prompt-regexp
1159 (not abs) (string-match ffap-shell-prompt-regexp name)
1160 (ffap-file-exists-string (substring name (match-end 0)))))
213d9a4f 1161 ;; Accept remote names without actual checking (too slow):
d35829ff 1162 ((and abs (ffap-file-remote-p name)))
213d9a4f
RS
1163 ;; Ok, not remote, try the existence test even if it is absolute:
1164 ((and abs (ffap-file-exists-string name)))
2b2eb431
GM
1165 ;; Try stripping off line numbers.
1166 ((and abs (string-match ":[0-9]" name)
1167 (ffap-file-exists-string (substring name 0 (match-beginning 0)))))
87e2d039
RS
1168 ;; If it contains a colon, get rid of it (and return if exists)
1169 ((and (string-match path-separator name)
1170 (setq name (ffap-string-at-point 'nocolon))
1171 (ffap-file-exists-string name)))
213d9a4f
RS
1172 ;; File does not exist, try the alist:
1173 ((let ((alist ffap-alist) tem try case-fold-search)
1174 (while (and alist (not try))
1175 (setq tem (car alist) alist (cdr alist))
1176 (if (or (eq major-mode (car tem))
1177 (and (stringp (car tem))
1178 (string-match (car tem) name)))
0948761d
KH
1179 (and (setq try
1180 (condition-case nil
1181 (funcall (cdr tem) name)
1182 (error nil)))
213d9a4f
RS
1183 (setq try (or
1184 (ffap-url-p try) ; not a file!
1185 (ffap-file-remote-p try)
1186 (ffap-file-exists-string try))))))
1187 try))
d35829ff
GM
1188 ;; Try adding a leading "/" (common omission in ftp file names).
1189 ;; Note that this uses oname, which still has any colon part.
1190 ;; This should have a lower priority than the alist stuff,
1191 ;; else it matches things like "ffap.el:1234:56:Warning".
1192 ((and (not abs)
1193 ffap-ftp-sans-slash-regexp
1194 (string-match ffap-ftp-sans-slash-regexp oname)
1195 (ffap-file-remote-p (concat "/" oname))))
213d9a4f
RS
1196 ;; Alist failed? Try to guess an active remote connection
1197 ;; from buffer variables, and try once more, both as an
95a85681 1198 ;; absolute and relative file name on that remote host.
213d9a4f
RS
1199 ((let* (ffap-rfs-regexp ; suppress
1200 (remote-dir
1201 (cond
1202 ((ffap-file-remote-p default-directory))
1203 ((and (eq major-mode 'internal-ange-ftp-mode)
1204 (string-match "^\\*ftp \\(.*\\)@\\(.*\\)\\*$"
1205 (buffer-name)))
1206 (concat "/" (substring (buffer-name) 5 -1) ":"))
1207 ;; This is too often a bad idea:
1208 ;;((and (eq major-mode 'w3-mode)
1209 ;; (stringp url-current-server))
1210 ;; (host-to-ange-path url-current-server))
1211 )))
1212 (and remote-dir
1213 (or
1214 (and (string-match "\\`\\(/?~?ftp\\)/" name)
1215 (ffap-file-exists-string
95a85681 1216 (ffap-replace-file-component
213d9a4f
RS
1217 remote-dir (substring name (match-end 1)))))
1218 (ffap-file-exists-string
95a85681 1219 (ffap-replace-file-component remote-dir name))))))
c99310d5
JL
1220 ((and ffap-dired-wildcards
1221 (string-match ffap-dired-wildcards name)
1222 abs
1223 (ffap-file-exists-string (file-name-directory
1224 (directory-file-name name)))
1225 name))
7e1626fb
EZ
1226 ;; Try all parent directories by deleting the trailing directory
1227 ;; name until existing directory is found or name stops changing
1228 ((let ((dir name))
1229 (while (and dir
1230 (not (ffap-file-exists-string dir))
1231 (not (equal dir (setq dir (file-name-directory
1232 (directory-file-name dir)))))))
1233 (ffap-file-exists-string dir)))
213d9a4f 1234 )
3c2c6be2 1235 (set-match-data data))))
213d9a4f 1236\f
0948761d 1237;;; Prompting (`ffap-read-file-or-url'):
213d9a4f 1238;;
87e2d039
RS
1239;; We want to complete filenames as in read-file-name, but also url's
1240;; which read-file-name-internal would truncate at the "//" string.
1241;; The solution here is to replace read-file-name-internal with
1242;; `ffap-read-file-or-url-internal', which checks the minibuffer
1243;; contents before attempting to complete filenames.
213d9a4f
RS
1244
1245(defun ffap-read-file-or-url (prompt guess)
4454adab 1246 "Read file or URL from minibuffer, with PROMPT and initial GUESS."
213d9a4f 1247 (or guess (setq guess default-directory))
87e2d039 1248 (let (dir)
213d9a4f
RS
1249 ;; Tricky: guess may have or be a local directory, like "w3/w3.elc"
1250 ;; or "w3/" or "../el/ffap.el" or "../../../"
a3680194
CY
1251 (unless (ffap-url-p guess)
1252 (unless (ffap-file-remote-p guess)
1253 (setq guess
1254 (abbreviate-file-name (expand-file-name guess))))
1255 (setq dir (file-name-directory guess)))
07556e35 1256 (let ((minibuffer-completing-file-name t)
d8df1280 1257 (completion-ignore-case read-file-name-completion-ignore-case)
ea27e496
SM
1258 (fnh-elem (cons ffap-url-regexp 'url-file-handler)))
1259 ;; Explain to `rfn-eshadow' that we can use URLs here.
1260 (push fnh-elem file-name-handler-alist)
1261 (unwind-protect
1262 (setq guess
984ddcbc
SM
1263 (let ((default-directory (if dir (expand-file-name dir)
1264 default-directory)))
1265 (completing-read
1266 prompt
1267 'ffap-read-file-or-url-internal
1268 nil
1269 nil
1270 (if dir (cons guess (length dir)) guess)
1271 (list 'file-name-history)
1272 (and buffer-file-name
1273 (abbreviate-file-name buffer-file-name)))))
ea27e496
SM
1274 ;; Remove the special handler manually. We used to just let-bind
1275 ;; file-name-handler-alist to preserve its value, but that caused
1276 ;; other modifications to be lost (e.g. when Tramp gets loaded
1277 ;; during the completing-read call).
1278 (setq file-name-handler-alist (delq fnh-elem file-name-handler-alist))))
a3680194
CY
1279 (or (ffap-url-p guess)
1280 (substitute-in-file-name guess))))
213d9a4f 1281
984ddcbc 1282(defun ffap-read-url-internal (string pred action)
4454adab 1283 "Complete URLs from history, treating given string as valid."
a0d1aadf 1284 (let ((hist (ffap-symbol-value 'url-global-history-hash-table)))
213d9a4f
RS
1285 (cond
1286 ((not action)
984ddcbc 1287 (or (try-completion string hist pred) string))
213d9a4f 1288 ((eq action t)
984ddcbc 1289 (or (all-completions string hist pred) (list string)))
87e2d039
RS
1290 ;; action == lambda, documented where? Tests whether string is a
1291 ;; valid "match". Let us always say yes.
1292 (t t))))
213d9a4f 1293
984ddcbc 1294(defun ffap-read-file-or-url-internal (string pred action)
a3680194
CY
1295 (let ((url (ffap-url-p string)))
1296 (if url
1297 (ffap-read-url-internal url pred action)
1298 (read-file-name-internal (or string default-directory) pred action))))
213d9a4f 1299
87e2d039
RS
1300;; The rest of this page is just to work with package complete.el.
1301;; This code assumes that you load ffap.el after complete.el.
1302;;
1303;; We must inform complete about whether our completion function
8daa9f3d 1304;; will do filename style completion.
87e2d039 1305
213d9a4f 1306\f
0948761d 1307;;; Highlighting (`ffap-highlight'):
213d9a4f 1308
33514810 1309(defvar ffap-highlight t
213d9a4f
RS
1310 "If non-nil, ffap highlights the current buffer substring.")
1311
dfe72966
JL
1312(defface ffap
1313 '((t :inherit highlight))
1314 "Face used to highlight the current buffer substring."
1315 :group 'ffap
1316 :version "22.1")
1317
0948761d 1318(defvar ffap-highlight-overlay nil
9fc9a531 1319 "Overlay used by function `ffap-highlight'.")
213d9a4f
RS
1320
1321(defun ffap-highlight (&optional remove)
87e2d039
RS
1322 "If `ffap-highlight' is set, highlight the guess in this buffer.
1323That is, the last buffer substring found by `ffap-string-at-point'.
213d9a4f 1324Optional argument REMOVE means to remove any such highlighting.
87e2d039 1325Uses the face `ffap' if it is defined, or else `highlight'."
213d9a4f 1326 (cond
0948761d
KH
1327 (remove
1328 (and ffap-highlight-overlay
3788c735
KH
1329 (delete-overlay ffap-highlight-overlay))
1330 )
213d9a4f 1331 ((not ffap-highlight) nil)
87e2d039 1332 (ffap-highlight-overlay
3788c735
KH
1333 (move-overlay
1334 ffap-highlight-overlay
1335 (car ffap-string-at-point-region)
1336 (nth 1 ffap-string-at-point-region)
1337 (current-buffer)))
213d9a4f 1338 (t
0948761d 1339 (setq ffap-highlight-overlay
3788c735 1340 (apply 'make-overlay ffap-string-at-point-region))
dfe72966 1341 (overlay-put ffap-highlight-overlay 'face 'ffap))))
87e2d039 1342
213d9a4f 1343\f
3788c735 1344;;; Main Entrance (`find-file-at-point' == `ffap'):
213d9a4f 1345
a0d1aadf 1346(defun ffap-guesser ()
0948761d 1347 "Return file or URL or nil, guessed from text around point."
213d9a4f
RS
1348 (or (and ffap-url-regexp
1349 (ffap-fixup-url (or (ffap-url-at-point)
1350 (ffap-gopher-at-point))))
1351 (ffap-file-at-point) ; may yield url!
1352 (ffap-fixup-machine (ffap-machine-at-point))))
1353
1354(defun ffap-prompter (&optional guess)
1355 ;; Does guess and prompt step for find-file-at-point.
87e2d039 1356 ;; Extra complication for the temporary highlighting.
213d9a4f 1357 (unwind-protect
3788c735
KH
1358 ;; This catch will let ffap-alist entries do their own prompting
1359 ;; and then maybe skip over this prompt (ff-paths, for example).
1360 (catch 'ffap-prompter
1361 (ffap-read-file-or-url
1362 (if ffap-url-regexp "Find file or URL: " "Find file: ")
1363 (prog1
1961ef04
SM
1364 (let ((mark-active nil))
1365 ;; Don't use the region here, since it can be something
1366 ;; completely unwieldy. If the user wants that, she could
1367 ;; use M-w before and then C-y. --Stef
1368 (setq guess (or guess (ffap-guesser)))) ; using ffap-alist here
3788c735
KH
1369 (and guess (ffap-highlight))
1370 )))
213d9a4f
RS
1371 (ffap-highlight t)))
1372
1373;;;###autoload
1374(defun find-file-at-point (&optional filename)
0948761d
KH
1375 "Find FILENAME, guessing a default from text around point.
1376If `ffap-url-regexp' is not nil, the FILENAME may also be an URL.
1377With a prefix, this command behaves exactly like `ffap-file-finder'.
213d9a4f 1378If `ffap-require-prefix' is set, the prefix meaning is reversed.
0948761d 1379See also the variables `ffap-dired-wildcards', `ffap-newfile-prompt',
57eb2e24 1380and the functions `ffap-file-at-point' and `ffap-url-at-point'."
213d9a4f 1381 (interactive)
32226619 1382 (if (and (called-interactively-p 'interactive)
213d9a4f
RS
1383 (if ffap-require-prefix (not current-prefix-arg)
1384 current-prefix-arg))
1385 ;; Do exactly the ffap-file-finder command, even the prompting:
87e2d039
RS
1386 (let (current-prefix-arg) ; we already interpreted it
1387 (call-interactively ffap-file-finder))
213d9a4f 1388 (or filename (setq filename (ffap-prompter)))
a3680194
CY
1389 (let ((url (ffap-url-p filename)))
1390 (cond
1391 (url
1392 (let (current-prefix-arg)
1393 (funcall ffap-url-fetcher url)))
1394 ((and ffap-pass-wildcards-to-dired
1395 ffap-dired-wildcards
1396 (string-match ffap-dired-wildcards filename))
1397 (funcall ffap-directory-finder filename))
1398 ((and ffap-dired-wildcards
1399 (string-match ffap-dired-wildcards filename)
1400 find-file-wildcards
1401 ;; Check if it's find-file that supports wildcards arg
1402 (memq ffap-file-finder '(find-file find-alternate-file)))
1403 (funcall ffap-file-finder (expand-file-name filename) t))
1404 ((or (not ffap-newfile-prompt)
1405 (file-exists-p filename)
1406 (y-or-n-p "File does not exist, create buffer? "))
1407 (funcall ffap-file-finder
1408 ;; expand-file-name fixes "~/~/.emacs" bug sent by CHUCKR.
1409 (expand-file-name filename)))
1410 ;; User does not want to find a non-existent file:
1411 ((signal 'file-error (list "Opening file buffer"
1412 "no such file or directory"
1413 filename)))))))
213d9a4f 1414
0948761d 1415;; Shortcut: allow {M-x ffap} rather than {M-x find-file-at-point}.
22ac7ca0
MR
1416;;;###autoload
1417(defalias 'ffap 'find-file-at-point)
1418
213d9a4f 1419\f
0948761d 1420;;; Menu support (`ffap-menu'):
213d9a4f 1421
78f3273a
CY
1422(defcustom ffap-menu-regexp nil
1423 "If non-nil, regexp overriding `ffap-next-regexp' in `ffap-menu'.
213d9a4f 1424Make this more restrictive for faster menu building.
78f3273a
CY
1425For example, try \":/\" for URL (and some ftp) references."
1426 :type '(choice (const nil) regexp)
1427 :group 'ffap)
213d9a4f
RS
1428
1429(defvar ffap-menu-alist nil
87e2d039 1430 "Buffer local cache of menu presented by `ffap-menu'.")
213d9a4f
RS
1431(make-variable-buffer-local 'ffap-menu-alist)
1432
87e2d039 1433(defvar ffap-menu-text-plist
3788c735 1434 (cond
33514810
EZ
1435 ((display-mouse-p) '(face bold mouse-face highlight)) ; keymap <mousy-map>
1436 (t nil))
87e2d039
RS
1437 "Text properties applied to strings found by `ffap-menu-rescan'.
1438These properties may be used to fontify the menu references.")
1439
213d9a4f
RS
1440;;;###autoload
1441(defun ffap-menu (&optional rescan)
4454adab 1442 "Put up a menu of files and URLs mentioned in this buffer.
87e2d039
RS
1443Then set mark, jump to choice, and try to fetch it. The menu is
1444cached in `ffap-menu-alist', and rebuilt by `ffap-menu-rescan'.
1445The optional RESCAN argument \(a prefix, interactively\) forces
1446a rebuild. Searches with `ffap-menu-regexp'."
213d9a4f
RS
1447 (interactive "P")
1448 ;; (require 'imenu) -- no longer used, but roughly emulated
1449 (if (or (not ffap-menu-alist) rescan
1450 ;; or if the first entry is wrong:
1451 (and ffap-menu-alist
1452 (let ((first (car ffap-menu-alist)))
1453 (save-excursion
1454 (goto-char (cdr first))
1455 (not (equal (car first) (ffap-guesser)))))))
1456 (ffap-menu-rescan))
1457 ;; Tail recursive:
1458 (ffap-menu-ask
1459 (if ffap-url-regexp "Find file or URL" "Find file")
1460 (cons (cons "*Rescan Buffer*" -1) ffap-menu-alist)
1461 'ffap-menu-cont))
1462
1463(defun ffap-menu-cont (choice) ; continuation of ffap-menu
1464 (if (< (cdr choice) 0)
1465 (ffap-menu t) ; *Rescan*
1466 (push-mark)
1467 (goto-char (cdr choice))
1468 ;; Momentary highlight:
1469 (unwind-protect
1470 (progn
1471 (and ffap-highlight (ffap-guesser) (ffap-highlight))
1472 (sit-for 0) ; display
1473 (find-file-at-point (car choice)))
1474 (ffap-highlight t))))
1475
1476(defun ffap-menu-ask (title alist cont)
1477 "Prompt from a menu of choices, and then apply some action.
0948761d 1478Arguments are TITLE, ALIST, and CONT \(a continuation function\).
213d9a4f
RS
1479This uses either a menu or the minibuffer depending on invocation.
1480The TITLE string is used as either the prompt or menu title.
ee79ced8 1481Each ALIST entry looks like (STRING . DATA) and defines one choice.
0948761d
KH
1482Function CONT is applied to the entry chosen by the user."
1483 ;; Note: this function is used with a different continuation
1484 ;; by the ffap-url add-on package.
1485 ;; Could try rewriting to use easymenu.el or lmenu.el.
1486 (let (choice)
1487 (cond
1488 ;; Emacs mouse:
1489 ((and (fboundp 'x-popup-menu) (ffap-mouse-event))
1490 (setq choice
1491 (x-popup-menu
1492 t
1493 (list "" (cons title
984ddcbc 1494 (mapcar (lambda (i) (cons (car i) i))
0948761d
KH
1495 alist))))))
1496 ;; minibuffer with completion buffer:
1497 (t
1498 (let ((minibuffer-setup-hook 'minibuffer-completion-help))
1499 ;; Bug: prompting may assume unique strings, no "".
1500 (setq choice
1501 (completing-read
1502 (format "%s (default %s): " title (car (car alist)))
1503 alist nil t
1504 ;; (cons (car (car alist)) 0)
1505 nil)))
1506 (sit-for 0) ; redraw original screen
1507 ;; Convert string to its entry, or else the default:
984ddcbc 1508 (setq choice (or (assoc choice alist) (car alist)))))
0948761d
KH
1509 (if choice
1510 (funcall cont choice)
1511 (message "No choice made!") ; possible with menus
1512 nil)))
213d9a4f 1513
a0d1aadf 1514(defun ffap-menu-rescan ()
87e2d039
RS
1515 "Search buffer for `ffap-menu-regexp' to build `ffap-menu-alist'.
1516Applies `ffap-menu-text-plist' text properties at all matches."
213d9a4f
RS
1517 (interactive)
1518 (let ((ffap-next-regexp (or ffap-menu-regexp ffap-next-regexp))
0948761d
KH
1519 (range (- (point-max) (point-min)))
1520 (mod (buffer-modified-p)) ; was buffer modified?
e27de09e
EZ
1521 ;; inhibit-read-only works on read-only text properties
1522 ;; as well as read-only buffers.
1523 (inhibit-read-only t) ; to set text-properties
0948761d 1524 item
87e2d039
RS
1525 ;; Avoid repeated searches of the *mode-alist:
1526 (major-mode (if (assq major-mode ffap-string-at-point-mode-alist)
1527 major-mode
0948761d 1528 'file)))
213d9a4f 1529 (setq ffap-menu-alist nil)
0948761d
KH
1530 (unwind-protect
1531 (save-excursion
1532 (goto-char (point-min))
1533 (while (setq item (ffap-next-guess))
1534 (setq ffap-menu-alist (cons (cons item (point)) ffap-menu-alist))
1535 (add-text-properties (car ffap-string-at-point-region) (point)
1536 ffap-menu-text-plist)
1537 (message "Scanning...%2d%% <%s>"
1538 (/ (* 100 (- (point) (point-min))) range) item)))
984ddcbc 1539 (or mod (restore-buffer-modified-p nil))))
213d9a4f
RS
1540 (message "Scanning...done")
1541 ;; Remove duplicates.
1542 (setq ffap-menu-alist ; sort by item
1543 (sort ffap-menu-alist
1544 (function
1545 (lambda (a b) (string-lessp (car a) (car b))))))
0948761d 1546 (let ((ptr ffap-menu-alist)) ; remove duplicates
213d9a4f
RS
1547 (while (cdr ptr)
1548 (if (equal (car (car ptr)) (car (car (cdr ptr))))
1549 (setcdr ptr (cdr (cdr ptr)))
1550 (setq ptr (cdr ptr)))))
1551 (setq ffap-menu-alist ; sort by position
1552 (sort ffap-menu-alist
1553 (function
1554 (lambda (a b) (< (cdr a) (cdr b)))))))
1555
1556\f
0948761d 1557;;; Mouse Support (`ffap-at-mouse'):
213d9a4f 1558;;
87e2d039 1559;; See the suggested binding in ffap-bindings (near eof).
213d9a4f 1560
0948761d
KH
1561(defvar ffap-at-mouse-fallback nil ; ffap-menu? too time-consuming
1562 "Command invoked by `ffap-at-mouse' if nothing found at click, or nil.
1563Ignored when `ffap-at-mouse' is called programmatically.")
213d9a4f
RS
1564(put 'ffap-at-mouse-fallback 'risky-local-variable t)
1565
0948761d 1566;;;###autoload
213d9a4f 1567(defun ffap-at-mouse (e)
4454adab 1568 "Find file or URL guessed from text around mouse click.
3788c735
KH
1569Interactively, calls `ffap-at-mouse-fallback' if no guess is found.
1570Return value:
1571 * if a guess string is found, return it (after finding it)
1572 * if the fallback is called, return whatever it returns
1573 * otherwise, nil"
213d9a4f
RS
1574 (interactive "e")
1575 (let ((guess
1576 ;; Maybe less surprising without the save-excursion?
1577 (save-excursion
1578 (mouse-set-point e)
0948761d
KH
1579 ;; Would prefer to do nothing unless click was *on* text. How
1580 ;; to tell that the click was beyond the end of current line?
213d9a4f
RS
1581 (ffap-guesser))))
1582 (cond
1583 (guess
0948761d 1584 (set-buffer (ffap-event-buffer e))
213d9a4f
RS
1585 (ffap-highlight)
1586 (unwind-protect
1587 (progn
1588 (sit-for 0) ; display
0948761d
KH
1589 (message "Finding `%s'" guess)
1590 (find-file-at-point guess)
3788c735 1591 guess) ; success: return non-nil
213d9a4f 1592 (ffap-highlight t)))
32226619 1593 ((called-interactively-p 'interactive)
0948761d
KH
1594 (if ffap-at-mouse-fallback
1595 (call-interactively ffap-at-mouse-fallback)
4454adab 1596 (message "No file or URL found at mouse click.")
3788c735 1597 nil)) ; no fallback, return nil
0948761d
KH
1598 ;; failure: return nil
1599 )))
213d9a4f
RS
1600
1601\f
c99310d5 1602;;; ffap-other-*, ffap-read-only-*, ffap-alternate-* commands:
0948761d
KH
1603
1604;; There could be a real `ffap-noselect' function, but we would need
1605;; at least two new user variables, and there is no w3-fetch-noselect.
1606;; So instead, we just fake it with a slow save-window-excursion.
213d9a4f 1607
a0d1aadf 1608(defun ffap-other-window ()
0948761d
KH
1609 "Like `ffap', but put buffer in another window.
1610Only intended for interactive use."
213d9a4f 1611 (interactive)
c99310d5
JL
1612 (let (value)
1613 (switch-to-buffer-other-window
1614 (save-window-excursion
1615 (setq value (call-interactively 'ffap))
1616 (unless (or (bufferp value) (bufferp (car-safe value)))
1617 (setq value (current-buffer)))
1618 (current-buffer)))
1619 value))
213d9a4f 1620
a0d1aadf 1621(defun ffap-other-frame ()
0948761d
KH
1622 "Like `ffap', but put buffer in another frame.
1623Only intended for interactive use."
213d9a4f 1624 (interactive)
0948761d 1625 ;; Extra code works around dedicated windows (noted by JENS, 7/96):
c99310d5
JL
1626 (let* ((win (selected-window))
1627 (wdp (window-dedicated-p win))
1628 value)
0948761d
KH
1629 (unwind-protect
1630 (progn
1631 (set-window-dedicated-p win nil)
1632 (switch-to-buffer-other-frame
1633 (save-window-excursion
c99310d5
JL
1634 (setq value (call-interactively 'ffap))
1635 (unless (or (bufferp value) (bufferp (car-safe value)))
1636 (setq value (current-buffer)))
0948761d 1637 (current-buffer))))
c99310d5
JL
1638 (set-window-dedicated-p win wdp))
1639 value))
1640
b68b3337
CY
1641(defun ffap--toggle-read-only (buffer-or-list)
1642 (dolist (buffer (if (listp buffer-or-list)
1643 buffer-or-list
1644 (list buffer-or-list)))
1645 (with-current-buffer buffer
35e62fc9 1646 (read-only-mode 1))))
9f9aa044 1647
c99310d5
JL
1648(defun ffap-read-only ()
1649 "Like `ffap', but mark buffer as read-only.
1650Only intended for interactive use."
1651 (interactive)
1652 (let ((value (call-interactively 'ffap)))
1653 (unless (or (bufferp value) (bufferp (car-safe value)))
1654 (setq value (current-buffer)))
b68b3337 1655 (ffap--toggle-read-only value)
c99310d5
JL
1656 value))
1657
1658(defun ffap-read-only-other-window ()
1659 "Like `ffap', but put buffer in another window and mark as read-only.
1660Only intended for interactive use."
1661 (interactive)
1662 (let ((value (ffap-other-window)))
b68b3337 1663 (ffap--toggle-read-only value)
c99310d5
JL
1664 value))
1665
1666(defun ffap-read-only-other-frame ()
1667 "Like `ffap', but put buffer in another frame and mark as read-only.
1668Only intended for interactive use."
1669 (interactive)
1670 (let ((value (ffap-other-frame)))
b68b3337 1671 (ffap--toggle-read-only value)
c99310d5
JL
1672 value))
1673
1674(defun ffap-alternate-file ()
1675 "Like `ffap' and `find-alternate-file'.
1676Only intended for interactive use."
1677 (interactive)
1678 (let ((ffap-file-finder 'find-alternate-file))
1679 (call-interactively 'ffap)))
213d9a4f 1680
e2685eb7
JL
1681(defun ffap-alternate-file-other-window ()
1682 "Like `ffap' and `find-alternate-file-other-window'.
1683Only intended for interactive use."
1684 (interactive)
1685 (let ((ffap-file-finder 'find-alternate-file-other-window))
1686 (call-interactively 'ffap)))
1687
1688(defun ffap-literally ()
9fc9a531 1689 "Like `ffap' and command `find-file-literally'.
e2685eb7
JL
1690Only intended for interactive use."
1691 (interactive)
1692 (let ((ffap-file-finder 'find-file-literally))
1693 (call-interactively 'ffap)))
1694
1695(defalias 'find-file-literally-at-point 'ffap-literally)
1696
213d9a4f 1697\f
87e2d039
RS
1698;;; Bug Reporter:
1699
36b5be6b
GM
1700(define-obsolete-function-alias 'ffap-bug 'report-emacs-bug "23.1")
1701(define-obsolete-function-alias 'ffap-submit-bug 'report-emacs-bug "23.1")
213d9a4f
RS
1702
1703\f
87e2d039 1704;;; Hooks for Gnus, VM, Rmail:
213d9a4f 1705;;
87e2d039
RS
1706;; If you do not like these bindings, write versions with whatever
1707;; bindings you would prefer.
213d9a4f 1708
a0d1aadf 1709(defun ffap-ro-mode-hook ()
87e2d039
RS
1710 "Bind `ffap-next' and `ffap-menu' to M-l and M-m, resp."
1711 (local-set-key "\M-l" 'ffap-next)
9f9aa044 1712 (local-set-key "\M-m" 'ffap-menu))
213d9a4f 1713
a0d1aadf 1714(defun ffap-gnus-hook ()
87e2d039 1715 "Bind `ffap-gnus-next' and `ffap-gnus-menu' to M-l and M-m, resp."
6e5c1569
CY
1716 ;; message-id's
1717 (setq-local thing-at-point-default-mail-uri-scheme "news")
87e2d039
RS
1718 ;; Note "l", "L", "m", "M" are taken:
1719 (local-set-key "\M-l" 'ffap-gnus-next)
1720 (local-set-key "\M-m" 'ffap-gnus-menu))
213d9a4f 1721
9890a229
RS
1722(defvar gnus-summary-buffer)
1723(defvar gnus-article-buffer)
1724
36b5be6b
GM
1725;; This code is called from gnus.
1726(declare-function gnus-summary-select-article "gnus-sum"
1727 (&optional all-headers force pseudo article))
1728
1729(declare-function gnus-configure-windows "gnus-win"
1730 (setting &optional force))
1731
87e2d039
RS
1732(defun ffap-gnus-wrapper (form) ; used by both commands below
1733 (and (eq (current-buffer) (get-buffer gnus-summary-buffer))
1734 (gnus-summary-select-article)) ; get article of current line
1735 ;; Preserve selected buffer, but do not do save-window-excursion,
1736 ;; since we want to see any window created by the form. Temporarily
1737 ;; select the article buffer, so we can see any point movement.
1738 (let ((sb (window-buffer (selected-window))))
1739 (gnus-configure-windows 'article)
1740 (pop-to-buffer gnus-article-buffer)
1741 (widen)
1742 ;; Skip headers for ffap-gnus-next (which will wrap around)
1743 (if (eq (point) (point-min)) (search-forward "\n\n" nil t))
1744 (unwind-protect
1745 (eval form)
1746 (pop-to-buffer sb))))
1747
a0d1aadf 1748(defun ffap-gnus-next ()
87e2d039
RS
1749 "Run `ffap-next' in the gnus article buffer."
1750 (interactive) (ffap-gnus-wrapper '(ffap-next nil t)))
1751
a0d1aadf 1752(defun ffap-gnus-menu ()
87e2d039
RS
1753 "Run `ffap-menu' in the gnus article buffer."
1754 (interactive) (ffap-gnus-wrapper '(ffap-menu)))
1755
1756\f
61154252
RS
1757
1758;;;###autoload
1759(defun dired-at-point (&optional filename)
918fe50f
JL
1760 "Start Dired, defaulting to file at point. See `ffap'.
1761If `dired-at-point-require-prefix' is set, the prefix meaning is reversed."
61154252 1762 (interactive)
32226619 1763 (if (and (called-interactively-p 'interactive)
61154252
RS
1764 (if dired-at-point-require-prefix
1765 (not current-prefix-arg)
1766 current-prefix-arg))
1767 (let (current-prefix-arg) ; already interpreted
c99310d5 1768 (call-interactively ffap-directory-finder))
61154252 1769 (or filename (setq filename (dired-at-point-prompter)))
a3680194
CY
1770 (let ((url (ffap-url-p filename)))
1771 (cond
1772 (url
1773 (funcall ffap-url-fetcher url))
1774 ((and ffap-dired-wildcards
1775 (string-match ffap-dired-wildcards filename))
1776 (funcall ffap-directory-finder filename))
1777 ((file-exists-p filename)
1778 (if (file-directory-p filename)
1779 (funcall ffap-directory-finder
1780 (expand-file-name filename))
c99310d5 1781 (funcall ffap-directory-finder
a3680194
CY
1782 (concat (expand-file-name filename) "*"))))
1783 ((and (file-writable-p
1784 (or (file-name-directory (directory-file-name filename))
1785 filename))
1786 (y-or-n-p "Directory does not exist, create it? "))
1787 (make-directory filename)
1788 (funcall ffap-directory-finder filename))
1789 ((error "No such file or directory `%s'" filename))))))
61154252
RS
1790
1791(defun dired-at-point-prompter (&optional guess)
1792 ;; Does guess and prompt step for find-file-at-point.
1793 ;; Extra complication for the temporary highlighting.
1794 (unwind-protect
1795 (ffap-read-file-or-url
0fdc185e
MR
1796 (cond
1797 ((eq ffap-directory-finder 'list-directory)
1798 "List directory (brief): ")
1799 (ffap-url-regexp "Dired file or URL: ")
1800 (t "Dired file: "))
61154252 1801 (prog1
a3680194
CY
1802 (setq guess
1803 (let ((guess (or guess (ffap-guesser))))
1804 (cond
1805 ((null guess) nil)
1806 ((ffap-url-p guess))
1807 ((ffap-file-remote-p guess)
1808 guess)
1809 ((progn
1810 (setq guess (abbreviate-file-name
1811 (expand-file-name guess)))
1812 ;; Interpret local directory as a directory.
1813 (file-directory-p guess))
1814 (file-name-as-directory guess))
1815 ;; Get directory component from local files.
1816 ((file-regular-p guess)
1817 (file-name-directory guess))
1818 (guess))))
0f76d837 1819 (and guess (ffap-highlight))))
61154252
RS
1820 (ffap-highlight t)))
1821\f
c99310d5
JL
1822;;; ffap-dired-other-*, ffap-list-directory commands:
1823
1824(defun ffap-dired-other-window ()
1825 "Like `dired-at-point', but put buffer in another window.
1826Only intended for interactive use."
1827 (interactive)
1828 (let (value)
1829 (switch-to-buffer-other-window
1830 (save-window-excursion
1831 (setq value (call-interactively 'dired-at-point))
1832 (current-buffer)))
1833 value))
1834
1835(defun ffap-dired-other-frame ()
1836 "Like `dired-at-point', but put buffer in another frame.
1837Only intended for interactive use."
1838 (interactive)
1839 ;; Extra code works around dedicated windows (noted by JENS, 7/96):
1840 (let* ((win (selected-window))
1841 (wdp (window-dedicated-p win))
1842 value)
1843 (unwind-protect
1844 (progn
1845 (set-window-dedicated-p win nil)
1846 (switch-to-buffer-other-frame
1847 (save-window-excursion
1848 (setq value (call-interactively 'dired-at-point))
1849 (current-buffer))))
1850 (set-window-dedicated-p win wdp))
1851 value))
1852
1853(defun ffap-list-directory ()
1854 "Like `dired-at-point' and `list-directory'.
1855Only intended for interactive use."
1856 (interactive)
1857 (let ((ffap-directory-finder 'list-directory))
1858 (call-interactively 'dired-at-point)))
1859
1860\f
7d371eac
JL
1861;;; Hooks to put in `file-name-at-point-functions':
1862
1863;;;###autoload
9f9aa044 1864(defun ffap-guess-file-name-at-point ()
7d371eac 1865 "Try to get a file name at point.
a0d1aadf 1866This hook is intended to be put in `file-name-at-point-functions'."
a3680194
CY
1867 (let ((guess (ffap-guesser)))
1868 (when (stringp guess)
1869 (let ((url (ffap-url-p guess)))
1870 (or url
1871 (progn
1872 (unless (ffap-file-remote-p guess)
1873 (setq guess
1874 (abbreviate-file-name (expand-file-name guess))))
1875 (if (file-directory-p guess)
1876 (file-name-as-directory guess)
1877 guess)))))))
7d371eac 1878\f
0948761d 1879;;; Offer default global bindings (`ffap-bindings'):
87e2d039
RS
1880
1881(defvar ffap-bindings
9f9aa044 1882 '((global-set-key [S-mouse-3] 'ffap-at-mouse)
3788c735 1883 (global-set-key [C-S-mouse-3] 'ffap-menu)
c99310d5 1884
3788c735 1885 (global-set-key "\C-x\C-f" 'find-file-at-point)
c99310d5
JL
1886 (global-set-key "\C-x\C-r" 'ffap-read-only)
1887 (global-set-key "\C-x\C-v" 'ffap-alternate-file)
1888
3788c735
KH
1889 (global-set-key "\C-x4f" 'ffap-other-window)
1890 (global-set-key "\C-x5f" 'ffap-other-frame)
c99310d5
JL
1891 (global-set-key "\C-x4r" 'ffap-read-only-other-window)
1892 (global-set-key "\C-x5r" 'ffap-read-only-other-frame)
1893
3d729a9a 1894 (global-set-key "\C-xd" 'dired-at-point)
c99310d5
JL
1895 (global-set-key "\C-x4d" 'ffap-dired-other-window)
1896 (global-set-key "\C-x5d" 'ffap-dired-other-frame)
1897 (global-set-key "\C-x\C-d" 'ffap-list-directory)
1898
3788c735
KH
1899 (add-hook 'gnus-summary-mode-hook 'ffap-gnus-hook)
1900 (add-hook 'gnus-article-mode-hook 'ffap-gnus-hook)
1901 (add-hook 'vm-mode-hook 'ffap-ro-mode-hook)
9f9aa044 1902 (add-hook 'rmail-mode-hook 'ffap-ro-mode-hook))
3788c735 1903 "List of binding forms evaluated by function `ffap-bindings'.
148b5960 1904A reasonable ffap installation needs just this one line:
87e2d039 1905 (ffap-bindings)
0948761d 1906Of course if you do not like these bindings, just roll your own!")
87e2d039 1907
25050dab 1908;;;###autoload
a0d1aadf 1909(defun ffap-bindings ()
87e2d039 1910 "Evaluate the forms in variable `ffap-bindings'."
25050dab 1911 (interactive)
87e2d039
RS
1912 (eval (cons 'progn ffap-bindings)))
1913
87e2d039 1914\f
4648ccdf 1915(provide 'ffap)
ab5796a9 1916
213d9a4f 1917;;; ffap.el ends here