1 ;;; ffap.el --- find file or URL at point
3 ;; Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michelangelo Grigni <mic@mathcs.emory.edu>
6 ;; Created: 29 Mar 1993
7 ;; Keywords: files, hypermedia, matching, mouse
8 ;; X-Latest: ftp://ftp.mathcs.emory.edu:/pub/mic/emacs/
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
30 ;; Command find-file-at-point replaces find-file. With a prefix, it
31 ;; behaves exactly like find-file. Without a prefix, it first tries
32 ;; to guess a default file or URL from the text around the point
33 ;; (`ffap-require-prefix' swaps these behaviors). This is useful for
34 ;; following references in situations such as mail or news buffers,
35 ;; README's, MANIFEST's, and so on. Submit bugs or suggestions with
38 ;; For the default installation, byte-compile ffap.el somewhere in
39 ;; your `load-path' and add these two lines to your .emacs file:
41 ;; (require 'ffap) ; load the package
42 ;; (ffap-bindings) ; do default key bindings
44 ;; ffap-bindings makes the following global key bindings:
46 ;; C-x C-f find-file-at-point (abbreviated as ffap)
47 ;; C-x 4 f ffap-other-window
48 ;; C-x 5 f ffap-other-frame
49 ;; S-mouse-3 ffap-at-mouse
51 ;; ffap-bindings also adds hooks to make the following local bindings
52 ;; in vm, gnus, and rmail:
54 ;; M-l ffap-next, or ffap-gnus-next in gnus
55 ;; M-m ffap-menu, or ffap-gnus-menu in gnus
57 ;; If you do not like these bindings, modify the variable
58 ;; `ffap-bindings', or write your own.
60 ;; If you use ange-ftp, browse-url, complete, efs, or w3, it is best
61 ;; to load or autoload them before ffap. If you use ff-paths, load it
62 ;; afterwards. Try apropos {C-h a ffap RET} to get a list of the many
63 ;; option variables. In particular, if ffap is slow, try these:
65 ;; (setq ffap-alist nil) ; faster, dumber prompting
66 ;; (setq ffap-machine-p-known 'accept) ; no pinging
67 ;; (setq ffap-url-regexp nil) ; disable URL features in ffap
69 ;; ffap uses w3 (if found) or else browse-url to fetch URL's. For
70 ;; a hairier `ffap-url-fetcher', try ffap-url.el (same ftp site).
71 ;; Also, you can add `ffap-menu-rescan' to various hooks to fontify
72 ;; the file and URL references within a buffer.
75 ;; * recognize paths inside /usr/bin:/bin:/etc, ./ffap.el:80:
76 ;; * let "/path/file#key" jump to key (offset or regexp) in /path/file
77 ;; * find file of symbol if TAGS is loaded (like above)
78 ;; * break up long menus into multiple panes (like imenu?)
79 ;; * notice node in "(dired)Virtual Dired" (handle the space?)
80 ;; * notice "machine.dom blah blah blah path/file" (how?)
81 ;; * if w3 becomes standard, could rewrite to use its functions
82 ;; * regexp options for ffap-string-at-point, like font-lock (MCOOK)
83 ;; * v19: could replace `ffap-locate-file' with a quieter `locate-library'
84 ;; * support for custom.el
85 ;; + handle "$(HOME)" in Makefiles?
86 ;; + modify `font-lock-keywords' to do fontification
93 ;; Versions: This file is tested with Emacs 19.30. It mostly works
94 ;; with XEmacs, but get ffap-xe.el for the popup menu. Emacs 18 is
95 ;; now abandoned (get ffap-15.el instead).
97 (defvar ffap-xemacs
(and (string-match "X[Ee]macs" emacs-version
) t
)
98 "Whether ffap thinks it is running under XEmacs.")
105 "Find file or URL at point."
109 ;; This function is used inside defvars:
110 (defmacro ffap-soft-value
(name &optional default
)
111 "Return value of symbol with NAME, if it is interned.
112 Otherwise return nil (or the optional DEFAULT value)."
113 ;; Bug: (ffap-soft-value "nil" 5) --> 5
114 (let ((sym (intern-soft name
)))
115 (if (and sym
(boundp sym
))
120 (defcustom ffap-ftp-regexp
122 (or (featurep 'ange-ftp
)
124 (and (boundp 'file-name-handler-alist
) ; v19
125 (or (rassq 'ange-ftp-hook-function file-name-handler-alist
)
126 (rassq 'efs-file-handler-function file-name-handler-alist
))))
127 ;; Apparently this is good enough for both ange-ftp and efs:
129 "*Treat paths matching this as remote ftp paths. nil to disable.
130 nil also disables the generation of such paths by ffap."
131 :type
'(choice (const :tag
"Disable" nil
)
135 (defcustom ffap-url-unwrap-local t
136 "*If non-nil, convert \"file:\" URL to local path before prompting."
140 (defcustom ffap-url-unwrap-remote t
141 "*If non-nil, convert \"ftp:\" URL to remote path before prompting.
142 This is ignored if `ffap-ftp-regexp' is nil."
146 (defcustom ffap-ftp-default-user
148 "*User name in ftp paths generated by `ffap-host-to-path'.
149 nil to rely on `efs-default-user' or `ange-ftp-default-user'."
150 :type
'(choice (const :tag
"Default" nil
)
154 (defcustom ffap-rfs-regexp
155 ;; Remote file access built into file system? HP rfa or Andrew afs:
156 "\\`/\\(afs\\|net\\)/."
157 ;; afs only: (and (file-exists-p "/afs") "\\`/afs/.")
158 "*Matching paths are treated as remote. nil to disable."
162 (defvar ffap-url-regexp
163 ;; Could just use `url-nonrelative-link' of w3, if loaded.
164 ;; This regexp is not exhaustive, it just matches common cases.
167 "news\\(post\\)?:\\|mailto:\\|file:" ; no host ok
169 "\\(ftp\\|http\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host
170 "\\)." ; require one more character
172 "Regexp matching URL's. nil to disable URL features in ffap.")
174 (defcustom ffap-foo-at-bar-prefix
"mailto"
175 "*Presumed URL prefix type of strings like \"<foo.9z@bar>\".
176 Sensible values are nil, \"news\", or \"mailto\"."
183 ;; Users of ffap occasionally suggest new features. If I consider
184 ;; those features interesting but not clear winners (a matter of
185 ;; personal taste) I try to leave options to enable them. Read
186 ;; through this section for features that you like, put an appropriate
187 ;; enabler in your .emacs file.
189 (defcustom ffap-dired-wildcards nil
; "[*?][^/]*$"
190 ;; Suggestion from RHOGEE, 07 Jul 1994. Disabled, dired is still
191 ;; available by "C-x C-d <pattern>", and valid filenames may
192 ;; sometimes contain wildcard characters.
193 "*A regexp matching filename wildcard characters, or nil.
194 If `find-file-at-point' gets a filename matching this pattern,
195 it passes it on to `dired' instead of `find-file'."
196 :type
'(choice (const :tag
"off" nil
)
200 (defcustom ffap-newfile-prompt nil
; t
201 ;; Suggestion from RHOGEE, 11 Jul 1994. Disabled, I think this is
202 ;; better handled by `find-file-not-found-hooks'.
203 "*Whether `find-file-at-point' prompts about a nonexistent file."
207 (defcustom ffap-require-prefix nil
208 ;; Suggestion from RHOGEE, 20 Oct 1994.
209 "*If set, reverses the prefix argument to `find-file-at-point'.
210 This is nil so neophytes notice ffap. Experts may prefer to disable
211 ffap most of the time."
215 (defcustom ffap-file-finder
'find-file
216 "*The command called by `find-file-at-point' to find a file."
219 (put 'ffap-file-finder
'risky-local-variable t
)
221 (defcustom ffap-url-fetcher
222 (cond ((fboundp 'w3-fetch
) 'w3-fetch
)
223 ((fboundp 'browse-url-netscape
) 'browse-url-netscape
)
225 ;; Remote control references:
226 ;; http://www.ncsa.uiuc.edu/SDG/Software/XMosaic/remote-control.html
227 ;; http://home.netscape.com/newsref/std/x-remote.html
228 "*A function of one argument, called by ffap to fetch an URL.
229 Reasonable choices are `w3-fetch' or `browse-url-netscape'.
230 For a fancier alternative, get ffap-url.el."
233 (put 'ffap-url-fetcher
'risky-local-variable t
)
236 ;;; Command ffap-next:
238 ;; Original ffap-next-url (URL's only) from RPECK 30 Mar 1995. Since
239 ;; then, broke it up into ffap-next-guess (noninteractive) and
240 ;; ffap-next (a command). It now work on files as well as url's.
242 (defcustom ffap-next-regexp
243 ;; If you want ffap-next to find URL's only, try this:
244 ;; (and ffap-url-regexp (string-match "\\\\`" ffap-url-regexp)
245 ;; (concat "\\<" (substring ffap-url-regexp 2))))
247 ;; It pays to put a big fancy regexp here, since ffap-guesser is
248 ;; much more time-consuming than regexp searching:
249 "[/:.~a-zA-Z]/\\|@[a-zA-Z][-a-zA-Z0-9]*\\."
250 "*Regular expression governing movements of `ffap-next'."
254 (defvar ffap-next-guess nil
255 "Last value returned by `ffap-next-guess'.")
257 (defvar ffap-string-at-point-region
'(1 1)
258 "List (BEG END), last region returned by `ffap-string-at-point'.")
260 (defun ffap-next-guess (&optional back lim
)
261 "Move point to next file or URL, and return it as a string.
262 If nothing is found, leave point at limit and return nil.
263 Optional BACK argument makes search backwards.
264 Optional LIM argument limits the search.
265 Only considers strings that match `ffap-next-regexp'."
266 (or lim
(setq lim
(if back
(point-min) (point-max))))
268 (while (not (or guess
(eq (point) lim
)))
269 (funcall (if back
're-search-backward
're-search-forward
)
270 ffap-next-regexp lim
'move
)
271 (setq guess
(ffap-guesser)))
272 ;; Go to end, so we do not get same guess twice:
273 (goto-char (nth (if back
0 1) ffap-string-at-point-region
))
274 (setq ffap-next-guess guess
)))
277 (defun ffap-next (&optional back wrap
)
278 "Search buffer for next file or URL, and run ffap.
279 Optional argument BACK says to search backwards.
280 Optional argument WRAP says to try wrapping around if necessary.
281 Interactively: use a single prefix to search backwards,
282 double prefix to wrap forward, triple to wrap backwards.
283 Actual search is done by `ffap-next-guess'."
285 (cdr (assq (prefix-numeric-value current-prefix-arg
)
286 '((1) (4 t
) (16 nil t
) (64 t t
)))))
288 (guess (ffap-next-guess back
)))
289 ;; Try wraparound if necessary:
290 (and (not guess
) wrap
291 (goto-char (if back
(point-max) (point-min)))
292 (setq guess
(ffap-next-guess back pt
)))
295 (sit-for 0) ; display point movement
296 (find-file-at-point (ffap-prompter guess
)))
297 (goto-char pt
) ; restore point
298 (message "No %sfiles or URL's found"
299 (if wrap
"" "more ")))))
301 (defun ffap-next-url (&optional back wrap
)
302 "Like `ffap-next', but search with `ffap-url-regexp'."
304 (let ((ffap-next-regexp ffap-url-regexp
))
306 (call-interactively 'ffap-next
)
307 (ffap-next back wrap
))))
310 ;;; Remote machines and paths:
312 (defun ffap-replace-path-component (fullname name
)
313 "In remote FULLNAME, replace path with NAME. May return nil."
314 ;; Use ange-ftp or efs if loaded, but do not load them otherwise.
317 (function (lambda (sym) (and (fboundp sym
) (setq found sym
))))
319 efs-replace-path-component
320 ange-ftp-replace-path-component
321 ange-ftp-replace-name-component
324 (fset 'ffap-replace-path-component found
)
325 (funcall found fullname name
))))
326 ;; (ffap-replace-path-component "/who@foo.com:/whatever" "/new")
328 (defun ffap-file-exists-string (file)
329 ;; With certain packages (ange-ftp, jka-compr?) file-exists-p
330 ;; sometimes returns a nicer string than it is given. Otherwise, it
331 ;; just returns nil or t.
332 "Return FILE \(maybe modified\) if it exists, else nil."
333 (and file
; quietly reject nil
334 (let ((exists (file-exists-p file
)))
335 (and exists
(if (stringp exists
) exists file
)))))
337 ;; I cannot decide a "best" strategy here, so these are variables. In
338 ;; particular, if `Pinging...' is broken or takes too long on your
339 ;; machine, try setting these all to accept or reject.
340 (defcustom ffap-machine-p-local
'reject
; this happens often
341 "*A symbol, one of: ping, accept, reject.
342 What `ffap-machine-p' does with hostnames that have no domain."
343 :type
'(choice (const ping
)
347 (defcustom ffap-machine-p-known
'ping
; 'accept for speed
348 "*A symbol, one of: ping, accept, reject.
349 What `ffap-machine-p' does with hostnames that have a known domain
350 \(see mail-extr.el for the known domains\)."
351 :type
'(choice (const ping
)
355 (defcustom ffap-machine-p-unknown
'reject
356 "*A symbol, one of: ping, accept, reject.
357 What `ffap-machine-p' does with hostnames that have an unknown domain
358 \(see mail-extr.el for the known domains\)."
359 :type
'(choice (const ping
)
364 (defun ffap-what-domain (domain)
365 ;; Like what-domain in mail-extr.el, returns string or nil.
367 (get (intern-soft (downcase domain
) mail-extr-all-top-level-domains
)
370 (defun ffap-machine-p (host &optional service quiet strategy
)
371 "Decide whether HOST is the name of a real, reachable machine.
372 Depending on the domain (none, known, or unknown), follow the strategy
373 named by the variable `ffap-machine-p-local', `ffap-machine-p-known',
374 or `ffap-machine-p-unknown'. Pinging uses `open-network-stream'.
375 Optional SERVICE specifies the port used \(default \"discard\"\).
376 Optional QUIET flag suppresses the \"Pinging...\" message.
377 Optional STRATEGY overrides the three variables above.
379 t means that HOST answered.
380 'accept means the relevant variable told us to accept.
381 \"mesg\" means HOST exists, but does not respond for some reason."
382 ;; Try some (Emory local):
383 ;; (ffap-machine-p "ftp" nil nil 'ping)
384 ;; (ffap-machine-p "nonesuch" nil nil 'ping)
385 ;; (ffap-machine-p "ftp.mathcs.emory.edu" nil nil 'ping)
386 ;; (ffap-machine-p "mathcs" 5678 nil 'ping)
387 ;; (ffap-machine-p "foo.bonk" nil nil 'ping)
388 ;; (ffap-machine-p "foo.bonk.com" nil nil 'ping)
389 (if (or (string-match "[^-a-zA-Z0-9.]" host
) ; Illegal chars (?)
390 (not (string-match "[^0-9]" host
))) ; 1: a number? 2: quick reject
393 (and (string-match "\\.[^.]*$" host
)
394 (downcase (substring host
(1+ (match-beginning 0))))))
395 (what-domain (if domain
(ffap-what-domain domain
) "Local")))
398 (cond ((not domain
) ffap-machine-p-local
)
399 ((not what-domain
) ffap-machine-p-unknown
)
400 (t ffap-machine-p-known
))))
402 ((eq strategy
'accept
) 'accept
)
403 ((eq strategy
'reject
) nil
)
404 ;; assume (eq strategy 'ping)
407 (if (stringp what-domain
)
408 (message "Pinging %s (%s)..." host what-domain
)
409 (message "Pinging %s ..." host
)))
410 (condition-case error
414 "ffap-machine-p" nil host
(or service
"discard")))
417 (let ((mesg (car (cdr error
))))
420 ((string-match "^Unknown host" mesg
) nil
)
421 ((string-match "not responding$" mesg
) mesg
)
423 ;; (file-error "connection failed" "permission denied"
424 ;; "nonesuch" "ffap-machine-p")
425 ;; (file-error "connection failed" "host is unreachable"
426 ;; "gopher.house.gov" "ffap-machine-p")
427 ;; (file-error "connection failed" "address already in use"
428 ;; "ftp.uu.net" "ffap-machine-p")
429 ((equal mesg
"connection failed")
430 (if (equal (nth 2 error
) "permission denied")
431 nil
; host does not exist
432 ;; Other errors mean the host exists:
434 ;; Could be "Unknown service":
435 (t (signal (car error
) (cdr error
))))))))))))
437 (defun ffap-file-remote-p (filename)
438 "If FILENAME looks remote, return it \(maybe slightly improved\)."
439 ;; (ffap-file-remote-p "/user@foo.bar.com:/pub")
440 ;; (ffap-file-remote-p "/cssun.mathcs.emory.edu://path")
441 ;; (ffap-file-remote-p "/ffap.el:80")
442 (or (and ffap-ftp-regexp
443 (string-match ffap-ftp-regexp filename
)
444 ;; Convert "/host.com://path" to "/host:/path", to handle a dieing
445 ;; practice of advertising ftp paths as "host.dom://path".
446 (if (string-match "//" filename
)
447 ;; (replace-match "/" nil nil filename)
448 (concat (substring filename
0 (1+ (match-beginning 0)))
449 (substring filename
(match-end 0)))
452 (string-match ffap-rfs-regexp filename
)
455 (defun ffap-machine-at-point nil
456 "Return machine name at point if it exists, or nil."
457 (let ((mach (ffap-string-at-point 'machine
)))
458 (and (ffap-machine-p mach
) mach
)))
460 (defsubst ffap-host-to-path
(host)
461 "Convert HOST to something like \"/anonymous@HOST:\".
462 Looks at `ffap-ftp-default-user', returns \"\" for \"localhost\"."
463 (if (equal host
"localhost") ""
465 ffap-ftp-default-user
(and ffap-ftp-default-user
"@")
468 (defun ffap-fixup-machine (mach)
469 ;; Convert a hostname into an url, an ftp path, or nil.
471 ((not (and ffap-url-regexp
(stringp mach
))) nil
)
473 ((string-match "\\`gopher[-.]" mach
) ; or "info"?
474 (concat "gopher://" mach
"/"))
476 ((and (string-match "\\`w\\(ww\\|eb\\)[-.]" mach
))
477 (concat "http://" mach
"/"))
478 ;; More cases? Maybe "telnet:" for archie?
479 (ffap-ftp-regexp (ffap-host-to-path mach
))
482 (defvar ffap-newsgroup-regexp
"^[a-z]+\\.[-+a-z_0-9.]+$"
483 "Strings not matching this fail `ffap-newsgroup-p'.")
484 (defvar ffap-newsgroup-heads
; entirely inadequate
485 '("alt" "comp" "gnu" "misc" "news" "sci" "soc" "talk")
486 "Used by `ffap-newsgroup-p' if gnus is not running.")
488 (defun ffap-newsgroup-p (string)
489 "Return STRING if it looks like a newsgroup name, else nil."
491 (string-match ffap-newsgroup-regexp string
)
492 (let ((htbs '(gnus-active-hashtb gnus-newsrc-hashtb gnus-killed-hashtb
))
493 (heads ffap-newsgroup-heads
)
496 (setq htb
(car htbs
) htbs
(cdr htbs
))
499 ;; errs: htb symbol may be unbound, or not a hash-table.
500 ;; gnus-gethash is just a macro for intern-soft.
501 (and (intern-soft string
(symbol-value htb
))
502 (setq ret string htbs nil
))
503 ;; If we made it this far, gnus is running, so ignore "heads":
507 (let ((head (string-match "\\`\\([a-z]+\\)\\." string
)))
508 (and head
(setq head
(substring string
0 (match-end 1)))
511 ;; Is there ever a need to modify string as a newsgroup name?
514 (defsubst ffap-url-p
(string)
515 "If STRING looks like an url, return it (maybe improved), else nil."
516 (let ((case-fold-search t
))
517 (and ffap-url-regexp
(string-match ffap-url-regexp string
)
518 ;; I lied, no improvement:
521 ;; Broke these out of ffap-fixup-url, for use of ffap-url package.
522 (defsubst ffap-url-unwrap-local
(url)
523 "Return URL as a local file, or nil. Ignores `ffap-url-regexp'."
524 (and (string-match "\\`\\(file\\|ftp\\):/?\\([^/]\\|\\'\\)" url
)
525 (substring url
(1+ (match-end 1)))))
526 (defsubst ffap-url-unwrap-remote
(url)
527 "Return URL as a remote file, or nil. Ignores `ffap-url-regexp'."
528 (and (string-match "\\`\\(ftp\\|file\\)://\\([^:/]+\\):?\\(/.*\\)" url
)
530 (ffap-host-to-path (substring url
(match-beginning 2) (match-end 2)))
531 (substring url
(match-beginning 3) (match-end 3)))))
532 ;; Test: (ffap-url-unwrap-remote "ftp://foo.com/bar.boz")
534 (defun ffap-fixup-url (url)
535 "Clean up URL and return it, maybe as a file name."
537 ((not (stringp url
)) nil
)
538 ((and ffap-url-unwrap-local
(ffap-url-unwrap-local url
)))
539 ((and ffap-url-unwrap-remote ffap-ftp-regexp
540 (ffap-url-unwrap-remote url
)))
541 ;; Do not load w3 just for this:
542 (t (let ((normal (and (fboundp 'url-normalize-url
)
543 (url-normalize-url url
))))
544 ;; In case url-normalize-url is confused:
545 (or (and normal
(not (zerop (length normal
))) normal
)
551 ;; Search actions depending on the major-mode or extensions of the
552 ;; current name. Note all the little defun's could be broken out, at
553 ;; some loss of locality. A good example of featuritis.
555 ;; First, some helpers for functions in `ffap-alist':
557 (defun ffap-list-env (env &optional empty
)
558 ;; Replace this with parse-colon-path (lisp/files.el)?
559 "Directory list parsed from path envinronment variable ENV.
560 Optional EMPTY is default if (getenv ENV) is undefined, and is also
561 substituted for the first empty-string component, if there is one.
562 Uses `path-separator' to separate the path into directories."
563 ;; Derived from psg-list-env in RHOGEE's ff-paths and
564 ;; bib-cite packages. The `empty' argument is intended to mimic
565 ;; the semantics of TeX/BibTeX variables, it is substituted for
566 ;; any empty string entry.
567 (if (or empty
(getenv env
)) ; should return something
568 (let ((start 0) match dir ret
)
569 (setq env
(concat (getenv env
) path-separator
))
570 (while (setq match
(string-match path-separator env start
))
571 (setq dir
(substring env start match
) start
(1+ match
))
572 ;;(and (file-directory-p dir) (not (member dir ret)) ...)
573 (setq ret
(cons dir ret
)))
574 (setq ret
(nreverse ret
))
575 (and empty
(setq match
(member "" ret
))
577 (setcdr match
(append (cdr-safe empty
) (cdr match
)))
578 (setcar match
(or (car-safe empty
) empty
))))
581 (defun ffap-reduce-path (path)
582 "Remove duplicates and non-directories from PATH list."
585 (setq tem path path
(cdr path
))
586 (if (equal (car tem
) ".") (setcar tem
""))
587 (or (member (car tem
) ret
)
588 (not (file-directory-p (car tem
)))
589 (progn (setcdr tem ret
) (setq ret tem
))))
592 (defun ffap-add-subdirs (path)
593 "Return PATH augmented with its immediate subdirectories."
594 ;; (ffap-add-subdirs '("/notexist" "~"))
599 (lambda (f) (and (file-directory-p f
) (setq ret
(cons f ret
)))))
601 (directory-files (car path
) t
"[^.]")
603 (setq ret
(cons (car path
) ret
)
608 ;; A big mess! Parts are probably useless.
610 ("\\.info\\'" . ffap-info
)
611 ;; Since so many info files do not have .info extension, also do this:
612 ("\\`info/" . ffap-info-2
)
613 ("\\`[-a-z]+\\'" . ffap-info-3
)
614 ("\\.elc?\\'" . ffap-el
)
615 (emacs-lisp-mode . ffap-el-mode
)
616 (finder-mode . ffap-el-mode
) ; v19: {C-h p}
617 (help-mode . ffap-el-mode
) ; v19.29
618 (c++-mode . ffap-c-mode
)
619 (cc-mode . ffap-c-mode
)
620 ("\\.\\([chCH]\\|cc\\|hh\\)\\'" . ffap-c-mode
)
621 (tex-mode . ffap-tex-mode
)
622 (latex-mode . ffap-latex-mode
)
623 ("\\.\\(tex\\|sty\\|doc\\|cls\\)\\'" . ffap-tex
)
624 ("\\.bib\\'" . ffap-bib
)
625 ("\\`\\." . ffap-home
)
627 ("^[Rr][Ff][Cc][- #]?\\([0-9]+\\)" ; no $
629 ("\\`[^/]*\\'" . ffap-dired
))
630 "Alist of \(KEY . FUNCTION\) pairs parsed by `ffap-file-at-point'.
631 If string NAME at point (maybe \"\") is not a file or url, these pairs
632 specify actions to try creating such a string. A pair matches if either
633 KEY is a symbol, and it equals `major-mode', or
634 KEY is a string, it should matches NAME as a regexp.
635 On a match, \(FUNCTION NAME\) is called and should return a file, an
636 url, or nil. If nil, search the alist for further matches.")
638 (put 'ffap-alist
'risky-local-variable t
)
640 (defun ffap-home (name) (locate-library name t
'("~")))
642 (defun ffap-info (name)
645 (or (ffap-soft-value "Info-directory-list")
646 (ffap-soft-value "Info-default-directory-list")
648 (list (ffap-soft-value "Info-directory" "~/info/")))))
650 (defun ffap-info-2 (name) (ffap-info (substring name
5)))
652 ;; This ignores the node! "(emacs)Top" same as "(emacs)Intro"
653 (defun ffap-info-3 (name)
654 (and (equal (ffap-string-around) "()") (ffap-info name
)))
656 (defun ffap-el (name) (locate-library name t
))
658 ;; Need better defaults here!
659 (defvar ffap-c-path
'("/usr/include" "/usr/local/include"))
660 (defun ffap-c-mode (name)
661 (locate-library name t ffap-c-path
))
663 (defun ffap-el-mode (name)
664 ;; We do not bother with "" here, since it was considered above.
665 ;; Also ignore "elc", for speed (who else reads elc files?)
666 (and (not (string-match "\\.el\\'" name
))
667 (locate-library name
'(".el"))))
669 ;; Complicated because auctex may not be loaded yet.
670 (defvar ffap-tex-path
671 t
; delayed initialization
672 "Path where `ffap-tex-mode' looks for tex files.
673 If t, `ffap-tex-init' will initialize this when needed.")
675 (defun ffap-tex-init nil
676 ;; Compute ffap-tex-path if it is now t.
677 (and (eq t ffap-tex-path
)
678 (message "Initializing ffap-tex-path ...")
683 (ffap-list-env "TEXINPUTS")
684 ;; (ffap-list-env "BIBINPUTS")
686 (ffap-list-env "TEXINPUTS_SUBDIR"
689 '("/usr/local/lib/tex/macros"
690 "/usr/local/lib/tex/inputs")
693 (defun ffap-tex-mode (name)
695 (locate-library name
'(".tex" "") ffap-tex-path
))
697 (defun ffap-latex-mode (name)
699 ;; Any real need for "" here?
700 (locate-library name
'(".cls" ".sty" ".tex" "")
703 (defun ffap-tex (name)
705 (locate-library name t ffap-tex-path
))
707 (defun ffap-bib (name)
710 (ffap-list-env "BIBINPUTS" '("/usr/local/lib/tex/macros/bib"))))
712 (defun ffap-dired (name)
713 (let ((pt (point)) dir try
)
717 (looking-at " *[-d]r[-w][-x][-r][-w][-x][-r][-w][-x] "))
718 (re-search-backward "^ *$" nil t
)
719 (re-search-forward "^ *\\([^ \t\n:]*\\):\n *total " pt t
)
725 (match-beginning 1) (match-end 1)))))
728 ;; Maybe a "Lisp Code Directory" reference:
729 (defun ffap-lcd (name)
732 ;; lisp-dir-apropos output buffer:
733 (string-match "Lisp Code Dir" (buffer-name))
734 ;; Inside an LCD entry like |~/misc/ffap.el.Z|,
735 ;; or maybe the holy LCD-Datafile itself:
736 (member (ffap-string-around) '("||" "|\n")))
738 ;; lispdir.el may not be loaded yet:
740 (ffap-soft-value "elisp-archive-host"
741 "archive.cis.ohio-state.edu"))
742 (file-name-as-directory
743 (ffap-soft-value "elisp-archive-directory"
744 "/pub/gnu/emacs/elisp-archive/"))
745 (substring name
2))))
747 (defvar ffap-rfc-path
748 (concat (ffap-host-to-path "ds.internic.net") "/rfc/rfc%s.txt"))
750 (defun ffap-rfc (name)
751 (format ffap-rfc-path
752 (substring name
(match-beginning 1) (match-end 1))))
754 ;;; At-Point Functions:
756 (defvar ffap-string-at-point-mode-alist
758 ;; The default, used when the `major-mode' is not found.
759 ;; Slightly controversial decisions:
760 ;; * strip trailing "@" and ":"
761 ;; * no commas (good for latex)
762 (file "--:$+<>@-Z_a-z~" "<@" "@>;.,!?:")
763 ;; An url, or maybe a email/news message-id:
764 (url "--:?$+@-Z_a-z~#,%" "^A-Za-z0-9" ":;.,!?")
765 ;; Find a string that does *not* contain a colon:
766 (nocolon "--9$+<>@-Z_a-z~" "<@" "@>;.,!?")
768 (machine "-a-zA-Z0-9." "" ".")
769 ;; Mathematica paths: allow backquotes
770 (math-mode ",-:$+<>@-Z_a-z~`" "<" "@>;.,!?`:")
772 "Alist of \(MODE CHARS BEG END\), where MODE is a symbol,
773 possibly a `major-mode' or some symbol internal to ffap
774 \(such as 'file, 'url, 'machine, and 'nocolon\).
775 `ffap-string-at-point' uses the data fields as follows:
776 1. find a maximal string of CHARS around point,
777 2. strip BEG chars before point from the beginning,
778 3. Strip END chars after point from the end.")
780 (defvar ffap-string-at-point nil
781 ;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95.
782 "Last string returned by `ffap-string-at-point'.")
784 (defun ffap-string-at-point (&optional mode
)
785 "Return a string of characters from around point.
786 MODE (defaults to `major-mode') is a symbol used to lookup string
787 syntax parameters in `ffap-string-at-point-mode-alist'.
788 If MODE is not found, we fall back on the symbol 'file.
789 Sets `ffap-string-at-point' and `ffap-string-at-point-region'."
792 (or (assq (or mode major-mode
) ffap-string-at-point-mode-alist
)
793 (assq 'file ffap-string-at-point-mode-alist
))))
798 (skip-chars-backward (car args
))
799 (skip-chars-forward (nth 1 args
) pt
)
800 (setcar ffap-string-at-point-region
(point)))
802 (skip-chars-forward (car args
))
803 (skip-chars-backward (nth 2 args
) pt
)
804 (setcar (cdr ffap-string-at-point-region
) (point))))))
805 (or ffap-xemacs
(set-text-properties 0 (length str
) nil str
))
806 (setq ffap-string-at-point str
)))
808 (defun ffap-string-around nil
809 ;; Sometimes useful to decide how to treat a string.
810 "Return string of two chars around last `ffap-string-at-point'.
811 Assumes the buffer has not changed."
815 (goto-char (car ffap-string-at-point-region
))
816 (preceding-char)) ; maybe 0
818 (goto-char (nth 1 ffap-string-at-point-region
))
819 (following-char)) ; maybe 0
822 (defun ffap-copy-string-as-kill (&optional mode
)
823 ;; Requested by MCOOK. Useful?
824 "Call `ffap-string-at-point', and copy result to `kill-ring'."
826 (let ((str (ffap-string-at-point mode
)))
828 (message "No string found around point.")
830 ;; Older: (apply 'copy-region-as-kill ffap-string-at-point-region)
831 (message "Copied to kill ring: %s" str
))))
833 (defun ffap-url-at-point nil
834 "Return url from around point if it exists, or nil."
835 ;; Could use w3's url-get-url-at-point instead. Both handle "URL:",
836 ;; ignore non-relative links, trim punctuation. The other will
837 ;; actually look back if point is in whitespace, but I would rather
838 ;; ffap be non-rabid in such situations.
842 ;; In a w3 buffer button zone?
844 (and (eq major-mode
'w3-mode
)
845 ;; assume: (boundp 'w3-zone-at) (boundp 'w3-zone-data)
846 (setq tem
(w3-zone-at (point)))
847 (consp (setq tem
(w3-zone-data tem
)))
849 ;; Is there a reason not to strip trailing colon?
850 (let ((name (ffap-string-at-point 'url
)))
851 ;; (case-fold-search t), why?
853 ((string-match "^url:" name
) (setq name
(substring name
4)))
854 ((and (string-match "\\`[^:</>@]+@[^:</>@]+[a-zA-Z]\\'" name
)
855 ;; "foo@bar": could be "mailto" or "news" (a Message-ID).
856 ;; If not adorned with "<>", it must be "mailto".
857 ;; Otherwise could be either, so consult `ffap-foo-at-bar-prefix'.
858 (let ((prefix (if (and (equal (ffap-string-around) "<>")
859 ;; At least a couple of odd characters:
860 (string-match "[$.0-9].*[$.0-9].*@" name
))
862 ffap-foo-at-bar-prefix
864 (and prefix
(setq name
(concat prefix
":" name
))))))
865 ((ffap-newsgroup-p name
) (setq name
(concat "news:" name
)))
866 ((and (string-match "\\`[a-z0-9]+\\'" name
) ; <mic> <root> <nobody>
867 (equal (ffap-string-around) "<>")
868 ;; (ffap-user-p name):
869 (not (string-match "~" (expand-file-name (concat "~" name
))))
871 (setq name
(concat "mailto:" name
)))
873 (and (ffap-url-p name
) name
)
876 (defvar ffap-gopher-regexp
877 "^.*\\<\\(Type\\|Name\\|Path\\|Host\\|Port\\) *= *\\(.*\\) *$"
878 "Regexp Matching a line in a gopher bookmark (maybe indented).
879 The two subexpressions are the KEY and VALUE.")
881 (defun ffap-gopher-at-point nil
882 "If point is inside a gopher bookmark block, return its url."
883 ;; `gopher-parse-bookmark' from gopher.el is not so robust
886 (if (looking-at ffap-gopher-regexp
)
888 (while (and (looking-at ffap-gopher-regexp
) (not (bobp)))
890 (or (looking-at ffap-gopher-regexp
) (forward-line 1))
891 (let ((type "1") name path host
(port "70"))
892 (while (looking-at ffap-gopher-regexp
)
895 (buffer-substring (match-beginning 1)
897 (val (buffer-substring (match-beginning 2)
901 (if (and path
(string-match "^ftp:.*@" path
))
903 (substring path
4 (1- (match-end 0)))
904 (substring path
(match-end 0)))
905 (and (= (length type
) 1)
906 host
;; (ffap-machine-p host)
907 (concat "gopher://" host
908 (if (equal port
"70") "" (concat ":" port
))
909 "/" type path
))))))))
911 (defvar ffap-ftp-sans-slash-regexp
914 ;; Note: by now, we know it is not an url.
915 ;; Icky regexp avoids: default: 123: foo::bar cs:pub
916 ;; It does match on: mic@cs: cs:/pub mathcs.emory.edu: (point at end)
917 "\\`\\([^:@]+@[^:@]+:\\|[^@.:]+\\.[^@:]+:\\|[^:]+:[~/]\\)\\([^:]\\|\\'\\)")
918 "Strings matching this are coerced to ftp paths by ffap.
919 That is, ffap just prepends \"/\". Set to nil to disable.")
921 (defun ffap-file-at-point nil
922 "Return filename from around point if it exists, or nil.
923 Existence test is skipped for names that look remote.
924 If the filename is not obvious, it also tries `ffap-alist',
925 which may actually result in an url rather than a filename."
926 ;; Note: this function does not need to look for url's, just
927 ;; filenames. On the other hand, it is responsible for converting
928 ;; a pseudo-url "site.com://path" to an ftp path
929 (let* ((case-fold-search t
) ; url prefixes are case-insensitive
931 (string (ffap-string-at-point)) ; uses mode alist
933 (or (condition-case nil
934 (and (not (string-match "//" string
)) ; foo.com://bar
935 (substitute-in-file-name string
))
938 (abs (file-name-absolute-p name
))
939 (default-directory default-directory
))
942 ;; Immediate rejects (/ and // are too common in C++):
943 ((member name
'("" "/" "//")) nil
)
944 ;; Immediately test local filenames. If default-directory is
945 ;; remote, you probably already have a connection.
946 ((and (not abs
) (ffap-file-exists-string name
)))
947 ;; Accept remote names without actual checking (too slow):
949 (ffap-file-remote-p name
)
950 ;; Try adding a leading "/" (common omission in ftp paths):
952 ffap-ftp-sans-slash-regexp
953 (string-match ffap-ftp-sans-slash-regexp name
)
954 (ffap-file-remote-p (concat "/" name
)))))
955 ;; Ok, not remote, try the existence test even if it is absolute:
956 ((and abs
(ffap-file-exists-string name
)))
957 ;; If it contains a colon, get rid of it (and return if exists)
958 ((and (string-match path-separator name
)
959 (setq name
(ffap-string-at-point 'nocolon
))
960 (ffap-file-exists-string name
)))
961 ;; File does not exist, try the alist:
962 ((let ((alist ffap-alist
) tem try case-fold-search
)
963 (while (and alist
(not try
))
964 (setq tem
(car alist
) alist
(cdr alist
))
965 (if (or (eq major-mode
(car tem
))
966 (and (stringp (car tem
))
967 (string-match (car tem
) name
)))
968 (and (setq try
(funcall (cdr tem
) name
))
970 (ffap-url-p try
) ; not a file!
971 (ffap-file-remote-p try
)
972 (ffap-file-exists-string try
))))))
974 ;; Alist failed? Try to guess an active remote connection
975 ;; from buffer variables, and try once more, both as an
976 ;; absolute and relative path on that remote host.
977 ((let* (ffap-rfs-regexp ; suppress
980 ((ffap-file-remote-p default-directory
))
981 ((and (eq major-mode
'internal-ange-ftp-mode
)
982 (string-match "^\\*ftp \\(.*\\)@\\(.*\\)\\*$"
984 (concat "/" (substring (buffer-name) 5 -
1) ":"))
985 ;; This is too often a bad idea:
986 ;;((and (eq major-mode 'w3-mode)
987 ;; (stringp url-current-server))
988 ;; (host-to-ange-path url-current-server))
992 (and (string-match "\\`\\(/?~?ftp\\)/" name
)
993 (ffap-file-exists-string
994 (ffap-replace-path-component
995 remote-dir
(substring name
(match-end 1)))))
996 (ffap-file-exists-string
997 (ffap-replace-path-component remote-dir name
))))))
999 (store-match-data data
))))
1002 ;;; ffap-read-file-or-url:
1004 ;; We want to complete filenames as in read-file-name, but also url's
1005 ;; which read-file-name-internal would truncate at the "//" string.
1006 ;; The solution here is to replace read-file-name-internal with
1007 ;; `ffap-read-file-or-url-internal', which checks the minibuffer
1008 ;; contents before attempting to complete filenames.
1010 (defun ffap-read-file-or-url (prompt guess
)
1011 "Read file or url from minibuffer, with PROMPT and initial GUESS."
1012 (or guess
(setq guess default-directory
))
1014 ;; Tricky: guess may have or be a local directory, like "w3/w3.elc"
1015 ;; or "w3/" or "../el/ffap.el" or "../../../"
1016 (or (ffap-url-p guess
)
1018 (or (ffap-file-remote-p guess
)
1019 (setq guess
(abbreviate-file-name (expand-file-name guess
))))
1020 (setq dir
(file-name-directory guess
))))
1024 'ffap-read-file-or-url-internal
1027 (if dir
(cons guess
(length dir
)) guess
)
1028 (list 'file-name-history
)
1030 ;; Do file substitution like (interactive "F"), suggested by MCOOK.
1031 (or (ffap-url-p guess
) (setq guess
(substitute-in-file-name guess
)))
1032 ;; Should not do it on url's, where $ is a common (VMS?) character.
1033 ;; Note: upcoming url.el package ought to handle this automatically.
1036 (defun ffap-read-url-internal (string dir action
)
1037 "Complete url's from history, treating given string as valid."
1038 (let ((hist (ffap-soft-value "url-global-history-hash-table")))
1041 (or (try-completion string hist
) string
))
1043 (or (all-completions string hist
) (list string
)))
1044 ;; action == lambda, documented where? Tests whether string is a
1045 ;; valid "match". Let us always say yes.
1048 (defun ffap-read-file-or-url-internal (string dir action
)
1049 (if (ffap-url-p string
)
1050 (ffap-read-url-internal string dir action
)
1051 (read-file-name-internal string dir action
)))
1053 ;; The rest of this page is just to work with package complete.el.
1054 ;; This code assumes that you load ffap.el after complete.el.
1056 ;; We must inform complete about whether our completion function
1057 ;; will do filename style completion. For earlier versions of
1058 ;; complete.el, this requires a defadvice. For recent versions
1059 ;; there may be a special variable for this purpose.
1061 (defun ffap-complete-as-file-p nil
1062 ;; Will `minibuffer-completion-table' complete the minibuffer
1063 ;; contents as a filename? Assumes the minibuffer is current.
1064 ;; Note: t and non-nil mean somewhat different reasons.
1065 (if (eq minibuffer-completion-table
'ffap-read-file-or-url-internal
)
1066 (not (ffap-url-p (buffer-string))) ; t
1067 (memq minibuffer-completion-table
1068 '(read-file-name-internal read-directory-name-internal
)) ; list
1072 (featurep 'complete
)
1073 (if (boundp 'PC-completion-as-file-name-predicate
)
1074 ;; modern version of complete.el, just set the variable:
1075 (setq PC-completion-as-file-name-predicate
'ffap-complete-as-file-p
)
1077 (defadvice PC-do-completion
(around ffap-fix act
)
1079 (let ((minibuffer-completion-table
1080 (if (eq t
(ffap-complete-as-file-p))
1081 'read-file-name-internal
1082 minibuffer-completion-table
)))
1088 ;; Based on overlay highlighting in Emacs 19.28 isearch.el.
1090 (defvar ffap-highlight
(and window-system t
)
1091 "If non-nil, ffap highlights the current buffer substring.")
1093 (defvar ffap-highlight-overlay nil
"Overlay used by `ffap-highlight'.")
1095 (defun ffap-highlight (&optional remove
)
1096 "If `ffap-highlight' is set, highlight the guess in this buffer.
1097 That is, the last buffer substring found by `ffap-string-at-point'.
1098 Optional argument REMOVE means to remove any such highlighting.
1099 Uses the face `ffap' if it is defined, or else `highlight'."
1101 (remove (and ffap-highlight-overlay
(delete-overlay ffap-highlight-overlay
)))
1102 ((not ffap-highlight
) nil
)
1103 (ffap-highlight-overlay
1104 (move-overlay ffap-highlight-overlay
1105 (car ffap-string-at-point-region
)
1106 (nth 1 ffap-string-at-point-region
)
1109 (setq ffap-highlight-overlay
(apply 'make-overlay ffap-string-at-point-region
))
1110 (overlay-put ffap-highlight-overlay
'face
1111 (if (internal-find-face 'ffap nil
)
1112 'ffap
'highlight
)))))
1115 ;;; The big enchilada:
1117 (defun ffap-guesser nil
1118 "Return file or url or nil, guessed from text around point."
1119 (or (and ffap-url-regexp
1120 (ffap-fixup-url (or (ffap-url-at-point)
1121 (ffap-gopher-at-point))))
1122 (ffap-file-at-point) ; may yield url!
1123 (ffap-fixup-machine (ffap-machine-at-point))))
1125 (defun ffap-prompter (&optional guess
)
1126 ;; Does guess and prompt step for find-file-at-point.
1127 ;; Extra complication for the temporary highlighting.
1129 (ffap-read-file-or-url
1130 (if ffap-url-regexp
"Find file or URL: " "Find file: ")
1132 (setq guess
(or guess
(ffap-guesser)))
1133 (and guess
(ffap-highlight))
1135 (ffap-highlight t
)))
1138 (defun find-file-at-point (&optional filename
)
1139 "Find FILENAME (or url), guessing default from text around point.
1140 If `ffap-dired-wildcards' is set, wildcard patterns are passed to dired.
1141 See also the functions `ffap-file-at-point', `ffap-url-at-point'.
1142 With a prefix, this command behaves *exactly* like `ffap-file-finder'.
1143 If `ffap-require-prefix' is set, the prefix meaning is reversed.
1145 See <ftp://ftp.mathcs.emory.edu/pub/mic/emacs/> for latest version."
1147 (if (and (interactive-p)
1148 (if ffap-require-prefix
(not current-prefix-arg
)
1149 current-prefix-arg
))
1150 ;; Do exactly the ffap-file-finder command, even the prompting:
1151 (let (current-prefix-arg) ; we already interpreted it
1152 (call-interactively ffap-file-finder
))
1153 (or filename
(setq filename
(ffap-prompter)))
1155 ((ffap-url-p filename
)
1156 (let (current-prefix-arg) ; w3 2.3.25 bug, reported by KPC
1157 (funcall ffap-url-fetcher filename
)))
1158 ;; This junk more properly belongs in a modified ffap-file-finder:
1159 ((and ffap-dired-wildcards
1160 (string-match ffap-dired-wildcards filename
))
1162 ((or (not ffap-newfile-prompt
)
1163 (file-exists-p filename
)
1164 (y-or-n-p "File does not exist, create buffer? "))
1165 (funcall ffap-file-finder
1166 ;; expand-file-name fixes "~/~/.emacs" bug sent by CHUCKR.
1167 (expand-file-name filename
)))
1168 ;; User does not want to find a non-existent file:
1169 ((signal 'file-error
(list "Opening file buffer"
1170 "no such file or directory"
1175 (defalias 'ffap
'find-file-at-point
)
1180 ;; Bind ffap-menu to a key if you want, since it also works in tty mode.
1181 ;; Or just use it through the ffap-at-mouse binding (next section).
1183 (defvar ffap-menu-regexp nil
1184 "*If non-nil, overrides `ffap-next-regexp' during `ffap-menu'.
1185 Make this more restrictive for faster menu building.
1186 For example, try \":/\" for url (and some ftp) references.")
1188 (defvar ffap-menu-alist nil
1189 "Buffer local cache of menu presented by `ffap-menu'.")
1190 (make-variable-buffer-local 'ffap-menu-alist
)
1192 (defvar ffap-menu-text-plist
1194 ;; These choices emulate goto-addr:
1196 '(face bold highlight t
) ; keymap <map>
1197 '(face bold mouse-face highlight
) ; keymap <mousy-map>
1199 "Text properties applied to strings found by `ffap-menu-rescan'.
1200 These properties may be used to fontify the menu references.")
1203 (defun ffap-menu (&optional rescan
)
1204 "Put up a menu of files and urls mentioned in this buffer.
1205 Then set mark, jump to choice, and try to fetch it. The menu is
1206 cached in `ffap-menu-alist', and rebuilt by `ffap-menu-rescan'.
1207 The optional RESCAN argument \(a prefix, interactively\) forces
1208 a rebuild. Searches with `ffap-menu-regexp'."
1210 ;; (require 'imenu) -- no longer used, but roughly emulated
1211 (if (or (not ffap-menu-alist
) rescan
1212 ;; or if the first entry is wrong:
1213 (and ffap-menu-alist
1214 (let ((first (car ffap-menu-alist
)))
1216 (goto-char (cdr first
))
1217 (not (equal (car first
) (ffap-guesser)))))))
1221 (if ffap-url-regexp
"Find file or URL" "Find file")
1222 (cons (cons "*Rescan Buffer*" -
1) ffap-menu-alist
)
1225 (defun ffap-menu-cont (choice) ; continuation of ffap-menu
1226 (if (< (cdr choice
) 0)
1227 (ffap-menu t
) ; *Rescan*
1229 (goto-char (cdr choice
))
1230 ;; Momentary highlight:
1233 (and ffap-highlight
(ffap-guesser) (ffap-highlight))
1234 (sit-for 0) ; display
1235 (find-file-at-point (car choice
)))
1236 (ffap-highlight t
))))
1238 (defun ffap-menu-ask (title alist cont
)
1239 "Prompt from a menu of choices, and then apply some action.
1240 Arguments are TITLE, ALIST, and CONT (a continuation).
1241 This uses either a menu or the minibuffer depending on invocation.
1242 The TITLE string is used as either the prompt or menu title.
1243 Each \(string . data\) ALIST entry defines a choice \(data is ignored\).
1244 Once the user makes a choice, function CONT is applied to the entry.
1245 Always returns nil."
1246 ;; Bug: minibuffer prompting assumes the strings are unique.
1248 (if (and (fboundp 'x-popup-menu
) ; Emacs 19 or XEmacs 19.13
1249 (boundp 'last-nonmenu-event
) ; not in XEmacs 19.13
1250 (listp last-nonmenu-event
))
1256 (function (lambda (i) (cons (car i
) i
)))
1258 ;; Immediately popup completion buffer:
1260 (let ((minibuffer-setup-hook 'minibuffer-completion-help
))
1261 ;; BUG: this code assumes that "" is not a valid choice
1263 (format "%s (default %s): " title
(car (car alist
)))
1265 ;; (cons (car (car alist)) 0)
1268 ;; Redraw original screen:
1270 ;; Defaulting: convert "" to (car (car alist))
1271 (and (equal choice
"") (setq choice
(car (car alist
))))
1272 (and (stringp choice
) (setq choice
(assoc choice alist
)))
1273 (if choice
(funcall cont choice
) (message "No choice made!")))
1274 nil
) ; return nothing
1276 (defun ffap-menu-rescan nil
1277 "Search buffer for `ffap-menu-regexp' to build `ffap-menu-alist'.
1278 Applies `ffap-menu-text-plist' text properties at all matches."
1280 (let ((ffap-next-regexp (or ffap-menu-regexp ffap-next-regexp
))
1281 (range (- (point-max) (point-min))) item
1282 buffer-read-only
; to set text-properties
1283 ;; Avoid repeated searches of the *mode-alist:
1284 (major-mode (if (assq major-mode ffap-string-at-point-mode-alist
)
1288 (setq ffap-menu-alist nil
)
1290 (goto-char (point-min))
1291 (while (setq item
(ffap-next-guess))
1292 (setq ffap-menu-alist
(cons (cons item
(point)) ffap-menu-alist
))
1293 (add-text-properties (car ffap-string-at-point-region
) (point)
1294 ffap-menu-text-plist
)
1295 (message "Scanning...%2d%% <%s>"
1296 (/ (* 100 (- (point) (point-min))) range
) item
))))
1297 (message "Scanning...done")
1298 ;; Remove duplicates.
1299 (setq ffap-menu-alist
; sort by item
1300 (sort ffap-menu-alist
1302 (lambda (a b
) (string-lessp (car a
) (car b
))))))
1303 (let ((ptr ffap-menu-alist
))
1305 (if (equal (car (car ptr
)) (car (car (cdr ptr
))))
1306 (setcdr ptr
(cdr (cdr ptr
)))
1307 (setq ptr
(cdr ptr
)))))
1308 (setq ffap-menu-alist
; sort by position
1309 (sort ffap-menu-alist
1311 (lambda (a b
) (< (cdr a
) (cdr b
)))))))
1316 ;; See the suggested binding in ffap-bindings (near eof).
1318 (defvar ffap-at-mouse-fallback
'ffap-menu
1319 "Invoked by `ffap-at-mouse' if no file or url at click.
1320 A command symbol, or nil for nothing.")
1321 (put 'ffap-at-mouse-fallback
'risky-local-variable t
)
1323 (defun ffap-at-mouse (e)
1324 "Find file or url guessed from text around mouse point.
1325 If none is found, call `ffap-at-mouse-fallback'."
1328 ;; Maybe less surprising without the save-excursion?
1331 ;; Would like to do nothing unless click was *on* text. How?
1332 ;; (cdr (posn-col-row (event-start e))) is always same as
1333 ;; current column. For posn-x-y, need pixel-width!
1340 (sit-for 0) ; display
1341 (message "Guessing `%s'" guess
)
1342 (find-file-at-point guess
))
1343 (ffap-highlight t
)))
1344 ((and (interactive-p)
1345 ffap-at-mouse-fallback
)
1346 (call-interactively ffap-at-mouse-fallback
))
1347 ((message "No file or URL found at mouse click.")))))
1350 ;;; ffap-other-* commands
1351 ;; Suggested by KPC.
1353 (defun ffap-other-window nil
1354 "Like `ffap', but put buffer in another window."
1356 (switch-to-buffer-other-window
1357 (save-window-excursion (call-interactively 'ffap
) (current-buffer))))
1359 (defun ffap-other-frame nil
1360 "Like `ffap', but put buffer in another frame."
1362 (switch-to-buffer-other-frame
1363 (save-window-excursion (call-interactively 'ffap
) (current-buffer))))
1369 "Submit a bug report for the ffap package."
1370 ;; Important: keep the version string here in synch with that at top
1371 ;; of file! Could use lisp-mnt from Emacs 19, but that would depend
1372 ;; on being able to find the ffap.el source file.
1375 (let ((reporter-prompt-for-summary-p t
))
1376 (reporter-submit-bug-report
1377 "Michelangelo Grigni <mic@mathcs.emory.edu>"
1379 (mapcar 'intern
(all-completions "ffap-" obarray
'boundp
)))))
1381 (fset 'ffap-submit-bug
'ffap-bug
) ; another likely name
1384 ;;; Hooks for Gnus, VM, Rmail:
1386 ;; If you do not like these bindings, write versions with whatever
1387 ;; bindings you would prefer.
1389 (defun ffap-ro-mode-hook nil
1390 "Bind `ffap-next' and `ffap-menu' to M-l and M-m, resp."
1391 (local-set-key "\M-l" 'ffap-next
)
1392 (local-set-key "\M-m" 'ffap-menu
)
1395 (defun ffap-gnus-hook nil
1396 "Bind `ffap-gnus-next' and `ffap-gnus-menu' to M-l and M-m, resp."
1397 (set (make-local-variable 'ffap-foo-at-bar-prefix
) "news") ; message-id's
1398 ;; Note "l", "L", "m", "M" are taken:
1399 (local-set-key "\M-l" 'ffap-gnus-next
)
1400 (local-set-key "\M-m" 'ffap-gnus-menu
))
1402 (defun ffap-gnus-wrapper (form) ; used by both commands below
1403 (and (eq (current-buffer) (get-buffer gnus-summary-buffer
))
1404 (gnus-summary-select-article)) ; get article of current line
1405 ;; Preserve selected buffer, but do not do save-window-excursion,
1406 ;; since we want to see any window created by the form. Temporarily
1407 ;; select the article buffer, so we can see any point movement.
1408 (let ((sb (window-buffer (selected-window))))
1409 (gnus-configure-windows 'article
)
1410 (pop-to-buffer gnus-article-buffer
)
1412 ;; Skip headers for ffap-gnus-next (which will wrap around)
1413 (if (eq (point) (point-min)) (search-forward "\n\n" nil t
))
1416 (pop-to-buffer sb
))))
1418 (defun ffap-gnus-next nil
1419 "Run `ffap-next' in the gnus article buffer."
1420 (interactive) (ffap-gnus-wrapper '(ffap-next nil t
)))
1422 (defun ffap-gnus-menu nil
1423 "Run `ffap-menu' in the gnus article buffer."
1424 (interactive) (ffap-gnus-wrapper '(ffap-menu)))
1427 ;;; ffap-bindings: offer default global bindings
1429 (defvar ffap-bindings
1432 ((not (eq window-system
'x
))
1434 ;; GNU coding standards say packages should not bind S-mouse-*.
1435 ;; Is it ok to simply suggest such a binding to the user?
1437 '((global-set-key '(shift button3
) 'ffap-at-mouse
)))
1439 '((global-set-key [S-down-mouse-3
] 'ffap-at-mouse
))))
1441 (global-set-key "\C-x\C-f" 'find-file-at-point
)
1442 (global-set-key "\C-x4f" 'ffap-other-window
)
1443 (global-set-key "\C-x5f" 'ffap-other-frame
)
1444 (add-hook 'gnus-summary-mode-hook
'ffap-gnus-hook
)
1445 (add-hook 'gnus-article-mode-hook
'ffap-gnus-hook
)
1446 (add-hook 'vm-mode-hook
'ffap-ro-mode-hook
)
1447 (add-hook 'rmail-mode-hook
'ffap-ro-mode-hook
)
1448 ;; (setq dired-x-hands-off-my-keys t) ; the default
1450 "List of forms evaluated by function `ffap-bindings'.
1451 A reasonable ffap installation needs just these two lines:
1454 These are only suggestions, they may be modified or ignored.")
1456 (defun ffap-bindings nil
1457 "Evaluate the forms in variable `ffap-bindings'."
1458 (eval (cons 'progn ffap-bindings
)))
1460 ;; Example modifications:
1462 ;; (setq ffap-alist ; remove a feature in `ffap-alist'
1463 ;; (delete (assoc 'c-mode ffap-alist) ffap-alist))
1465 ;; (setq ffap-alist ; add something to `ffap-alist'
1467 ;; (cons "^[Yy][Ss][Nn][0-9]+$"
1468 ;; (defun ffap-ysn (name)
1470 ;; "http://snorri.chem.washington.edu/ysnarchive/issuefiles/"
1471 ;; (substring name 3) ".html")))
1476 ;; Extended suppport in another file, for copyright reasons.
1477 (or (not ffap-xemacs
)
1478 (load "ffap-xe" t t
)
1479 (message "ffap warning: ffap-xe.el not found"))
1482 ;;; ffap.el ends here