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

3
;; Copyright (C) 1991-1998, 2000-2011  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: FSF
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)
58
  "Move forward to the end of the Nth next THING."
59 60
  (let ((forward-op (or (get thing 'forward-op)
			(intern-soft (format "forward-%s" thing)))))
61
    (if (functionp forward-op)
62 63
	(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
64

Erik Naggum's avatar
Erik Naggum committed
65
;; General routines
Richard M. Stallman's avatar
Richard M. Stallman committed
66 67

;;;###autoload
68 69 70 71
(defun bounds-of-thing-at-point (thing)
  "Determine the start and end buffer locations for the THING at point.
THING is a symbol which specifies the kind of syntactic entity you want.
Possibilities include `symbol', `list', `sexp', `defun', `filename', `url',
72
`email', `word', `sentence', `whitespace', `line', `page' and others.
73 74 75 76 77 78

See the file `thingatpt.el' for documentation on how to define
a symbol as a valid THING.

The value is a cons cell (START . END) giving the start and end positions
of the textual entity that was found."
79 80 81 82 83 84
  (if (get thing 'bounds-of-thing-at-point)
      (funcall (get thing 'bounds-of-thing-at-point))
    (let ((orig (point)))
      (condition-case nil
	  (save-excursion
	    ;; Try moving forward, then back.
85 86 87 88 89 90 91
            (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)))
92 93 94 95 96
	      (if (not (and beg (> 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.
		  (let ((real-end
97 98 99
			 (progn
			   (funcall
			    (or (get thing 'end-op)
100
                                (lambda () (forward-thing thing 1))))
101 102 103 104 105 106
			   (point))))
		    (if (and beg real-end (<= beg orig) (<= orig 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.
107 108 109 110 111 112 113 114
                (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
115 116 117
		       (progn
			 (funcall
			  (or (get thing 'beginning-op)
118
                              (lambda () (forward-thing thing -1))))
119 120 121 122
			 (point))))
		  (if (and real-beg end (<= real-beg orig) (<= orig end))
		      (cons real-beg end))))))
	(error nil)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
123 124

;;;###autoload
125 126 127 128
(defun thing-at-point (thing)
  "Return the THING at point.
THING is a symbol which specifies the kind of syntactic entity you want.
Possibilities include `symbol', `list', `sexp', `defun', `filename', `url',
129
`email', `word', `sentence', `whitespace', `line', `page' and others.
130 131 132

See the file `thingatpt.el' for documentation on how to define
a symbol as a valid THING."
133 134 135
  (if (get thing 'thing-at-point)
      (funcall (get thing 'thing-at-point))
    (let ((bounds (bounds-of-thing-at-point thing)))
136
      (if bounds
137
	  (buffer-substring (car bounds) (cdr bounds))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
138

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

141 142 143
(defun beginning-of-thing (thing)
  (let ((bounds (bounds-of-thing-at-point thing)))
    (or bounds (error "No %s here" thing))
Richard M. Stallman's avatar
Richard M. Stallman committed
144 145
    (goto-char (car bounds))))

146 147 148
(defun end-of-thing (thing)
  (let ((bounds (bounds-of-thing-at-point thing)))
    (or bounds (error "No %s here" thing))
Richard M. Stallman's avatar
Richard M. Stallman committed
149 150
    (goto-char (cdr bounds))))

151
;;  Special cases
Richard M. Stallman's avatar
Richard M. Stallman committed
152

153
;;  Lines
154 155 156 157 158

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

(put 'line 'beginning-op
159
     (lambda () (if (bolp) (forward-line -1) (beginning-of-line))))
160

161
;;  Sexps
Richard M. Stallman's avatar
Richard M. Stallman committed
162 163 164 165 166 167 168 169

(defun in-string-p ()
  (let ((orig (point)))
    (save-excursion
      (beginning-of-defun)
      (nth 3 (parse-partial-sexp (point) orig)))))

(defun end-of-sexp ()
170
  (let ((char-syntax (char-syntax (char-after))))
Richard M. Stallman's avatar
Richard M. Stallman committed
171 172 173 174 175 176 177
    (if (or (eq char-syntax ?\))
	    (and (eq char-syntax ?\") (in-string-p)))
	(forward-char 1)
      (forward-sexp 1))))

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

178
(defun beginning-of-sexp ()
179
  (let ((char-syntax (char-syntax (char-before))))
180 181 182 183 184 185 186
    (if (or (eq char-syntax ?\()
	    (and (eq char-syntax ?\") (in-string-p)))
	(forward-char -1)
      (forward-sexp -1))))

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

187
;;  Lists
Richard M. Stallman's avatar
Richard M. Stallman committed
188

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
(put 'list 'bounds-of-thing-at-point 'thing-at-point-bounds-of-list-at-point)

(defun thing-at-point-bounds-of-list-at-point ()
  (save-excursion
    (let ((opoint (point))
	  (beg (condition-case nil
		   (progn (up-list -1)
			  (point))
		 (error nil))))
      (condition-case nil
	  (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))))
	(error nil)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
209

210 211 212 213 214 215
;; Defuns

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

216
;;  Filenames and URLs  www.com/foo%32bar
Richard M. Stallman's avatar
Richard M. Stallman committed
217

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

221
(put 'filename 'end-op
222 223 224
     (lambda ()
       (re-search-forward (concat "\\=[" thing-at-point-file-name-chars "]*")
			  nil t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
225
(put 'filename 'beginning-op
226 227 228 229 230
     (lambda ()
       (if (re-search-backward (concat "[^" thing-at-point-file-name-chars "]")
			       nil t)
	   (forward-char)
	 (goto-char (point-min)))))
231

232
(defvar thing-at-point-url-path-regexp
233
  "[^]\t\n \"'<>[^`{}]*[^]\t\n \"'<>[^`{}.,;]+"
234
  "A regular expression probably matching the host and filename or e-mail part of a URL.")
235 236 237 238 239 240 241

(defvar thing-at-point-short-url-regexp
  (concat "[-A-Za-z0-9.]+" thing-at-point-url-path-regexp)
  "A regular expression probably matching a URL without an access scheme.
Hostname matching is stricter in this case than for
``thing-at-point-url-regexp''.")

242
(defvar thing-at-point-uri-schemes
243
  ;; Officials from http://www.iana.org/assignments/uri-schemes.html
244 245 246 247 248 249
  '("ftp://" "http://" "gopher://" "mailto:" "news:" "nntp:"
    "telnet://" "wais://" "file:/" "prospero:" "z39.50s:" "z39.50r:"
    "cid:" "mid:" "vemmi:" "service:" "imap:" "nfs:" "acap:" "rtsp:"
    "tip:" "pop:" "data:" "dav:" "opaquelocktoken:" "sip:" "tel:" "fax:"
    "modem:" "ldap:" "https://" "soap.beep:" "soap.beeps:" "urn:" "go:"
    "afs:" "tn3270:" "mailserver:"
250 251 252
    "crid:" "dict:" "dns:" "dtn:" "h323:" "im:" "info:" "ipp:"
    "iris.beep:" "mtqp:" "mupdate:" "pres:" "sips:" "snmp:" "tag:"
    "tftp:" "xmlrpc.beep:" "xmlrpc.beeps:" "xmpp:"
253
  ;; Compatibility
254
    "snews:" "irc:" "mms://" "mmsh://")
255
  "Uniform Resource Identifier (URI) Schemes.")
256

257
(defvar thing-at-point-url-regexp
258 259
  (concat "\\<\\(" (mapconcat 'identity thing-at-point-uri-schemes "\\|") "\\)"
          thing-at-point-url-path-regexp)
260 261 262 263 264 265 266 267 268
  "A regular expression probably matching a complete URL.")

(defvar thing-at-point-markedup-url-regexp
  "<URL:[^>]+>"
  "A regular expression matching a URL marked up per RFC1738.
This may contain whitespace (including newlines) .")

(put 'url 'bounds-of-thing-at-point 'thing-at-point-bounds-of-url-at-point)
(defun thing-at-point-bounds-of-url-at-point ()
269 270 271
  (let ((strip (thing-at-point-looking-at
			 thing-at-point-markedup-url-regexp))) ;; (url "") short
    (if (or strip
272
	    (thing-at-point-looking-at thing-at-point-url-regexp)
273
	    ;; Access scheme omitted?
274 275 276
	    ;; (setq short (thing-at-point-looking-at
	    ;;     	 thing-at-point-short-url-regexp))
            )
277 278
	(let ((beginning (match-beginning 0))
	      (end (match-end 0)))
279 280 281
	  (when strip
            (setq beginning (+ beginning 5))
            (setq end (- end 1)))
282 283 284 285 286
	  (cons beginning end)))))

(put 'url 'thing-at-point 'thing-at-point-url-at-point)
(defun thing-at-point-url-at-point ()
  "Return the URL around or before point.
287 288 289 290 291 292

Search backwards for the start of a URL ending at or after point.  If
no URL found, return nil.  The access scheme will be prepended if
absent: \"mailto:\" if the string contains \"@\", \"ftp://\" if it
starts with \"ftp\" and not \"ftp:/\", or \"http://\" by default."

293 294 295 296 297 298 299 300 301 302 303 304
  (let ((url "") short strip)
    (if (or (setq strip (thing-at-point-looking-at
			 thing-at-point-markedup-url-regexp))
	    (thing-at-point-looking-at thing-at-point-url-regexp)
	    ;; Access scheme omitted?
	    (setq short (thing-at-point-looking-at
			 thing-at-point-short-url-regexp)))
	(progn
	  (setq url (buffer-substring-no-properties (match-beginning 0)
						    (match-end 0)))
	  (and strip (setq url (substring url 5 -1))) ; Drop "<URL:" & ">"
	  ;; strip whitespace
305
	  (while (string-match "[ \t\n\r]+" url)
306
	    (setq url (replace-match "" t t url)))
307 308 309 310
	  (and short (setq url (concat (cond ((string-match "^[a-zA-Z]+:" url)
					       ;; already has a URL scheme.
					       "")
					     ((string-match "@" url)
311 312 313 314 315 316
                                              "mailto:")
					     ;; e.g. ftp.swiss... or ftp-swiss...
                                             ((string-match "^ftp" url)
                                              "ftp://")
                                             (t "http://"))
                                       url)))
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
	  (if (string-equal "" url)
	      nil
	    url)))))

;; 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.

(defun thing-at-point-looking-at (regexp)
  "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
    (let ((old-point (point)) match)
      (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.
      (re-search-forward regexp nil 'limit)
      (while (and (re-search-backward regexp nil t)
		  (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)))))

356
(put 'url 'end-op
357 358 359 360 361
     (lambda ()
       (let ((bounds (thing-at-point-bounds-of-url-at-point)))
         (if bounds
             (goto-char (cdr bounds))
           (error "No URL here")))))
362
(put 'url 'beginning-op
363 364 365 366 367
     (lambda ()
       (let ((bounds (thing-at-point-bounds-of-url-at-point)))
         (if bounds
             (goto-char (car bounds))
           (error "No URL here")))))
Richard M. Stallman's avatar
Richard M. Stallman committed
368

369 370
;;   Email addresses
(defvar thing-at-point-email-regexp
371
  "<?[-+_.~a-zA-Z][-+_.~:a-zA-Z0-9]*@[-.a-zA-Z0-9]+>?"
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
  "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 ()
       (let ((thing (thing-at-point-looking-at thing-at-point-email-regexp)))
         (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))))))

396
;;  Whitespace
Richard M. Stallman's avatar
Richard M. Stallman committed
397

398
(defun forward-whitespace (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
399
  (interactive "p")
400
  (if (natnump arg)
401
      (re-search-forward "[ \t]+\\|\n" nil 'move arg)
402
    (while (< arg 0)
403
      (if (re-search-backward "[ \t]+\\|\n" nil 'move)
Richard M. Stallman's avatar
Richard M. Stallman committed
404 405
	  (or (eq (char-after (match-beginning 0)) 10)
	      (skip-chars-backward " \t")))
406
      (setq arg (1+ arg)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
407

408
;;  Buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
409

410 411
(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
412

413
;;  Symbols
Richard M. Stallman's avatar
Richard M. Stallman committed
414

415
(defun forward-symbol (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
416
  (interactive "p")
417
  (if (natnump arg)
418
      (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
419
    (while (< arg 0)
420
      (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
Richard M. Stallman's avatar
Richard M. Stallman committed
421
	  (skip-syntax-backward "w_"))
422
      (setq arg (1+ arg)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
423

424
;;  Syntax blocks
425 426 427 428

(defun forward-same-syntax (&optional arg)
  (interactive "p")
  (while (< arg 0)
429
    (skip-syntax-backward
430
     (char-to-string (char-syntax (char-before))))
431 432
    (setq arg (1+ arg)))
  (while (> arg 0)
433
    (skip-syntax-forward (char-to-string (char-syntax (char-after))))
434 435
    (setq arg (1- arg))))

436
;;  Aliases
Richard M. Stallman's avatar
Richard M. Stallman committed
437 438 439 440

(defun word-at-point () (thing-at-point 'word))
(defun sentence-at-point () (thing-at-point 'sentence))

441
(defun read-from-whole-string (str)
442
  "Read a Lisp expression from STR.
443 444
Signal an error if the entire string was not used."
  (let* ((read-data (read-from-string str))
445
	 (more-left
Richard M. Stallman's avatar
Richard M. Stallman committed
446
	  (condition-case nil
Richard M. Stallman's avatar
Richard M. Stallman committed
447
	      ;; The call to `ignore' suppresses a compiler warning.
448
	      (progn (ignore (read-from-string (substring str (cdr read-data))))
Richard M. Stallman's avatar
Richard M. Stallman committed
449 450 451 452 453 454
		     t)
	    (end-of-file nil))))
    (if more-left
	(error "Can't read whole string")
      (car read-data))))

455 456
(defun form-at-point (&optional thing pred)
  (let ((sexp (condition-case nil
457
		  (read-from-whole-string (thing-at-point (or thing 'sexp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
458
		(error nil))))
459
    (if (or (not pred) (funcall pred sexp)) sexp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
460

Dave Love's avatar
Dave Love committed
461
;;;###autoload
462 463 464
(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
465
;;;###autoload
466
(defun symbol-at-point ()
467
  "Return the symbol at point, or nil if none is found."
468 469
  (let ((thing (thing-at-point 'symbol)))
    (if thing (intern thing))))
Dave Love's avatar
Dave Love committed
470
;;;###autoload
471 472 473
(defun number-at-point ()
  "Return the number at point, or nil if none is found."
  (form-at-point 'sexp 'numberp))
Dave Love's avatar
Dave Love committed
474
;;;###autoload
475 476 477
(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
478

479
;;; thingatpt.el ends here