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