Commit | Line | Data |
---|---|---|
8749abea GM |
1 | ;;; goto-addr.el --- click to browse URL or to send to e-mail address |
2 | ||
67ac0f7a | 3 | ;; Copyright (C) 1995, 2000, 2001 Free Software Foundation, Inc. |
8749abea | 4 | |
cf6936a4 | 5 | ;; Author: Eric Ding <ericding@alum.mit.edu> |
12c74386 | 6 | ;; Maintainer: FSF |
8749abea GM |
7 | ;; Created: 15 Aug 1995 |
8 | ;; Keywords: mh-e, www, mouse, mail | |
9 | ||
10 | ;; This file is part of GNU Emacs. | |
11 | ||
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. | |
16 | ||
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. | |
21 | ||
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. | |
26 | ||
27 | ;;; Commentary: | |
28 | ||
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. | |
34 | ||
35 | ;; INSTALLATION | |
36 | ;; | |
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) | |
41 | ;; | |
28223a7e | 42 | ;; The mouse click method is bound to [mouse-2] on highlighted URLs or |
8749abea GM |
43 | ;; e-mail addresses only; it functions normally everywhere else. To bind |
44 | ;; another mouse click to the function, add the following to your .emacs | |
45 | ;; (for example): | |
46 | ;; | |
47 | ;; (setq goto-address-highlight-keymap | |
48 | ;; (let ((m (make-sparse-keymap))) | |
49 | ;; (define-key m [S-mouse-2] 'goto-address-at-mouse) | |
50 | ;; m)) | |
51 | ;; | |
52 | ||
8749abea GM |
53 | ;; Known bugs/features: |
54 | ;; * goto-address-mail-regexp only catches foo@bar.org style addressing, | |
55 | ;; not stuff like X.400 addresses, etc. | |
56 | ;; * regexp also catches Message-Id line, since it is in the format of | |
57 | ;; an Internet e-mail address (like Compuserve addresses) | |
51107a70 DL |
58 | ;; * If the buffer is fontified after goto-address-fontify is run |
59 | ;; (say, using font-lock-fontify-buffer), then font-lock faces will | |
8749abea GM |
60 | ;; override goto-address faces. |
61 | ||
62 | ;;; Code: | |
63 | ||
f79538c9 DL |
64 | (require 'thingatpt) |
65 | (autoload 'browse-url-url-at-point "browse-url") | |
8749abea | 66 | |
67ac0f7a GM |
67 | ;; XEmacs needs the following definitions. |
68 | (unless (fboundp 'overlays-in) | |
69 | (require 'overlay)) | |
70 | (unless (fboundp 'line-beginning-position) | |
71 | (defalias 'line-beginning-position 'point-at-bol)) | |
72 | (unless (fboundp 'line-end-position) | |
73 | (defalias 'line-end-position 'point-at-eol)) | |
74 | (unless (fboundp 'match-string-no-properties) | |
75 | (defalias 'match-string-no-properties 'match-string)) | |
76 | ||
8749abea GM |
77 | (defgroup goto-address nil |
78 | "Click to browse URL or to send to e-mail address." | |
79 | :group 'mouse | |
80 | :group 'hypermedia) | |
81 | ||
82 | ||
d8754ce5 | 83 | ;; I don't expect users to want fontify'ing without highlighting. |
8749abea | 84 | (defcustom goto-address-fontify-p t |
f79538c9 | 85 | "*Non-nil means URLs and e-mail addresses in buffer are fontified. |
8749abea GM |
86 | But only if `goto-address-highlight-p' is also non-nil." |
87 | :type 'boolean | |
88 | :group 'goto-address) | |
89 | ||
90 | (defcustom goto-address-highlight-p t | |
f79538c9 | 91 | "*Non-nil means URLs and e-mail addresses in buffer are highlighted." |
8749abea GM |
92 | :type 'boolean |
93 | :group 'goto-address) | |
94 | ||
95 | (defcustom goto-address-fontify-maximum-size 30000 | |
3e61755b RS |
96 | "*Maximum size of file in which to fontify and/or highlight URLs. |
97 | A value of t means there is no limit--fontify regardless of the size." | |
98 | :type '(choice (integer :tag "Maximum size") (const :tag "No limit" t)) | |
8749abea GM |
99 | :group 'goto-address) |
100 | ||
101 | (defvar goto-address-mail-regexp | |
138399e6 SM |
102 | ;; Actually pretty much any char could appear in the username part. -stef |
103 | "[-a-zA-Z0-9._+]+@\\([-a-zA-z0-9_]+\\.\\)+[a-zA-Z0-9]+" | |
8749abea GM |
104 | "A regular expression probably matching an e-mail address.") |
105 | ||
019f8c1e RS |
106 | (defvar goto-address-url-regexp |
107 | (concat "\\<\\(" | |
108 | (mapconcat 'identity | |
109 | (delete "mailto:" (copy-sequence thing-at-point-uri-schemes)) | |
110 | "\\|") | |
111 | "\\)" | |
112 | thing-at-point-url-path-regexp) | |
d8754ce5 GM |
113 | ;; (concat "\\b\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|" |
114 | ;; "telnet\\|wais\\):\\(//[-a-zA-Z0-9_.]+:" | |
115 | ;; "[0-9]*\\)?[-a-zA-Z0-9_=?#$@~`%&*+|\\/.,]*" | |
116 | ;; "[-a-zA-Z0-9_=#$@~`%&*+|\\/]") | |
8749abea GM |
117 | "A regular expression probably matching a URL.") |
118 | ||
119 | (defvar goto-address-highlight-keymap | |
120 | (let ((m (make-sparse-keymap))) | |
67ac0f7a GM |
121 | (if (featurep 'xemacs) |
122 | (define-key m (kbd "<button2>") 'goto-address-at-mouse) | |
123 | (define-key m (kbd "<mouse-2>") 'goto-address-at-mouse)) | |
124 | (define-key m (kbd "C-c RET") 'goto-address-at-point) | |
8749abea GM |
125 | m) |
126 | "keymap to hold goto-addr's mouse key defs under highlighted URLs.") | |
127 | ||
128 | (defcustom goto-address-url-face 'bold | |
f79538c9 | 129 | "Face to use for URLs." |
8749abea GM |
130 | :type 'face |
131 | :group 'goto-address) | |
132 | ||
133 | (defcustom goto-address-url-mouse-face 'highlight | |
f79538c9 | 134 | "Face to use for URLs when the mouse is on them." |
8749abea GM |
135 | :type 'face |
136 | :group 'goto-address) | |
137 | ||
138 | (defcustom goto-address-mail-face 'italic | |
f79538c9 | 139 | "Face to use for e-mail addresses." |
8749abea GM |
140 | :type 'face |
141 | :group 'goto-address) | |
142 | ||
143 | (defcustom goto-address-mail-mouse-face 'secondary-selection | |
f79538c9 | 144 | "Face to use for e-mail addresses when the mouse is on them." |
8749abea GM |
145 | :type 'face |
146 | :group 'goto-address) | |
147 | ||
148 | (defun goto-address-fontify () | |
28223a7e | 149 | "Fontify the URLs and e-mail addresses in the current buffer. |
8749abea GM |
150 | This function implements `goto-address-highlight-p' |
151 | and `goto-address-fontify-p'." | |
51107a70 DL |
152 | ;; Clean up from any previous go. |
153 | (dolist (overlay (overlays-in (point-min) (point-max))) | |
154 | (if (overlay-get overlay 'goto-address) | |
155 | (delete-overlay overlay))) | |
8749abea | 156 | (save-excursion |
51107a70 | 157 | (let ((inhibit-point-motion-hooks t)) |
8749abea | 158 | (goto-char (point-min)) |
3e61755b RS |
159 | (if (or (eq t goto-address-fontify-maximum-size) |
160 | (< (- (point-max) (point)) goto-address-fontify-maximum-size)) | |
8749abea GM |
161 | (progn |
162 | (while (re-search-forward goto-address-url-regexp nil t) | |
163 | (let* ((s (match-beginning 0)) | |
164 | (e (match-end 0)) | |
165 | (this-overlay (make-overlay s e))) | |
166 | (and goto-address-fontify-p | |
167 | (overlay-put this-overlay 'face goto-address-url-face)) | |
168 | (overlay-put this-overlay | |
169 | 'mouse-face goto-address-url-mouse-face) | |
fa59072a DL |
170 | (overlay-put this-overlay |
171 | 'help-echo "mouse-2: follow URL") | |
8749abea | 172 | (overlay-put this-overlay |
51107a70 DL |
173 | 'keymap goto-address-highlight-keymap) |
174 | (overlay-put this-overlay 'goto-address t))) | |
8749abea GM |
175 | (goto-char (point-min)) |
176 | (while (re-search-forward goto-address-mail-regexp nil t) | |
177 | (let* ((s (match-beginning 0)) | |
178 | (e (match-end 0)) | |
179 | (this-overlay (make-overlay s e))) | |
180 | (and goto-address-fontify-p | |
181 | (overlay-put this-overlay 'face goto-address-mail-face)) | |
182 | (overlay-put this-overlay 'mouse-face | |
183 | goto-address-mail-mouse-face) | |
fa59072a | 184 | (overlay-put this-overlay |
f79538c9 | 185 | 'help-echo "mouse-2: mail this address") |
8749abea | 186 | (overlay-put this-overlay |
51107a70 DL |
187 | 'keymap goto-address-highlight-keymap) |
188 | (overlay-put this-overlay 'goto-address t)))))))) | |
8749abea | 189 | |
d8754ce5 GM |
190 | ;; code to find and goto addresses; much of this has been blatantly |
191 | ;; snarfed from browse-url.el | |
8749abea GM |
192 | |
193 | ;;;###autoload | |
194 | (defun goto-address-at-mouse (event) | |
195 | "Send to the e-mail address or load the URL clicked with the mouse. | |
196 | Send mail to address at position of mouse click. See documentation for | |
197 | `goto-address-find-address-at-point'. If no address is found | |
198 | there, then load the URL at or before the position of the mouse click." | |
199 | (interactive "e") | |
200 | (save-excursion | |
f79538c9 DL |
201 | (mouse-set-point event) |
202 | (goto-address-at-point))) | |
8749abea GM |
203 | |
204 | ;;;###autoload | |
205 | (defun goto-address-at-point () | |
206 | "Send to the e-mail address or load the URL at point. | |
207 | Send mail to address at point. See documentation for | |
208 | `goto-address-find-address-at-point'. If no address is found | |
209 | there, then load the URL at or before point." | |
210 | (interactive) | |
211 | (save-excursion | |
212 | (let ((address (save-excursion (goto-address-find-address-at-point)))) | |
a1506d29 | 213 | (if (and address |
1c66d9fb GM |
214 | (save-excursion |
215 | (goto-char (previous-single-char-property-change | |
216 | (point) 'goto-address nil | |
217 | (line-beginning-position))) | |
218 | (not (looking-at goto-address-url-regexp)))) | |
f79538c9 DL |
219 | (compose-mail address) |
220 | (let ((url (browse-url-url-at-point))) | |
221 | (if url | |
222 | (browse-url url) | |
223 | (error "No e-mail address or URL found"))))))) | |
8749abea GM |
224 | |
225 | (defun goto-address-find-address-at-point () | |
226 | "Find e-mail address around or before point. | |
227 | Then search backwards to beginning of line for the start of an e-mail | |
f79538c9 DL |
228 | address. If no e-mail address found, return nil." |
229 | (re-search-backward "[^-_A-z0-9.@]" (line-beginning-position) 'lim) | |
230 | (if (or (looking-at goto-address-mail-regexp) ; already at start | |
231 | (and (re-search-forward goto-address-mail-regexp | |
232 | (line-end-position) 'lim) | |
233 | (goto-char (match-beginning 0)))) | |
234 | (match-string-no-properties 0))) | |
8749abea GM |
235 | |
236 | ;;;###autoload | |
237 | (defun goto-address () | |
238 | "Sets up goto-address functionality in the current buffer. | |
239 | Allows user to use mouse/keyboard command to click to go to a URL | |
240 | or to send e-mail. | |
241 | By default, goto-address binds to mouse-2 and C-c RET. | |
242 | ||
243 | Also fontifies the buffer appropriately (see `goto-address-fontify-p' and | |
244 | `goto-address-highlight-p' for more information)." | |
245 | (interactive) | |
8749abea GM |
246 | (if goto-address-highlight-p |
247 | (goto-address-fontify))) | |
248 | ||
249 | (provide 'goto-addr) | |
250 | ||
ab5796a9 | 251 | ;;; arch-tag: ca47c505-5661-425d-a471-62bc6e75cf0a |
55535639 | 252 | ;;; goto-addr.el ends here |