;;; ffap.el --- find file (or url) at point
;; Copyright (C) 1995, 1996, 1997, 2000, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Michelangelo Grigni <mic@mathcs.emory.edu>
;; Maintainer: FSF
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
\f
;;; Commentary:
;; This used to test for ange-ftp or efs being present, but it should be
;; harmless (and simpler) to give it this value unconditionally.
"\\`/[^/:]+:"
- "*File names matching this regexp are treated as remote ffap.
+ "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" "\\`/[^/:]+:")
:group 'ffap)
(defcustom ffap-url-unwrap-local t
- "*If non-nil, convert `file:' URL to local file name 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 file name 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 file names 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 file names are treated as remote. Use nil to disable."
+ "Matching file names are treated as remote. Use nil to disable."
:type 'regexp
:group 'ffap)
"Regexp matching URL's. nil to disable URL features in ffap.")
(defcustom ffap-foo-at-bar-prefix "mailto"
- "*Presumed URL prefix type of strings like \"<foo.9z@bar>\".
+ "Presumed URL prefix type of strings like \"<foo.9z@bar>\".
Sensible values are nil, \"news\", or \"mailto\"."
:type '(choice (const "mailto")
(const "news")
;; enabler in your .emacs file.
(defcustom ffap-dired-wildcards "[*?][^/]*\\'"
- "*A regexp matching filename wildcard characters, or nil.
+ "A regexp matching filename wildcard characters, or nil.
If `find-file-at-point' gets a filename matching this pattern,
and `ffap-pass-wildcards-to-dired' is nil, it passes it on to
:group 'ffap)
(defcustom ffap-pass-wildcards-to-dired nil
- "*If non-nil, pass filenames matching `ffap-dired-wildcards' to dired."
+ "If non-nil, pass filenames matching `ffap-dired-wildcards' to dired."
:type 'boolean
:group 'ffap)
(defcustom ffap-newfile-prompt nil
;; Suggestion from RHOGEE, 11 Jul 1994. Disabled, I think this is
;; better handled by `find-file-not-found-hooks'.
- "*Whether `find-file-at-point' prompts about a nonexistent file."
+ "Whether `find-file-at-point' prompts about a nonexistent file."
:type 'boolean
:group 'ffap)
(defcustom ffap-require-prefix nil
;; Suggestion from RHOGEE, 20 Oct 1994.
- "*If set, reverses the prefix argument to `find-file-at-point'.
+ "If set, reverses the prefix argument to `find-file-at-point'.
This is nil so neophytes notice ffap. Experts may prefer to disable
ffap most of the time."
:type 'boolean
:group 'ffap)
(defcustom ffap-file-finder 'find-file
- "*The command called by `find-file-at-point' to find a file."
+ "The command called by `find-file-at-point' to find a file."
:type 'function
:group 'ffap)
(put 'ffap-file-finder 'risky-local-variable t)
(defcustom ffap-directory-finder 'dired
- "*The command called by `dired-at-point' to find a directory."
+ "The command called by `dired-at-point' to find a directory."
:type 'function
:group 'ffap)
(put 'ffap-directory-finder 'risky-local-variable t)
;; Remote control references:
;; http://www.ncsa.uiuc.edu/SDG/Software/XMosaic/remote-control.html
;; http://home.netscape.com/newsref/std/x-remote.html
- "*A function of one argument, called by ffap to fetch an URL.
+ "A function of one argument, called by ffap to fetch an URL.
Reasonable choices are `w3-fetch' or a `browse-url-*' function.
For a fancy alternative, get `ffap-url.el'."
:type '(choice (const w3-fetch)
;; It pays to put a big fancy regexp here, since ffap-guesser is
;; much more time-consuming than regexp searching:
"[/:.~[:alpha:]]/\\|@[[:alpha:]][-[:alnum:]]*\\."
- "*Regular expression governing movements of `ffap-next'."
+ "Regular expression governing movements of `ffap-next'."
:type 'regexp
:group 'ffap)
;; particular, if `Pinging...' is broken or takes too long on your
;; machine, try setting these all to accept or reject.
(defcustom ffap-machine-p-local 'reject ; this happens often
- "*What `ffap-machine-p' does with hostnames that have no domain.
+ "What `ffap-machine-p' does with hostnames that have no domain.
Value should be a symbol, one of `ping', `accept', and `reject'."
:type '(choice (const ping)
(const accept)
(const reject))
:group 'ffap)
(defcustom ffap-machine-p-known 'ping ; `accept' for higher speed
- "*What `ffap-machine-p' does with hostnames that have a known domain.
+ "What `ffap-machine-p' does with hostnames that have a known domain.
Value should be a symbol, one of `ping', `accept', and `reject'.
See `mail-extr.el' for the known domains."
:type '(choice (const ping)
(const reject))
:group 'ffap)
(defcustom ffap-machine-p-unknown 'reject
- "*What `ffap-machine-p' does with hostnames that have an unknown domain.
+ "What `ffap-machine-p' does with hostnames that have an unknown domain.
Value should be a symbol, one of `ping', `accept', and `reject'.
See `mail-extr.el' for the known domains."
:type '(choice (const ping)
;; (ffap-machine-p "mathcs" 5678 nil 'ping)
;; (ffap-machine-p "foo.bonk" nil nil 'ping)
;; (ffap-machine-p "foo.bonk.com" nil nil 'ping)
- (if (or (string-match "[^-[:alnum:].]" host) ; Illegal chars (?)
+ (if (or (string-match "[^-[:alnum:].]" host) ; Invalid chars (?)
(not (string-match "[^0-9]" host))) ; 1: a number? 2: quick reject
nil
(let* ((domain
((and ffap-url-unwrap-local (ffap-url-unwrap-local url)))
((and ffap-url-unwrap-remote ffap-ftp-regexp
(ffap-url-unwrap-remote url)))
- ((fboundp 'url-normalize-url) ; may autoload url (part of w3)
- (url-normalize-url url))
+ ;; All this seems to do is remove any trailing "#anchor" part (Bug#898).
+;;; ((fboundp 'url-normalize-url) ; may autoload url (part of w3)
+;;; (url-normalize-url url))
(url)))
\f
(ffap-locate-file name t ffap-bib-path))
(defun ffap-dired (name)
- (let ((pt (point)) dir try)
+ (let ((pt (point)) try)
(save-excursion
(and (progn
(beginning-of-line)
"/pub/gnu/emacs/elisp-archive/"))
(substring name 2))))
+(defcustom ffap-rfc-directories nil
+ "A list of directories to look for RFC files.
+If a given RFC isn't in these then `ffap-rfc-path' is offered."
+ :type '(repeat directory)
+ :version "23.1"
+ :group 'ffap)
+
(defvar ffap-rfc-path
(concat (ffap-host-to-filename "ftp.rfc-editor.org") "/in-notes/rfc%s.txt"))
(defun ffap-rfc (name)
- (format ffap-rfc-path
- (substring name (match-beginning 1) (match-end 1))))
+ (let ((num (match-string 1 name)))
+ (or (ffap-locate-file (format "rfc%s.txt" num) t ffap-rfc-directories)
+ (format ffap-rfc-path num))))
\f
;;; At-Point Functions:
;; Slightly controversial decisions:
;; * strip trailing "@" and ":"
;; * no commas (good for latex)
- (file "--:\\\\$+<>@-Z_[:lower:]~*?" "<@" "@>;.,!:")
+ (file "--:\\\\$+<>@-Z_[:alpha:]~*?" "<@" "@>;.,!:")
;; An url, or maybe a email/news message-id:
- (url "--:=&?$+@-Z_[:lower:]~#,%;*" "^[:alnum:]" ":;.,!?")
+ (url "--:=&?$+@-Z_[:alpha:]~#,%;*" "^[:alnum:]" ":;.,!?")
;; Find a string that does *not* contain a colon:
- (nocolon "--9$+<>@-Z_[:lower:]~" "<@" "@>;.,!?")
+ (nocolon "--9$+<>@-Z_[:alpha:]~" "<@" "@>;.,!?")
;; A machine:
(machine "-[:alnum:]." "" ".")
;; Mathematica paths: allow backquotes
(push fnh-elem file-name-handler-alist)
(unwind-protect
(setq guess
- (completing-read
- prompt
- 'ffap-read-file-or-url-internal
- dir
- nil
- (if dir (cons guess (length dir)) guess)
- (list 'file-name-history)
- (and buffer-file-name
- (abbreviate-file-name buffer-file-name))))
+ (let ((default-directory (if dir (expand-file-name dir)
+ default-directory)))
+ (completing-read
+ prompt
+ 'ffap-read-file-or-url-internal
+ nil
+ nil
+ (if dir (cons guess (length dir)) guess)
+ (list 'file-name-history)
+ (and buffer-file-name
+ (abbreviate-file-name buffer-file-name)))))
;; Remove the special handler manually. We used to just let-bind
;; file-name-handler-alist to preserve its value, but that caused
;; other modifications to be lost (e.g. when Tramp gets loaded
;; Note: upcoming url.el package ought to handle this automatically.
guess))
-(defun ffap-read-url-internal (string dir action)
+(defun ffap-read-url-internal (string pred action)
"Complete url's from history, treating given string as valid."
(let ((hist (ffap-soft-value "url-global-history-hash-table")))
(cond
((not action)
- (or (try-completion string hist) string))
+ (or (try-completion string hist pred) string))
((eq action t)
- (or (all-completions string hist) (list string)))
+ (or (all-completions string hist pred) (list string)))
;; action == lambda, documented where? Tests whether string is a
;; valid "match". Let us always say yes.
(t t))))
-(defun ffap-read-file-or-url-internal (string dir action)
- (unless dir
- (setq dir default-directory))
- (unless string
+(defun ffap-read-file-or-url-internal (string pred action)
+ (unless string ;Why would this ever happen?
(setq string default-directory))
(if (ffap-url-p string)
- (ffap-read-url-internal string dir action)
- (read-file-name-internal string dir action)))
+ (ffap-read-url-internal string pred action)
+ (read-file-name-internal string pred action)))
;; The rest of this page is just to work with package complete.el.
;; This code assumes that you load ffap.el after complete.el.
(ffap-read-file-or-url
(if ffap-url-regexp "Find file or URL: " "Find file: ")
(prog1
- (setq guess (or guess (ffap-guesser))) ; using ffap-alist here
+ (let ((mark-active nil))
+ ;; Don't use the region here, since it can be something
+ ;; completely unwieldy. If the user wants that, she could
+ ;; use M-w before and then C-y. --Stef
+ (setq guess (or guess (ffap-guesser)))) ; using ffap-alist here
(and guess (ffap-highlight))
)))
(ffap-highlight t)))
(x-popup-menu
t
(list "" (cons title
- (mapcar (function (lambda (i) (cons (car i) i)))
+ (mapcar (lambda (i) (cons (car i) i))
alist))))))
;; minibuffer with completion buffer:
(t
nil)))
(sit-for 0) ; redraw original screen
;; Convert string to its entry, or else the default:
- (setq choice (or (assoc choice alist) (car alist))))
- )
+ (setq choice (or (assoc choice alist) (car alist)))))
(if choice
(funcall cont choice)
(message "No choice made!") ; possible with menus
ffap-menu-text-plist)
(message "Scanning...%2d%% <%s>"
(/ (* 100 (- (point) (point-min))) range) item)))
- (or mod (set-buffer-modified-p nil))))
+ (or mod (restore-buffer-modified-p nil))))
(message "Scanning...done")
;; Remove duplicates.
(setq ffap-menu-alist ; sort by item
\f
(defcustom dired-at-point-require-prefix nil
- "*If set, reverses the prefix argument to `dired-at-point'.
+ "If set, reverses the prefix argument to `dired-at-point'.
This is nil so neophytes notice ffap. Experts may prefer to disable
ffap most of the time."
:type 'boolean
\f
-;;; arch-tag: 9dd3e88a-5dec-4607-bd57-60ae9ede8ebc
+;; arch-tag: 9dd3e88a-5dec-4607-bd57-60ae9ede8ebc
;;; ffap.el ends here