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