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