thingatpt.el 16.2 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
4
;;   Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6

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

;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
14
;; it under the terms of the GNU General Public License as published by
15 16
;; 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
17 18 19 20 21 22

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

23 24 25
;; 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
26
;;; Commentary:
Erik Naggum's avatar
Erik Naggum committed
27

28 29
;; 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
30
;; its beginning and end positions in the buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
31 32
;;
;; The function bounds-of-thing-at-point finds the beginning and end
33
;; positions by moving first forward to the end of the "thing", and then
Richard M. Stallman's avatar
Richard M. Stallman committed
34
;; backwards to the beginning.  By default, it uses the corresponding
35
;; forward-"thing" operator (eg. forward-word, forward-line).
Richard M. Stallman's avatar
Richard M. Stallman committed
36 37
;;
;; Special cases are allowed for using properties associated with the named
38
;; "thing":
Richard M. Stallman's avatar
Richard M. Stallman committed
39
;;
40
;;   forward-op		Function to call to skip forward over a "thing" (or
Richard M. Stallman's avatar
Richard M. Stallman committed
41
;;                      with a negative argument, backward).
42
;;
43 44
;;   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
45 46 47 48 49 50
;;
;; 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
51
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
52 53 54

(provide 'thingatpt)

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

;;;###autoload
58
(defun forward-thing (thing &optional n)
59
  "Move forward to the end of the Nth next THING."
60 61
  (let ((forward-op (or (get thing 'forward-op)
			(intern-soft (format "forward-%s" thing)))))
62
    (if (functionp forward-op)
63 64
	(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
65

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

;;;###autoload
69 70 71 72
(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',
73
`email', `word', `sentence', `whitespace', `line', `page' and others.
74 75 76 77 78 79

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."
80 81 82 83 84 85
  (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.
86 87 88 89 90 91 92
            (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)))
93 94 95 96 97
	      (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
98 99 100
			 (progn
			   (funcall
			    (or (get thing 'end-op)
101
                                (lambda () (forward-thing thing 1))))
102 103 104 105 106 107
			   (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.
108 109 110 111 112 113 114 115
                (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
116 117 118
		       (progn
			 (funcall
			  (or (get thing 'beginning-op)
119
                              (lambda () (forward-thing thing -1))))
120 121 122 123
			 (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
124 125

;;;###autoload
126 127 128 129
(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',
130
`email', `word', `sentence', `whitespace', `line', `page' and others.
131 132 133

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

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

142 143 144
(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
145 146
    (goto-char (car bounds))))

147 148 149
(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
150 151
    (goto-char (cdr bounds))))

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

154
;;  Lines
155 156 157 158 159

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

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

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

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

(defun end-of-sexp ()
171
  (let ((char-syntax (char-syntax (char-after))))
Richard M. Stallman's avatar
Richard M. Stallman committed
172 173 174 175 176 177 178
    (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)

179
(defun beginning-of-sexp ()
180
  (let ((char-syntax (char-syntax (char-before))))
181 182 183 184 185 186 187
    (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)

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

190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
(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
210

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

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

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

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

(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''.")

237
(defvar thing-at-point-uri-schemes
238
  ;; Officials from http://www.iana.org/assignments/uri-schemes.html
239 240 241 242 243 244
  '("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:"
245 246 247
    "crid:" "dict:" "dns:" "dtn:" "h323:" "im:" "info:" "ipp:"
    "iris.beep:" "mtqp:" "mupdate:" "pres:" "sips:" "snmp:" "tag:"
    "tftp:" "xmlrpc.beep:" "xmlrpc.beeps:" "xmpp:"
248
  ;; Compatibility
249
    "snews:" "irc:" "mms://" "mmsh://")
250
  "Uniform Resource Identifier (URI) Schemes.")
251

252
(defvar thing-at-point-url-regexp
253 254
  (concat "\\<\\(" (mapconcat 'identity thing-at-point-uri-schemes "\\|") "\\)"
          thing-at-point-url-path-regexp)
255 256 257 258 259 260 261 262 263
  "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 ()
264 265 266
  (let ((strip (thing-at-point-looking-at
			 thing-at-point-markedup-url-regexp))) ;; (url "") short
    (if (or strip
267
	    (thing-at-point-looking-at thing-at-point-url-regexp)
268
	    ;; Access scheme omitted?
269 270 271
	    ;; (setq short (thing-at-point-looking-at
	    ;;     	 thing-at-point-short-url-regexp))
            )
272 273
	(let ((beginning (match-beginning 0))
	      (end (match-end 0)))
274 275 276
	  (when strip
            (setq beginning (+ beginning 5))
            (setq end (- end 1)))
277 278 279 280 281
	  (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.
282 283 284 285 286 287

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

288 289 290 291 292 293 294 295 296 297 298 299
  (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
300
	  (while (string-match "[ \t\n\r]+" url)
301
	    (setq url (replace-match "" t t url)))
302 303 304 305
	  (and short (setq url (concat (cond ((string-match "^[a-zA-Z]+:" url)
					       ;; already has a URL scheme.
					       "")
					     ((string-match "@" url)
306 307 308 309 310 311
                                              "mailto:")
					     ;; e.g. ftp.swiss... or ftp-swiss...
                                             ((string-match "^ftp" url)
                                              "ftp://")
                                             (t "http://"))
                                       url)))
312 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
	  (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)))))

351
(put 'url 'end-op
352 353 354 355 356
     (lambda ()
       (let ((bounds (thing-at-point-bounds-of-url-at-point)))
         (if bounds
             (goto-char (cdr bounds))
           (error "No URL here")))))
357
(put 'url 'beginning-op
358 359 360 361 362
     (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
363

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

391
;;  Whitespace
Richard M. Stallman's avatar
Richard M. Stallman committed
392

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

403
;;  Buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
404

405 406
(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
407

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

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

419
;;  Syntax blocks
420 421 422 423

(defun forward-same-syntax (&optional arg)
  (interactive "p")
  (while (< arg 0)
424
    (skip-syntax-backward
425
     (char-to-string (char-syntax (char-before))))
426 427
    (setq arg (1+ arg)))
  (while (> arg 0)
428
    (skip-syntax-forward (char-to-string (char-syntax (char-after))))
429 430
    (setq arg (1- arg))))

431
;;  Aliases
Richard M. Stallman's avatar
Richard M. Stallman committed
432 433 434 435

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

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

450 451
(defun form-at-point (&optional thing pred)
  (let ((sexp (condition-case nil
452
		  (read-from-whole-string (thing-at-point (or thing 'sexp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
453
		(error nil))))
454
    (if (or (not pred) (funcall pred sexp)) sexp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
455

Dave Love's avatar
Dave Love committed
456
;;;###autoload
457 458 459
(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
460
;;;###autoload
461
(defun symbol-at-point ()
462
  "Return the symbol at point, or nil if none is found."
463 464
  (let ((thing (thing-at-point 'symbol)))
    (if thing (intern thing))))
Dave Love's avatar
Dave Love committed
465
;;;###autoload
466 467 468
(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
469
;;;###autoload
470 471 472
(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
473

474
;;; thingatpt.el ends here