-;;; ffap.el --- find file (or url) at point
+;; ffap.el --- find file (or url) at point
;;
-;; Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
+;; Copyright (C) 1995, 96, 97, 2000 Free Software Foundation, Inc.
;;
;; Author: Michelangelo Grigni <mic@mathcs.emory.edu>
;; Created: 29 Mar 1993
;; README's, MANIFEST's, and so on. Submit bugs or suggestions with
;; M-x ffap-bug.
;;
-;; For the default installation, add these two lines to your .emacs file:
+;; For the default installation, add this line to your .emacs file:
;;
-;; (require 'ffap) ; load the package
;; (ffap-bindings) ; do default key bindings
;;
;; ffap-bindings makes the following global key bindings:
;;
;; C-x C-f find-file-at-point (abbreviated as ffap)
+;; C-x d dired-at-point
;; C-x 4 f ffap-other-window
;; C-x 5 f ffap-other-frame
;; S-mouse-3 ffap-at-mouse
;; ffap uses `browse-url' (if found, else `w3-fetch') to fetch URL's.
;; For a hairier `ffap-url-fetcher', try ffap-url.el (same ftp site).
;; Also, you can add `ffap-menu-rescan' to various hooks to fontify
-;; the file and URL references within a buffer.
+;; the file and URL references within a buffer.
\f
;;; Change Log:
\f
;;; Todo list:
;; * use kpsewhich
-;; * let "/path/file#key" jump to key (tag or regexp) in /path/file
+;; * let "/dir/file#key" jump to key (tag or regexp) in /dir/file
;; * find file of symbol if TAGS is loaded (like above)
;; * break long menus into multiple panes (like imenu?)
;; * notice node in "(dired)Virtual Dired" (quotes, parentheses, whitespace)
-;; * notice "machine.dom blah blah blah path/file" (how?)
+;; * notice "machine.dom blah blah blah dir/file" (how?)
;; * as w3 becomes standard, rewrite to rely more on its functions
;; * regexp options for ffap-string-at-point, like font-lock (MCOOK)
;; * v19: could replace `ffap-locate-file' with a quieter `locate-library'
;; This used to test for ange-ftp or efs being present, but it should be
;; harmless (and simpler) to give it this value unconditionally.
"\\`/[^/:]+:"
- "*Paths matching this regexp are treated as remote ftp paths by ffap.
-If nil, ffap neither recognizes nor generates such paths."
+ "*File names matching this regexp are treated as remote ffap.
+If nil, ffap neither recognizes nor generates such names."
:type '(choice (const :tag "Disable" nil)
(const :tag "Standard" "\\`/[^/:]+:")
regexp)
:group 'ffap)
(defcustom ffap-url-unwrap-local t
- "*If non-nil, convert `file:' url to local path before prompting."
+ "*If non-nil, convert `file:' URL to local file name before prompting."
:type 'boolean
:group 'ffap)
(defcustom ffap-url-unwrap-remote t
- "*If non-nil, convert `ftp:' url to remote path before prompting.
+ "*If non-nil, convert `ftp:' URL to remote file name before prompting.
This is ignored if `ffap-ftp-regexp' is nil."
:type 'boolean
:group 'ffap)
(defcustom ffap-ftp-default-user "anonymous"
- "*User name in ftp paths generated by `ffap-host-to-path'.
+ "*User name in ftp file names generated by `ffap-host-to-path'.
Note this name may be omitted if it equals the default
\(either `efs-default-user' or `ange-ftp-default-user'\)."
:type 'string
;; Remote file access built into file system? HP rfa or Andrew afs:
"\\`/\\(afs\\|net\\)/."
;; afs only: (and (file-exists-p "/afs") "\\`/afs/.")
- "*Matching paths are treated as remote. nil to disable."
+ "*Matching file names are treated as remote. Use nil to disable."
:type 'regexp
:group 'ffap)
"\\`\\("
"news\\(post\\)?:\\|mailto:\\|file:" ; no host ok
"\\|"
- "\\(ftp\\|http\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host
+ "\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host
"\\)." ; require one more character
)
"Regexp matching URL's. nil to disable URL features in ffap.")
(cond
((eq strategy 'accept) 'accept)
((eq strategy 'reject) nil)
+ ((not (fboundp 'open-network-stream)) nil)
;; assume (eq strategy 'ping)
(t
(or quiet
\f
;;; Possibly Remote Resources:
-(defun ffap-replace-path-component (fullname name)
+(defun ffap-replace-file-component (fullname name)
"In remote FULLNAME, replace path with NAME. May return nil."
;; Use ange-ftp or efs if loaded, but do not load them otherwise.
(let (found)
ange-ftp-replace-name-component
))
(and found
- (fset 'ffap-replace-path-component found)
+ (fset 'ffap-replace-file-component found)
(funcall found fullname name))))
-;; (ffap-replace-path-component "/who@foo.com:/whatever" "/new")
+;; (ffap-replace-file-component "/who@foo.com:/whatever" "/new")
(defun ffap-file-suffix (file)
"Return trailing `.foo' suffix of FILE, or nil if none."
(defun ffap-file-remote-p (filename)
"If FILENAME looks remote, return it (maybe slightly improved)."
;; (ffap-file-remote-p "/user@foo.bar.com:/pub")
- ;; (ffap-file-remote-p "/cssun.mathcs.emory.edu://path")
+ ;; (ffap-file-remote-p "/cssun.mathcs.emory.edu://dir")
;; (ffap-file-remote-p "/ffap.el:80")
(or (and ffap-ftp-regexp
(string-match ffap-ftp-regexp filename)
- ;; Convert "/host.com://path" to "/host:/path", to handle a dieing
- ;; practice of advertising ftp paths as "host.dom://path".
+ ;; Convert "/host.com://dir" to "/host:/dir", to handle a dieing
+ ;; practice of advertising ftp files as "host.dom://filename".
(if (string-match "//" filename)
;; (replace-match "/" nil nil filename)
(concat (substring filename 0 (1+ (match-beginning 0)))
(let ((mach (ffap-string-at-point 'machine)))
(and (ffap-machine-p mach) mach)))
-(defsubst ffap-host-to-path (host)
+(defsubst ffap-host-to-filename (host)
"Convert HOST to something like \"/USER@HOST:\" or \"/HOST:\".
Looks at `ffap-ftp-default-user', returns \"\" for \"localhost\"."
(if (equal host "localhost")
(concat "/" user (and user "@") host ":"))))
(defun ffap-fixup-machine (mach)
- ;; Convert a hostname into an url, an ftp path, or nil.
+ ;; Convert a hostname into an url, an ftp file name, or nil.
(cond
((not (and ffap-url-regexp (stringp mach))) nil)
;; gopher.well.com
((and (string-match "\\`w\\(ww\\|eb\\)[-.]" mach))
(concat "http://" mach "/"))
;; More cases? Maybe "telnet:" for archie?
- (ffap-ftp-regexp (ffap-host-to-path mach))
+ (ffap-ftp-regexp (ffap-host-to-filename mach))
))
(defvar ffap-newsgroup-regexp "^[a-z]+\\.[-+a-z_0-9.]+$"
(progn
;; errs: htb symbol may be unbound, or not a hash-table.
;; gnus-gethash is just a macro for intern-soft.
- (and (intern-soft string (symbol-value htb))
+ (and (symbol-value htb)
+ (intern-soft string (symbol-value htb))
(setq ret string htbs nil))
;; If we made it this far, gnus is running, so ignore "heads":
(setq heads nil))
"Return URL as a remote file, or nil. Ignores `ffap-url-regexp'."
(and (string-match "\\`\\(ftp\\|file\\)://\\([^:/]+\\):?\\(/.*\\)" url)
(concat
- (ffap-host-to-path (substring url (match-beginning 2) (match-end 2)))
+ (ffap-host-to-filename (substring url (match-beginning 2) (match-end 2)))
(substring url (match-beginning 3) (match-end 3)))))
;; Test: (ffap-url-unwrap-remote "ftp://foo.com/bar.boz")
(url)))
\f
-;;; Path Handling:
+;;; File Name Handling:
;;
;; The upcoming ffap-alist actions need various utilities to prepare
-;; and search paths of directories. Too many features here.
+;; and search directories. Too many features here.
;; (defun ffap-last (l) (while (cdr l) (setq l (cdr l))) l)
;; (defun ffap-splice (func inlist)
(member (ffap-string-around) '("||" "|\n")))
(concat
;; lispdir.el may not be loaded yet:
- (ffap-host-to-path
+ (ffap-host-to-filename
(ffap-soft-value "elisp-archive-host"
"archive.cis.ohio-state.edu"))
(file-name-as-directory
(substring name 2))))
(defvar ffap-rfc-path
- (concat (ffap-host-to-path "ds.internic.net") "/rfc/rfc%s.txt"))
+ (concat (ffap-host-to-filename "ds.internic.net") "/rfc/rfc%s.txt"))
(defun ffap-rfc (name)
(format ffap-rfc-path
;; Icky regexp avoids: default: 123: foo::bar cs:pub
;; It does match on: mic@cs: cs:/pub mathcs.emory.edu: (point at end)
"\\`\\([^:@]+@[^:@]+:\\|[^@.:]+\\.[^@:]+:\\|[^:]+:[~/]\\)\\([^:]\\|\\'\\)")
- "Strings matching this are coerced to ftp paths by ffap.
+ "Strings matching this are coerced to ftp file names by ffap.
That is, ffap just prepends \"/\". Set to nil to disable.")
(defun ffap-file-at-point nil
which may actually result in an url rather than a filename."
;; Note: this function does not need to look for url's, just
;; filenames. On the other hand, it is responsible for converting
- ;; a pseudo-url "site.com://path" to an ftp path
+ ;; a pseudo-url "site.com://dir" to an ftp file name
(let* ((case-fold-search t) ; url prefixes are case-insensitive
(data (match-data))
(string (ffap-string-at-point)) ; uses mode alist
;; Accept remote names without actual checking (too slow):
((if abs
(ffap-file-remote-p name)
- ;; Try adding a leading "/" (common omission in ftp paths):
+ ;; Try adding a leading "/" (common omission in ftp file names):
(and
ffap-ftp-sans-slash-regexp
(string-match ffap-ftp-sans-slash-regexp name)
try))
;; Alist failed? Try to guess an active remote connection
;; from buffer variables, and try once more, both as an
- ;; absolute and relative path on that remote host.
+ ;; absolute and relative file name on that remote host.
((let* (ffap-rfs-regexp ; suppress
(remote-dir
(cond
(or
(and (string-match "\\`\\(/?~?ftp\\)/" name)
(ffap-file-exists-string
- (ffap-replace-path-component
+ (ffap-replace-file-component
remote-dir (substring name (match-end 1)))))
(ffap-file-exists-string
- (ffap-replace-path-component remote-dir name))))))
+ (ffap-replace-file-component remote-dir name))))))
)
(set-match-data data))))
\f
(t t))))
(defun ffap-read-file-or-url-internal (string dir action)
+ (unless dir
+ (setq dir default-directory))
+ (unless string
+ (setq string default-directory))
(if (ffap-url-p string)
(ffap-read-url-internal string dir action)
(read-file-name-internal string dir action)))
;; Note: t and non-nil mean somewhat different reasons.
(if (eq minibuffer-completion-table 'ffap-read-file-or-url-internal)
(not (ffap-url-p (buffer-string))) ; t
- (memq minibuffer-completion-table
- '(read-file-name-internal read-directory-name-internal)) ; list
- ))
+ (and minibuffer-completing-file-name '(t)))) ;list
(and
(featurep 'complete)
;;
;; Based on overlay highlighting in Emacs 19.28 isearch.el.
-(defvar ffap-highlight (and window-system t)
+(defvar ffap-highlight t
"If non-nil, ffap highlights the current buffer substring.")
(defvar ffap-highlight-overlay nil
(setq ffap-highlight-overlay
(apply 'make-overlay ffap-string-at-point-region))
(overlay-put ffap-highlight-overlay 'face
- (if (internal-find-face 'ffap)
- 'ffap 'highlight)))))
+ (if (facep 'ffap) 'ffap 'highlight)))))
\f
;;; Main Entrance (`find-file-at-point' == `ffap'):
filename))))))
;; Shortcut: allow {M-x ffap} rather than {M-x find-file-at-point}.
-;;;###autoload(defalias 'ffap 'find-file-at-point)
+;;;###autoload
+(defalias 'ffap 'find-file-at-point)
+
\f
;;; Menu support (`ffap-menu'):
(defvar ffap-menu-text-plist
(cond
- ((not window-system) nil)
- (t '(face bold mouse-face highlight))) ; keymap <mousy-map>
+ ((display-mouse-p) '(face bold mouse-face highlight)) ; keymap <mousy-map>
+ (t nil))
"Text properties applied to strings found by `ffap-menu-rescan'.
These properties may be used to fontify the menu references.")
(if (file-directory-p filename)
(dired (expand-file-name filename))
(dired (concat (expand-file-name filename) "*"))))
- ((y-or-n-p "Directory does not exist, create it? ")
+ ((and (file-writable-p (file-name-directory filename))
+ (y-or-n-p "Directory does not exist, create it? "))
(make-directory filename)
(dired filename))
((error "No such file or directory `%s'" filename)))))
;; (setq dired-x-hands-off-my-keys t) ; the default
)
"List of binding forms evaluated by function `ffap-bindings'.
-A reasonable ffap installation needs just these two lines:
- (require 'ffap)
+A reasonable ffap installation needs just this one line:
(ffap-bindings)
Of course if you do not like these bindings, just roll your own!")
+;;;###autoload
(defun ffap-bindings nil
"Evaluate the forms in variable `ffap-bindings'."
+ (interactive)
(eval (cons 'progn ffap-bindings)))
\f