new version
[emacs.git] / lisp / goto-addr.el
blob7a4026158a80553aabfc894e492c5f165dc890f4
1 ;;; goto-addr.el --- click to browse URL or to send to e-mail address
3 ;; Copyright (C) 1995 Free Software Foundation, Inc.
5 ;; Author: Eric Ding <ericding@mit.edu>
6 ;; Maintainer: Eric Ding <ericding@mit.edu>
7 ;; Created: 15 Aug 1995
8 ;; Keywords: mh-e, www, mouse, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; This package allows you to click or hit a key sequence while on a
30 ;; URL or e-mail address, and either load the URL into a browser of
31 ;; your choice using the browse-url package, or if it's an e-mail
32 ;; address, to send an e-mail to that address. By default, we bind to
33 ;; the [mouse-2] and the [C-c return] key sequences.
35 ;; INSTALLATION
37 ;; To use goto-address in a particular mode (for example, while
38 ;; reading mail in mh-e), add something like this in your .emacs file:
39 ;;
40 ;; (add-hook 'mh-show-mode-hook 'goto-address)
42 ;; By default, goto-address now sends using `mail' instead of `mh-send'.
43 ;; To use mh-e to send mail, add the following to your .emacs file:
45 ;; (setq goto-address-mail-method 'goto-address-send-using-mh-e)
47 ;; The mouse click method is bound to [mouse-2] on highlighted URL's or
48 ;; e-mail addresses only; it functions normally everywhere else. To bind
49 ;; another mouse click to the function, add the following to your .emacs
50 ;; (for example):
52 ;; (setq goto-address-highlight-keymap
53 ;; (let ((m (make-sparse-keymap)))
54 ;; (define-key m [S-mouse-2] 'goto-address-at-mouse)
55 ;; m))
58 ;; BUG REPORTS
60 ;; Please send bug reports to me at ericding@mit.edu.
62 ;; Known bugs/features:
63 ;; * goto-address-mail-regexp only catches foo@bar.org style addressing,
64 ;; not stuff like X.400 addresses, etc.
65 ;; * regexp also catches Message-Id line, since it is in the format of
66 ;; an Internet e-mail address (like Compuserve addresses)
67 ;; * If show buffer is fontified after goto-address-fontify is run
68 ;; (say, using font-lock-fontify-buffer), then font-lock face will
69 ;; override goto-address faces.
71 ;;; Code:
73 (require 'browse-url)
75 (defgroup goto-address nil
76 "Click to browse URL or to send to e-mail address."
77 :group 'mouse
78 :group 'hypermedia)
81 ;;; I don't expect users to want fontify'ing without highlighting.
82 (defcustom goto-address-fontify-p t
83 "*If t, URL's and e-mail addresses in buffer are fontified.
84 But only if `goto-address-highlight-p' is also non-nil."
85 :type 'boolean
86 :group 'goto-address)
88 (defcustom goto-address-highlight-p t
89 "*If t, URL's and e-mail addresses in buffer are highlighted."
90 :type 'boolean
91 :group 'goto-address)
93 (defcustom goto-address-fontify-maximum-size 30000
94 "*Maximum size of file in which to fontify and/or highlight URL's."
95 :type 'integer
96 :group 'goto-address)
98 (defvar goto-address-mail-regexp
99 "[-a-zA-Z0-9._]+@\\([-a-zA-z0-9_]+\\.\\)+[a-zA-Z0-9]+"
100 "A regular expression probably matching an e-mail address.")
102 (defvar goto-address-url-regexp
103 (concat "\\b\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|"
104 "telnet\\|wais\\):\\(//[-a-zA-Z0-9_.]+:"
105 "[0-9]*\\)?[-a-zA-Z0-9_=?#$@~`%&*+|\\/.,]*"
106 "[-a-zA-Z0-9_=#$@~`%&*+|\\/]")
107 "A regular expression probably matching a URL.")
109 (defcustom goto-address-mail-method
110 'goto-address-send-using-mail
111 "*Function to compose mail.
112 Two pre-made functions are `goto-address-send-using-mail' (sendmail);
113 and `goto-address-send-using-mh-e' (MH-E)."
114 :type 'function
115 :group 'goto-address)
117 (defvar goto-address-highlight-keymap
118 (let ((m (make-sparse-keymap)))
119 (define-key m [mouse-2] 'goto-address-at-mouse)
121 "keymap to hold goto-addr's mouse key defs under highlighted URLs.")
123 (defcustom goto-address-url-face 'bold
124 "*Face to use for URLs."
125 :type 'face
126 :group 'goto-address)
128 (defcustom goto-address-url-mouse-face 'highlight
129 "*Face to use for URLs when the mouse is on them."
130 :type 'face
131 :group 'goto-address)
133 (defcustom goto-address-mail-face 'italic
134 "*Face to use for e-mail addresses."
135 :type 'face
136 :group 'goto-address)
138 (defcustom goto-address-mail-mouse-face 'secondary-selection
139 "*Face to use for e-mail addresses when the mouse is on them."
140 :type 'face
141 :group 'goto-address)
143 (defun goto-address-fontify ()
144 "Fontify the URL's and e-mail addresses in the current buffer.
145 This function implements `goto-address-highlight-p'
146 and `goto-address-fontify-p'."
147 (save-excursion
148 (let ((inhibit-read-only t)
149 (inhibit-point-motion-hooks t)
150 (modified (buffer-modified-p)))
151 (goto-char (point-min))
152 (if (< (- (point-max) (point)) goto-address-fontify-maximum-size)
153 (progn
154 (while (re-search-forward goto-address-url-regexp nil t)
155 (let* ((s (match-beginning 0))
156 (e (match-end 0))
157 (this-overlay (make-overlay s e)))
158 (and goto-address-fontify-p
159 (overlay-put this-overlay 'face goto-address-url-face))
160 (overlay-put this-overlay
161 'mouse-face goto-address-url-mouse-face)
162 (overlay-put this-overlay
163 'local-map goto-address-highlight-keymap)))
164 (goto-char (point-min))
165 (while (re-search-forward goto-address-mail-regexp nil t)
166 (let* ((s (match-beginning 0))
167 (e (match-end 0))
168 (this-overlay (make-overlay s e)))
169 (and goto-address-fontify-p
170 (overlay-put this-overlay 'face goto-address-mail-face))
171 (overlay-put this-overlay 'mouse-face
172 goto-address-mail-mouse-face)
173 (overlay-put this-overlay
174 'local-map goto-address-highlight-keymap)))))
175 (and (buffer-modified-p)
176 (not modified)
177 (set-buffer-modified-p nil)))))
179 ;;; code to find and goto addresses; much of this has been blatantly
180 ;;; snarfed from browse-url.el
182 ;;;###autoload
183 (defun goto-address-at-mouse (event)
184 "Send to the e-mail address or load the URL clicked with the mouse.
185 Send mail to address at position of mouse click. See documentation for
186 `goto-address-find-address-at-point'. If no address is found
187 there, then load the URL at or before the position of the mouse click."
188 (interactive "e")
189 (save-excursion
190 (let ((posn (event-start event)))
191 (set-buffer (window-buffer (posn-window posn)))
192 (goto-char (posn-point posn))
193 (let ((address
194 (save-excursion (goto-address-find-address-at-point))))
195 (if (string-equal address "")
196 (let ((url (browse-url-url-at-point)))
197 (if (string-equal url "")
198 (error "No e-mail address or URL found")
199 (funcall browse-url-browser-function url)))
200 (funcall goto-address-mail-method address))))))
202 ;;;###autoload
203 (defun goto-address-at-point ()
204 "Send to the e-mail address or load the URL at point.
205 Send mail to address at point. See documentation for
206 `goto-address-find-address-at-point'. If no address is found
207 there, then load the URL at or before point."
208 (interactive)
209 (save-excursion
210 (let ((address (save-excursion (goto-address-find-address-at-point))))
211 (if (string-equal address "")
212 (let ((url (browse-url-url-at-point)))
213 (if (string-equal url "")
214 (error "No e-mail address or URL found")
215 (funcall browse-url-browser-function url)))
216 (funcall goto-address-mail-method address)))))
218 (defun goto-address-find-address-at-point ()
219 "Find e-mail address around or before point.
220 Then search backwards to beginning of line for the start of an e-mail
221 address. If no e-mail address found, return the empty string."
222 (let ((bol (save-excursion (beginning-of-line) (point))))
223 (re-search-backward "[^-_A-z0-9.@]" bol 'lim)
224 (if (or (looking-at goto-address-mail-regexp) ; already at start
225 (let ((eol (save-excursion (end-of-line) (point))))
226 (and (re-search-forward goto-address-mail-regexp eol 'lim)
227 (goto-char (match-beginning 0)))))
228 (buffer-substring (match-beginning 0) (match-end 0))
229 "")))
231 (defun goto-address-send-using-mh-e (to)
232 (require 'mh-comp)
233 (mh-find-path)
234 (let ((cc (mh-read-address "Cc: "))
235 (subject (read-string "Subject: "))
236 (config (current-window-configuration)))
237 (delete-other-windows)
238 (mh-send-sub to cc subject config)))
240 (fset 'goto-address-send-using-mhe 'goto-address-send-using-mh-e)
242 (defun goto-address-send-using-mail (to)
243 (mail-other-window nil to)
244 (and (goto-char (point-min))
245 (end-of-line 2)))
247 ;;;###autoload
248 (defun goto-address ()
249 "Sets up goto-address functionality in the current buffer.
250 Allows user to use mouse/keyboard command to click to go to a URL
251 or to send e-mail.
252 By default, goto-address binds to mouse-2 and C-c RET.
254 Also fontifies the buffer appropriately (see `goto-address-fontify-p' and
255 `goto-address-highlight-p' for more information)."
256 (interactive)
257 (local-set-key "\C-c\r" 'goto-address-at-point)
258 (if goto-address-highlight-p
259 (goto-address-fontify)))
261 (provide 'goto-addr)
263 ;;; goto-addr.el ends here.