thingatpt.el 21.2 KB
Newer Older
1
;;; thingatpt.el --- get the `thing' at point
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1991-1998, 2000-2015 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5

;; Author: Mike Williams <mikew@gopher.dosli.govt.nz>
6
;; Maintainer: emacs-devel@gnu.org
Richard M. Stallman's avatar
Richard M. Stallman committed
7
;; Keywords: extensions, matching, mouse
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11
;; Created: Thu Mar 28 13:48:23 1991

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

22 23 24
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

Richard M. Stallman's avatar
Richard M. Stallman committed
25
;;; Commentary:
Erik Naggum's avatar
Erik Naggum committed
26

27 28
;; This file provides routines for getting the "thing" at the location of
;; point, whatever that "thing" happens to be.  The "thing" is defined by
Richard M. Stallman's avatar
Richard M. Stallman committed
29
;; its beginning and end positions in the buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
30 31
;;
;; The function bounds-of-thing-at-point finds the beginning and end
32
;; positions by moving first forward to the end of the "thing", and then
Richard M. Stallman's avatar
Richard M. Stallman committed
33
;; backwards to the beginning.  By default, it uses the corresponding
34
;; forward-"thing" operator (eg. forward-word, forward-line).
Richard M. Stallman's avatar
Richard M. Stallman committed
35 36
;;
;; Special cases are allowed for using properties associated with the named
37
;; "thing":
Richard M. Stallman's avatar
Richard M. Stallman committed
38
;;
39
;;   forward-op		Function to call to skip forward over a "thing" (or
Richard M. Stallman's avatar
Richard M. Stallman committed
40
;;                      with a negative argument, backward).
41
;;
42 43
;;   beginning-op	Function to call to skip to the beginning of a "thing".
;;   end-op		Function to call to skip to the end of a "thing".
Richard M. Stallman's avatar
Richard M. Stallman committed
44 45 46 47 48 49
;;
;; Reliance on existing operators means that many `things' can be accessed
;; without further code:  eg.
;;     (thing-at-point 'line)
;;     (thing-at-point 'page)

Erik Naggum's avatar
Erik Naggum committed
50
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
51 52 53

(provide 'thingatpt)

Erik Naggum's avatar
Erik Naggum committed
54
;; Basic movement
Richard M. Stallman's avatar
Richard M. Stallman committed
55 56

;;;###autoload
57
(defun forward-thing (thing &optional n)
Chong Yidong's avatar
Chong Yidong committed
58 59 60 61 62
  "Move forward to the end of the Nth next THING.
THING should be a symbol specifying a type of syntactic entity.
Possibilities include `symbol', `list', `sexp', `defun',
`filename', `url', `email', `word', `sentence', `whitespace',
`line', and `page'."
63 64
  (let ((forward-op (or (get thing 'forward-op)
			(intern-soft (format "forward-%s" thing)))))
65
    (if (functionp forward-op)
66 67
	(funcall forward-op (or n 1))
      (error "Can't determine how to move over a %s" thing))))
Richard M. Stallman's avatar
Richard M. Stallman committed
68

Erik Naggum's avatar
Erik Naggum committed
69
;; General routines
Richard M. Stallman's avatar
Richard M. Stallman committed
70 71

;;;###autoload
72 73
(defun bounds-of-thing-at-point (thing)
  "Determine the start and end buffer locations for the THING at point.
Chong Yidong's avatar
Chong Yidong committed
74 75 76 77
THING should be a symbol specifying a type of syntactic entity.
Possibilities include `symbol', `list', `sexp', `defun',
`filename', `url', `email', `word', `sentence', `whitespace',
`line', and `page'.
78

Chong Yidong's avatar
Chong Yidong committed
79 80
See the file `thingatpt.el' for documentation on how to define a
valid THING.
81

Chong Yidong's avatar
Chong Yidong committed
82 83
Return a cons cell (START . END) giving the start and end
positions of the thing found."
84 85 86
  (if (get thing 'bounds-of-thing-at-point)
      (funcall (get thing 'bounds-of-thing-at-point))
    (let ((orig (point)))
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
      (ignore-errors
	(save-excursion
	  ;; Try moving forward, then back.
	  (funcall ;; First move to end.
	   (or (get thing 'end-op)
	       (lambda () (forward-thing thing 1))))
	  (funcall ;; Then move to beg.
	   (or (get thing 'beginning-op)
	       (lambda () (forward-thing thing -1))))
	  (let ((beg (point)))
	    (if (<= beg orig)
		;; If that brings us all the way back to ORIG,
		;; it worked.  But END may not be the real end.
		;; So find the real end that corresponds to BEG.
		;; FIXME: in which cases can `real-end' differ from `end'?
		(let ((real-end
103 104
		       (progn
			 (funcall
105 106
			  (or (get thing 'end-op)
			      (lambda () (forward-thing thing 1))))
107
			 (point))))
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
		  (when (and (<= orig real-end) (< beg real-end))
		    (cons beg real-end)))
	      (goto-char orig)
	      ;; Try a second time, moving backward first and then forward,
	      ;; so that we can find a thing that ends at ORIG.
	      (funcall ;; First, move to beg.
	       (or (get thing 'beginning-op)
		   (lambda () (forward-thing thing -1))))
	      (funcall ;; Then move to end.
	       (or (get thing 'end-op)
		   (lambda () (forward-thing thing 1))))
	      (let ((end (point))
		    (real-beg
		     (progn
		       (funcall
			(or (get thing 'beginning-op)
			    (lambda () (forward-thing thing -1))))
		       (point))))
		(if (and (<= real-beg orig) (<= orig end) (< real-beg end))
		    (cons real-beg end))))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
128 129

;;;###autoload
130
(defun thing-at-point (thing &optional no-properties)
131
  "Return the THING at point.
Chong Yidong's avatar
Chong Yidong committed
132 133 134
THING should be a symbol specifying a type of syntactic entity.
Possibilities include `symbol', `list', `sexp', `defun',
`filename', `url', `email', `word', `sentence', `whitespace',
135
`line', `number', and `page'.
136

137 138 139
When the optional argument NO-PROPERTIES is non-nil,
strip text properties from the return value.

140 141
See the file `thingatpt.el' for documentation on how to define
a symbol as a valid THING."
142 143 144 145 146 147 148 149 150
  (let ((text
         (if (get thing 'thing-at-point)
             (funcall (get thing 'thing-at-point))
           (let ((bounds (bounds-of-thing-at-point thing)))
             (when bounds
               (buffer-substring (car bounds) (cdr bounds)))))))
    (when (and text no-properties)
      (set-text-properties 0 (length text) nil text))
    text))
Richard M. Stallman's avatar
Richard M. Stallman committed
151

Erik Naggum's avatar
Erik Naggum committed
152
;; Go to beginning/end
Richard M. Stallman's avatar
Richard M. Stallman committed
153

154
(defun beginning-of-thing (thing)
Chong Yidong's avatar
Chong Yidong committed
155 156
  "Move point to the beginning of THING.
The bounds of THING are determined by `bounds-of-thing-at-point'."
157 158
  (let ((bounds (bounds-of-thing-at-point thing)))
    (or bounds (error "No %s here" thing))
Richard M. Stallman's avatar
Richard M. Stallman committed
159 160
    (goto-char (car bounds))))

161
(defun end-of-thing (thing)
Chong Yidong's avatar
Chong Yidong committed
162 163
  "Move point to the end of THING.
The bounds of THING are determined by `bounds-of-thing-at-point'."
164 165
  (let ((bounds (bounds-of-thing-at-point thing)))
    (or bounds (error "No %s here" thing))
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167
    (goto-char (cdr bounds))))

168
;;  Special cases
Richard M. Stallman's avatar
Richard M. Stallman committed
169

170
;;  Lines
171 172 173 174 175

;; bolp will be false when you click on the last line in the buffer
;; and it has no final newline.

(put 'line 'beginning-op
176
     (lambda () (if (bolp) (forward-line -1) (beginning-of-line))))
177

178
;;  Sexps
Richard M. Stallman's avatar
Richard M. Stallman committed
179 180

(defun in-string-p ()
Chong Yidong's avatar
Chong Yidong committed
181 182
  "Return non-nil if point is in a string.
\[This is an internal function.]"
183
  (declare (obsolete "use (nth 3 (syntax-ppss)) instead." "25.1"))
Richard M. Stallman's avatar
Richard M. Stallman committed
184 185 186 187 188 189
  (let ((orig (point)))
    (save-excursion
      (beginning-of-defun)
      (nth 3 (parse-partial-sexp (point) orig)))))

(defun end-of-sexp ()
Chong Yidong's avatar
Chong Yidong committed
190 191
  "Move point to the end of the current sexp.
\[This is an internal function.]"
192
  (let ((char-syntax (syntax-after (point))))
Richard M. Stallman's avatar
Richard M. Stallman committed
193
    (if (or (eq char-syntax ?\))
194
	    (and (eq char-syntax ?\") (nth 3 (syntax-ppss))))
Richard M. Stallman's avatar
Richard M. Stallman committed
195 196 197 198 199
	(forward-char 1)
      (forward-sexp 1))))

(put 'sexp 'end-op 'end-of-sexp)

200
(defun beginning-of-sexp ()
Chong Yidong's avatar
Chong Yidong committed
201 202
  "Move point to the beginning of the current sexp.
\[This is an internal function.]"
203
  (let ((char-syntax (char-syntax (char-before))))
204
    (if (or (eq char-syntax ?\()
205
	    (and (eq char-syntax ?\") (nth 3 (syntax-ppss))))
206 207 208 209 210
	(forward-char -1)
      (forward-sexp -1))))

(put 'sexp 'beginning-op 'beginning-of-sexp)

211
;;  Lists
Richard M. Stallman's avatar
Richard M. Stallman committed
212

213 214 215
(put 'list 'bounds-of-thing-at-point 'thing-at-point-bounds-of-list-at-point)

(defun thing-at-point-bounds-of-list-at-point ()
Chong Yidong's avatar
Chong Yidong committed
216 217
  "Return the bounds of the list at point.
\[Internal function used by `bounds-of-thing-at-point'.]"
218 219
  (save-excursion
    (let ((opoint (point))
220 221 222 223 224 225 226 227 228 229 230 231 232
	  (beg (ignore-errors
		 (up-list -1)
		 (point))))
      (ignore-errors
	(if beg
	    (progn (forward-sexp)
		   (cons beg (point)))
	  ;; Are we are at the beginning of a top-level sexp?
	  (forward-sexp)
	  (let ((end (point)))
	    (backward-sexp)
	    (if (>= opoint (point))
		(cons opoint end))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
233

234 235 236 237 238 239
;; Defuns

(put 'defun 'beginning-op 'beginning-of-defun)
(put 'defun 'end-op       'end-of-defun)
(put 'defun 'forward-op   'end-of-defun)

240
;;  Filenames
Richard M. Stallman's avatar
Richard M. Stallman committed
241

242
(defvar thing-at-point-file-name-chars "-~/[:alnum:]_.${}#%,:"
Richard M. Stallman's avatar
Richard M. Stallman committed
243 244
  "Characters allowable in filenames.")

245
(put 'filename 'end-op
246 247 248
     (lambda ()
       (re-search-forward (concat "\\=[" thing-at-point-file-name-chars "]*")
			  nil t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
249
(put 'filename 'beginning-op
250 251 252 253 254
     (lambda ()
       (if (re-search-backward (concat "[^" thing-at-point-file-name-chars "]")
			       nil t)
	   (forward-char)
	 (goto-char (point-min)))))
255

256 257 258 259 260 261
;;  URIs

(defvar thing-at-point-beginning-of-url-regexp nil
  "Regexp matching the beginning of a well-formed URI.
If nil, construct the regexp from `thing-at-point-uri-schemes'.")

262
(defvar thing-at-point-url-path-regexp
263
  "[^]\t\n \"'<>[^`{}]*[^]\t\n \"'<>[^`{}.,;]+"
264
  "Regexp matching the host and filename or e-mail part of a URL.")
265 266

(defvar thing-at-point-short-url-regexp
267
  (concat "[-A-Za-z0-9]+\\.[-A-Za-z0-9.]+" thing-at-point-url-path-regexp)
268
  "Regexp matching a URI without a scheme component.")
269

270
(defvar thing-at-point-uri-schemes
271
  ;; Officials from http://www.iana.org/assignments/uri-schemes.html
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
  '("aaa://" "about:" "acap://" "apt:" "bzr://" "bzr+ssh://"
    "attachment:/" "chrome://" "cid:" "content://" "crid://" "cvs://"
    "data:" "dav:" "dict://" "doi:" "dns:" "dtn:" "feed:" "file:/"
    "finger://" "fish://" "ftp://" "geo:" "git://" "go:" "gopher://"
    "h323:" "http://" "https://" "im:" "imap://" "info:" "ipp:"
    "irc://" "irc6://" "ircs://" "iris.beep:" "jar:" "ldap://"
    "ldaps://" "mailto:" "mid:"  "mtqp://" "mupdate://" "news:"
    "nfs://" "nntp://" "opaquelocktoken:" "pop://" "pres:"
    "resource://" "rmi://" "rsync://" "rtsp://" "rtspu://" "service:"
    "sftp://" "sip:" "sips:" "smb://" "sms:" "snmp://" "soap.beep://"
    "soap.beeps://" "ssh://" "svn://" "svn+ssh://" "tag:" "tel:"
    "telnet://" "tftp://" "tip://" "tn3270://" "udp://" "urn:"
    "uuid:" "vemmi://"  "webcal://" "xri://" "xmlrpc.beep://"
    "xmlrpc.beeps://" "z39.50r://" "z39.50s://" "xmpp:"
    ;; Compatibility
    "fax:" "mms://" "mmsh://" "modem:" "prospero:" "snews:"
    "wais://")
  "List of URI schemes recognized by `thing-at-point-url-at-point'.
Each string in this list should correspond to the start of a
URI's scheme component, up to and including the trailing // if
the scheme calls for that to be present.")

(defvar thing-at-point-markedup-url-regexp "<URL:\\([^<>\n]+\\)>"
  "Regexp matching a URL marked up per RFC1738.
This kind of markup was formerly recommended as a way to indicate
URIs, but as of RFC 3986 it is no longer recommended.
Subexpression 1 should contain the delimited URL.")

(defvar thing-at-point-newsgroup-regexp
  "\\`[[:lower:]]+\\.[-+[:lower:]_0-9.]+\\'"
  "Regexp matching a newsgroup name.")

(defvar thing-at-point-newsgroup-heads
  '("alt" "comp" "gnu" "misc" "news" "sci" "soc" "talk")
  "Used by `thing-at-point-newsgroup-p' if gnus is not running.")

(defvar thing-at-point-default-mail-uri-scheme "mailto"
  "Default scheme for ill-formed URIs that look like <foo@example.com>.
If nil, do not give such URIs a scheme.")
311 312

(put 'url 'bounds-of-thing-at-point 'thing-at-point-bounds-of-url-at-point)
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358

(defun thing-at-point-bounds-of-url-at-point (&optional lax)
  "Return a cons cell containing the start and end of the URI at point.
Try to find a URI using `thing-at-point-markedup-url-regexp'.
If that fails, try with `thing-at-point-beginning-of-url-regexp'.
If that also fails, and optional argument LAX is non-nil, return
the bounds of a possible ill-formed URI (one lacking a scheme)."
  ;; Look for the old <URL:foo> markup.  If found, use it.
  (or (thing-at-point--bounds-of-markedup-url)
      ;; Otherwise, find the bounds within which a URI may exist.  The
      ;; method is similar to `ffap-string-at-point'.  Note that URIs
      ;; may contain parentheses but may not contain spaces (RFC3986).
      (let* ((allowed-chars "--:=&?$+@-Z_[:alpha:]~#,%;*()!'")
	     (skip-before "^[0-9a-zA-Z]")
	     (skip-after  ":;.,!?")
	     (pt (point))
	     (beg (save-excursion
		    (skip-chars-backward allowed-chars)
		    (skip-chars-forward skip-before pt)
		    (point)))
	     (end (save-excursion
		    (skip-chars-forward allowed-chars)
		    (skip-chars-backward skip-after pt)
		    (point))))
	(or (thing-at-point--bounds-of-well-formed-url beg end pt)
	    (if lax (cons beg end))))))

(defun thing-at-point--bounds-of-markedup-url ()
  (when thing-at-point-markedup-url-regexp
    (let ((case-fold-search t)
	  (pt (point))
	  (beg (line-beginning-position))
	  (end (line-end-position))
	  found)
      (save-excursion
	(goto-char beg)
	(while (and (not found)
		    (<= (point) pt)
		    (< (point) end))
	  (and (re-search-forward thing-at-point-markedup-url-regexp
				  end 1)
	       (> (point) pt)
	       (setq found t))))
      (if found
	  (cons (match-beginning 1) (match-end 1))))))

359
(defun thing-at-point--bounds-of-well-formed-url (beg end _pt)
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
  (save-excursion
    (goto-char beg)
    (let (url-beg paren-end regexp)
      (save-restriction
	(narrow-to-region beg end)
	;; The scheme component must either match at BEG, or have no
	;; other alphanumerical ASCII characters before it.
	(setq regexp (concat "\\(?:\\`\\|[^a-zA-Z0-9]\\)\\("
			     (or thing-at-point-beginning-of-url-regexp
				 (regexp-opt thing-at-point-uri-schemes))
			     "\\)"))
	(and (re-search-forward regexp end t)
	     ;; URI must have non-empty contents.
	     (< (point) end)
	     (setq url-beg (match-beginning 1))))
      (when url-beg
	;; If there is an open paren before the URI, truncate to the
	;; matching close paren.
	(and (> url-beg (point-min))
	     (eq (car-safe (syntax-after (1- url-beg))) 4)
	     (save-restriction
	       (narrow-to-region (1- url-beg) (min end (point-max)))
	       (setq paren-end (ignore-errors
				 (scan-lists (1- url-beg) 1 0))))
	     (not (blink-matching-check-mismatch (1- url-beg) paren-end))
	     (setq end (1- paren-end)))
	(cons url-beg end)))))
387 388

(put 'url 'thing-at-point 'thing-at-point-url-at-point)
389

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
(defun thing-at-point-url-at-point (&optional lax bounds)
  "Return the URL around or before point.
If no URL is found, return nil.

If optional argument LAX is non-nil, look for URLs that are not
well-formed, such as foo@bar or <nobody>.

If optional arguments BOUNDS are non-nil, it should be a cons
cell of the form (START . END), containing the beginning and end
positions of the URI.  Otherwise, these positions are detected
automatically from the text around point.

If the scheme component is absent, either because a URI delimited
with <url:...> lacks one, or because an ill-formed URI was found
with LAX or BEG and END, try to add a scheme in the returned URI.
The scheme is chosen heuristically: \"mailto:\" if the address
looks like an email address, \"ftp://\" if it starts with
\"ftp\", etc."
  (unless bounds
    (setq bounds (thing-at-point-bounds-of-url-at-point lax)))
  (when (and bounds (< (car bounds) (cdr bounds)))
    (let ((str (buffer-substring-no-properties (car bounds) (cdr bounds))))
      ;; If there is no scheme component, try to add one.
      (unless (string-match "\\`[a-zA-Z][-a-zA-Z0-9+.]*:" str)
	(or
	 ;; If the URI has the form <foo@bar>, treat it according to
	 ;; `thing-at-point-default-mail-uri-scheme'.  If there are
	 ;; no angle brackets, it must be mailto.
	 (when (string-match "\\`[^:</>@]+@[-.0-9=&?$+A-Z_a-z~#,%;*]" str)
	   (let ((scheme (if (and (eq (char-before (car bounds)) ?<)
				  (eq (char-after  (cdr bounds)) ?>))
			     thing-at-point-default-mail-uri-scheme
			   "mailto")))
	     (if scheme
		 (setq str (concat scheme ":" str)))))
	 ;; If the string is like <FOO>, where FOO is an existing user
	 ;; name on the system, treat that as an email address.
	 (and (string-match "\\`[[:alnum:]]+\\'" str)
	      (eq (char-before (car bounds)) ?<)
	      (eq (char-after  (cdr bounds)) ?>)
	      (not (string-match "~" (expand-file-name (concat "~" str))))
	      (setq str (concat "mailto:" str)))
	 ;; If it looks like news.example.com, treat it as news.
	 (if (thing-at-point-newsgroup-p str)
	     (setq str (concat "news:" str)))
	 ;; If it looks like ftp.example.com. treat it as ftp.
	 (if (string-match "\\`ftp\\." str)
	     (setq str (concat "ftp://" str)))
	 ;; If it looks like www.example.com. treat it as http.
	 (if (string-match "\\`www\\." str)
	     (setq str (concat "http://" str)))
	 ;; Otherwise, it just isn't a URI.
	 (setq str nil)))
      str)))

(defun thing-at-point-newsgroup-p (string)
  "Return STRING if it looks like a newsgroup name, else nil."
  (and
   (string-match thing-at-point-newsgroup-regexp string)
   (let ((htbs '(gnus-active-hashtb gnus-newsrc-hashtb gnus-killed-hashtb))
	 (heads thing-at-point-newsgroup-heads)
	 htb ret)
     (while htbs
       (setq htb (car htbs) htbs (cdr htbs))
454 455 456 457 458 459 460 461
       (ignore-errors
	 ;; errs: htb symbol may be unbound, or not a hash-table.
	 ;; gnus-gethash is just a macro for intern-soft.
	 (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)))
462 463 464 465 466 467 468 469 470 471
     (or ret (not heads)
	 (let ((head (string-match "\\`\\([[:lower:]]+\\)\\." string)))
	   (and head (setq head (substring string 0 (match-end 1)))
		(member head heads)
		(setq ret string))))
     ret)))

(put 'url 'end-op (lambda () (end-of-thing 'url)))

(put 'url 'beginning-op (lambda () (end-of-thing 'url)))
472 473 474 475 476 477 478 479

;; The normal thingatpt mechanism doesn't work for complex regexps.
;; This should work for almost any regexp wherever we are in the
;; match.  To do a perfect job for any arbitrary regexp would mean
;; testing every position before point.  Regexp searches won't find
;; matches that straddle the start position so we search forwards once
;; and then back repeatedly and then back up a char at a time.

480
(defun thing-at-point-looking-at (regexp &optional distance)
481 482 483 484
  "Return non-nil if point is in or just after a match for REGEXP.
Set the match data from the earliest such match ending at or after
point."
  (save-excursion
485 486 487 488
    (let ((old-point (point))
	  (forward-bound (and distance (+ (point) distance)))
	  (backward-bound (and distance (- (point) distance)))
	  match)
489 490 491 492 493
      (and (looking-at regexp)
	   (>= (match-end 0) old-point)
	   (setq match (point)))
      ;; Search back repeatedly from end of next match.
      ;; This may fail if next match ends before this match does.
494 495
      (re-search-forward regexp forward-bound 'limit)
      (while (and (re-search-backward regexp backward-bound t)
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
		  (or (> (match-beginning 0) old-point)
		      (and (looking-at regexp)	; Extend match-end past search start
			   (>= (match-end 0) old-point)
			   (setq match (point))))))
      (if (not match) nil
	(goto-char match)
	;; Back up a char at a time in case search skipped
	;; intermediate match straddling search start pos.
	(while (and (not (bobp))
		    (progn (backward-char 1) (looking-at regexp))
		    (>= (match-end 0) old-point)
		    (setq match (point))))
	(goto-char match)
	(looking-at regexp)))))

511 512
;;   Email addresses
(defvar thing-at-point-email-regexp
513
  "<?[-+_.~a-zA-Z][-+_.~:a-zA-Z0-9]*@[-.a-zA-Z0-9]+>?"
514 515 516 517 518 519 520 521 522 523 524
  "A regular expression probably matching an email address.
This does not match the real name portion, only the address, optionally
with angle brackets.")

;; Haven't set 'forward-op on 'email nor defined 'forward-email' because
;; not sure they're actually needed, and URL seems to skip them too.
;; Note that (end-of-thing 'email) and (beginning-of-thing 'email)
;; work automagically, though.

(put 'email 'bounds-of-thing-at-point
     (lambda ()
525 526
       (let ((thing (thing-at-point-looking-at
		     thing-at-point-email-regexp 500)))
527 528 529 530 531 532 533 534 535 536 537 538
         (if thing
             (let ((beginning (match-beginning 0))
                   (end (match-end 0)))
               (cons beginning end))))))

(put 'email 'thing-at-point
     (lambda ()
       (let ((boundary-pair (bounds-of-thing-at-point 'email)))
         (if boundary-pair
             (buffer-substring-no-properties
              (car boundary-pair) (cdr boundary-pair))))))

539
;;  Buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
540

541 542
(put 'buffer 'end-op (lambda () (goto-char (point-max))))
(put 'buffer 'beginning-op (lambda () (goto-char (point-min))))
Richard M. Stallman's avatar
Richard M. Stallman committed
543

544
;;  Aliases
Richard M. Stallman's avatar
Richard M. Stallman committed
545

Chong Yidong's avatar
Chong Yidong committed
546 547 548 549 550 551 552
(defun word-at-point ()
  "Return the word at point.  See `thing-at-point'."
  (thing-at-point 'word))

(defun sentence-at-point ()
  "Return the sentence at point.  See `thing-at-point'."
  (thing-at-point 'sentence))
Richard M. Stallman's avatar
Richard M. Stallman committed
553

554
(defun read-from-whole-string (str)
555
  "Read a Lisp expression from STR.
556 557
Signal an error if the entire string was not used."
  (let* ((read-data (read-from-string str))
558
	 (more-left
Richard M. Stallman's avatar
Richard M. Stallman committed
559
	  (condition-case nil
Richard M. Stallman's avatar
Richard M. Stallman committed
560
	      ;; The call to `ignore' suppresses a compiler warning.
561
	      (progn (ignore (read-from-string (substring str (cdr read-data))))
Richard M. Stallman's avatar
Richard M. Stallman committed
562 563 564 565 566 567
		     t)
	    (end-of-file nil))))
    (if more-left
	(error "Can't read whole string")
      (car read-data))))

568
(defun form-at-point (&optional thing pred)
569 570
  (let ((sexp (ignore-errors
		(read-from-whole-string (thing-at-point (or thing 'sexp))))))
571
    (if (or (not pred) (funcall pred sexp)) sexp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
572

Dave Love's avatar
Dave Love committed
573
;;;###autoload
574 575 576
(defun sexp-at-point ()
  "Return the sexp at point, or nil if none is found."
  (form-at-point 'sexp))
Dave Love's avatar
Dave Love committed
577
;;;###autoload
578
(defun symbol-at-point ()
579
  "Return the symbol at point, or nil if none is found."
580 581
  (let ((thing (thing-at-point 'symbol)))
    (if thing (intern thing))))
Dave Love's avatar
Dave Love committed
582
;;;###autoload
583 584 585
(defun number-at-point ()
  "Return the number at point, or nil if none is found."
  (form-at-point 'sexp 'numberp))
586
(put 'number 'thing-at-point 'number-at-point)
Dave Love's avatar
Dave Love committed
587
;;;###autoload
588 589 590
(defun list-at-point ()
  "Return the Lisp list at point, or nil if none is found."
  (form-at-point 'list 'listp))
Richard M. Stallman's avatar
Richard M. Stallman committed
591

592
;;; thingatpt.el ends here