lisp/net/goto-addr.el

   1 ;;; goto-addr.el --- click to browse URL or to send to e-mail address
   2
   3 ;; Copyright (C) 1995, 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Eric Ding <ericding@alum.mit.edu>
   7 ;; Maintainer: FSF
   8 ;; Created: 15 Aug 1995
   9 ;; Keywords: mh-e, www, mouse, mail
  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, or (at your option)
  16 ;; 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; see the file COPYING.  If not, write to the
  25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  26 ;; Boston, MA 02110-1301, USA.
  27
  28 ;;; Commentary:
  29
  30 ;; This package allows you to click or hit a key sequence while on a
  31 ;; URL or e-mail address, and either load the URL into a browser of
  32 ;; your choice using the browse-url package, or if it's an e-mail
  33 ;; address, to send an e-mail to that address.  By default, we bind to
  34 ;; the [mouse-2] and the [C-c return] key sequences.
  35
  36 ;; INSTALLATION
  37 ;;
  38 ;; To use goto-address in a particular mode (for example, while
  39 ;; reading mail in mh-e), add something like this in your .emacs file:
  40 ;;
  41 ;; (add-hook 'mh-show-mode-hook 'goto-address)
  42 ;;
  43 ;; The mouse click method is bound to [mouse-2] on highlighted URLs or
  44 ;; e-mail addresses only; it functions normally everywhere else.  To bind
  45 ;; another mouse click to the function, add the following to your .emacs
  46 ;; (for example):
  47 ;;
  48 ;; (setq goto-address-highlight-keymap
  49 ;;   (let ((m (make-sparse-keymap)))
  50 ;;     (define-key m [S-mouse-2] 'goto-address-at-point)
  51 ;;     m))
  52 ;;
  53
  54 ;; Known bugs/features:
  55 ;; * goto-address-mail-regexp only catches foo@bar.org style addressing,
  56 ;;   not stuff like X.400 addresses, etc.
  57 ;; * regexp also catches Message-Id line, since it is in the format of
  58 ;;   an Internet e-mail address (like Compuserve addresses)
  59 ;; * If the buffer is fontified after goto-address-fontify is run
  60 ;;   (say, using font-lock-fontify-buffer), then font-lock faces will
  61 ;;   override goto-address faces.
  62
  63 ;;; Code:
  64
  65 (require 'thingatpt)
  66 (autoload 'browse-url-url-at-point "browse-url")
  67
  68 ;; XEmacs needs the following definitions.
  69 (unless (fboundp 'overlays-in)
  70   (require 'overlay))
  71 (unless (fboundp 'line-beginning-position)
  72   (defalias 'line-beginning-position 'point-at-bol))
  73 (unless (fboundp 'line-end-position)
  74   (defalias 'line-end-position 'point-at-eol))
  75 (unless (fboundp 'match-string-no-properties)
  76   (defalias 'match-string-no-properties 'match-string))
  77
  78 (defgroup goto-address nil
  79   "Click to browse URL or to send to e-mail address."
  80   :group 'mouse
  81   :group 'hypermedia)
  82
  83
  84 ;; I don't expect users to want fontify'ing without highlighting.
  85 (defcustom goto-address-fontify-p t
  86   "*Non-nil means URLs and e-mail addresses in buffer are fontified.
  87 But only if `goto-address-highlight-p' is also non-nil."
  88   :type 'boolean
  89   :group 'goto-address)
  90
  91 (defcustom goto-address-highlight-p t
  92   "*Non-nil means URLs and e-mail addresses in buffer are highlighted."
  93   :type 'boolean
  94   :group 'goto-address)
  95
  96 (defcustom goto-address-fontify-maximum-size 30000
  97   "*Maximum size of file in which to fontify and/or highlight URLs.
  98 A value of t means there is no limit--fontify regardless of the size."
  99   :type '(choice (integer :tag "Maximum size") (const :tag "No limit" t))
 100   :group 'goto-address)
 101
 102 (defvar goto-address-mail-regexp
 103   ;; Actually pretty much any char could appear in the username part.  -stef
 104   "[-a-zA-Z0-9=._+]+@\\([-a-zA-z0-9_]+\\.\\)+[a-zA-Z0-9]+"
 105   "A regular expression probably matching an e-mail address.")
 106
 107 (defvar goto-address-url-regexp
 108   (concat
 109    "\\<\\("
 110    (mapconcat 'identity
 111               (delete "mailto:"
 112                       ;; Remove `data:', as it's not terribly useful to follow
 113                       ;; those.  Leaving them causes `use Data::Dumper;' to be
 114                       ;; fontified oddly in Perl files.
 115                       (delete "data:"
 116                               (copy-sequence thing-at-point-uri-schemes)))
 117               "\\|")
 118    "\\)"
 119    thing-at-point-url-path-regexp)
 120   ;; (concat "\\b\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|"
 121   ;;      "telnet\\|wais\\):\\(//[-a-zA-Z0-9_.]+:"
 122   ;;      "[0-9]*\\)?[-a-zA-Z0-9_=?#$@~`%&*+|\\/.,]*"
 123   ;;      "[-a-zA-Z0-9_=#$@~`%&*+|\\/]")
 124   "A regular expression probably matching a URL.")
 125
 126 (defvar goto-address-highlight-keymap
 127   (let ((m (make-sparse-keymap)))
 128     (define-key m (if (featurep 'xemacs) (kbd "<button2>") (kbd "<mouse-2>"))
 129       'goto-address-at-point)
 130     (define-key m (kbd "C-c RET") 'goto-address-at-point)
 131     m)
 132   "Keymap to hold goto-addr's mouse key defs under highlighted URLs.")
 133
 134 (defcustom goto-address-url-face 'bold
 135   "Face to use for URLs."
 136   :type 'face
 137   :group 'goto-address)
 138
 139 (defcustom goto-address-url-mouse-face 'highlight
 140   "Face to use for URLs when the mouse is on them."
 141   :type 'face
 142   :group 'goto-address)
 143
 144 (defcustom goto-address-mail-face 'italic
 145   "Face to use for e-mail addresses."
 146   :type 'face
 147   :group 'goto-address)
 148
 149 (defcustom goto-address-mail-mouse-face 'secondary-selection
 150   "Face to use for e-mail addresses when the mouse is on them."
 151   :type 'face
 152   :group 'goto-address)
 153
 154 (defun goto-address-unfontify (start end)
 155   "Remove `goto-address' fontification from the given region."
 156   (dolist (overlay (overlays-in start end))
 157     (if (overlay-get overlay 'goto-address)
 158         (delete-overlay overlay))))
 159
 160 (defun goto-address-fontify ()
 161   "Fontify the URLs and e-mail addresses in the current buffer.
 162 This function implements `goto-address-highlight-p'
 163 and `goto-address-fontify-p'."
 164   ;; Clean up from any previous go.
 165   (goto-address-unfontify (point-min) (point-max))
 166   (save-excursion
 167     (let ((inhibit-point-motion-hooks t))
 168       (goto-char (point-min))
 169       (when (or (eq t goto-address-fontify-maximum-size)
 170                 (< (- (point-max) (point)) goto-address-fontify-maximum-size))
 171         (while (re-search-forward goto-address-url-regexp nil t)
 172           (let* ((s (match-beginning 0))
 173                  (e (match-end 0))
 174                  this-overlay)
 175             (when (or (not goto-address-prog-mode)
 176                       ;; This tests for both comment and string
 177                       ;; syntax.
 178                       (nth 8 (syntax-ppss)))
 179               (setq this-overlay (make-overlay s e))
 180               (and goto-address-fontify-p
 181                    (overlay-put this-overlay 'face goto-address-url-face))
 182               (overlay-put this-overlay 'evaporate t)
 183               (overlay-put this-overlay
 184                            'mouse-face goto-address-url-mouse-face)
 185               (overlay-put this-overlay 'follow-link t)
 186               (overlay-put this-overlay
 187                            'help-echo "mouse-2, C-c RET: follow URL")
 188               (overlay-put this-overlay
 189                            'keymap goto-address-highlight-keymap)
 190               (overlay-put this-overlay 'goto-address t))))
 191         (goto-char (point-min))
 192         (while (re-search-forward goto-address-mail-regexp nil t)
 193           (let* ((s (match-beginning 0))
 194                  (e (match-end 0))
 195                  this-overlay)
 196             (when (or (not goto-address-prog-mode)
 197                       ;; This tests for both comment and string
 198                       ;; syntax.
 199                       (nth 8 (syntax-ppss)))
 200               (setq this-overlay (make-overlay s e))
 201               (and goto-address-fontify-p
 202                    (overlay-put this-overlay 'face goto-address-mail-face))
 203               (overlay-put this-overlay 'evaporate t)
 204               (overlay-put this-overlay 'mouse-face
 205                            goto-address-mail-mouse-face)
 206               (overlay-put this-overlay 'follow-link t)
 207               (overlay-put this-overlay
 208                            'help-echo "mouse-2, C-c RET: mail this address")
 209               (overlay-put this-overlay
 210                            'keymap goto-address-highlight-keymap)
 211               (overlay-put this-overlay 'goto-address t))))))))
 212
 213 (defun goto-address-fontify-region (start end)
 214   "Fontify URLs and e-mail addresses in the given region."
 215   (save-excursion
 216     (save-restriction
 217       (let ((beg-line (progn (goto-char start) (line-beginning-position)))
 218             (end-line (progn (goto-char end) (line-end-position))))
 219         (narrow-to-region beg-line end-line)
 220         (goto-address-fontify)))))
 221
 222 ;; code to find and goto addresses; much of this has been blatantly
 223 ;; snarfed from browse-url.el
 224
 225 ;;;###autoload
 226 (define-obsolete-function-alias
 227   'goto-address-at-mouse 'goto-address-at-point "22.1")
 228
 229 ;;;###autoload
 230 (defun goto-address-at-point (&optional event)
 231   "Send to the e-mail address or load the URL at point.
 232 Send mail to address at point.  See documentation for
 233 `goto-address-find-address-at-point'.  If no address is found
 234 there, then load the URL at or before point."
 235   (interactive (list last-input-event))
 236   (save-excursion
 237     (if event (posn-set-point (event-end event)))
 238     (let ((address (save-excursion (goto-address-find-address-at-point))))
 239       (if (and address
 240                (save-excursion
 241                  (goto-char (previous-single-char-property-change
 242                              (point) 'goto-address nil
 243                              (line-beginning-position)))
 244                  (not (looking-at goto-address-url-regexp))))
 245           (compose-mail address)
 246         (let ((url (browse-url-url-at-point)))
 247           (if url
 248               (browse-url url)
 249             (error "No e-mail address or URL found")))))))
 250
 251 (defun goto-address-find-address-at-point ()
 252   "Find e-mail address around or before point.
 253 Then search backwards to beginning of line for the start of an e-mail
 254 address.  If no e-mail address found, return nil."
 255   (re-search-backward "[^-_A-z0-9.@]" (line-beginning-position) 'lim)
 256   (if (or (looking-at goto-address-mail-regexp) ; already at start
 257           (and (re-search-forward goto-address-mail-regexp
 258                                   (line-end-position) 'lim)
 259                (goto-char (match-beginning 0))))
 260       (match-string-no-properties 0)))
 261
 262 ;;;###autoload
 263 (defun goto-address ()
 264   "Sets up goto-address functionality in the current buffer.
 265 Allows user to use mouse/keyboard command to click to go to a URL
 266 or to send e-mail.
 267 By default, goto-address binds `goto-address-at-point' to mouse-2 and C-c RET
 268 only on URLs and e-mail addresses.
 269
 270 Also fontifies the buffer appropriately (see `goto-address-fontify-p' and
 271 `goto-address-highlight-p' for more information)."
 272   (interactive)
 273   (if goto-address-highlight-p
 274       (goto-address-fontify)))
 275 ;;;###autoload(put 'goto-address 'safe-local-eval-function t)
 276
 277 ;;;###autoload
 278 (define-minor-mode goto-address-mode
 279   "Minor mode to buttonize URLs and e-mail addresses in the current buffer."
 280   nil
 281   ""
 282   nil
 283   (if goto-address-mode
 284       (jit-lock-register #'goto-address-fontify-region)
 285     (jit-lock-unregister #'goto-address-fontify-region)
 286     (save-restriction
 287       (widen)
 288       (goto-address-unfontify (point-min) (point-max)))))
 289
 290 ;;;###autoload
 291 (define-minor-mode goto-address-prog-mode
 292   "Turn on `goto-address-mode', but only in comments and strings."
 293   nil
 294   ""
 295   nil
 296   (if goto-address-prog-mode
 297       (jit-lock-register #'goto-address-fontify-region)
 298     (jit-lock-unregister #'goto-address-fontify-region)
 299     (save-restriction
 300       (widen)
 301       (goto-address-unfontify (point-min) (point-max)))))
 302
 303 (provide 'goto-addr)
 304
 305 ;; arch-tag: ca47c505-5661-425d-a471-62bc6e75cf0a
 306 ;;; goto-addr.el ends here