thingatpt.el 14 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, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000
4
;;   2002, 2003, 2004, 2005, 2006 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 13 14 15 16 17 18 19 20 21 22
;; Created: Thu Mar 28 13:48:23 1991

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

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

Richard M. Stallman's avatar
Richard M. Stallman committed
23
;;; Commentary:
Erik Naggum's avatar
Erik Naggum committed
24

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

(provide 'thingatpt)

Erik Naggum's avatar
Erik Naggum committed
52
;; Basic movement
Richard M. Stallman's avatar
Richard M. Stallman committed
53 54

;;;###autoload
55
(defun forward-thing (thing &optional n)
Richard M. Stallman's avatar
Richard M. Stallman committed
56
  "Move forward to the end of the next THING."
57 58
  (let ((forward-op (or (get thing 'forward-op)
			(intern-soft (format "forward-%s" thing)))))
59
    (if (functionp forward-op)
60 61
	(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
62

Erik Naggum's avatar
Erik Naggum committed
63
;; General routines
Richard M. Stallman's avatar
Richard M. Stallman committed
64 65

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

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."
77 78 79 80 81 82
  (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.
83 84 85
	    (let ((end (progn
			 (funcall
			  (or (get thing 'end-op)
86
			      (function (lambda () (forward-thing thing 1)))))
87
			 (point)))
88 89 90
		  (beg (progn
			 (funcall
			  (or (get thing 'beginning-op)
91
			      (function (lambda () (forward-thing thing -1)))))
92
			 (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
				(function (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
		(let ((beg (progn
			     (funcall
			      (or (get thing 'beginning-op)
111 112
				  (function (lambda () (forward-thing thing -1)))))
			     (point)))
113 114 115
		      (end (progn
			     (funcall
			      (or (get thing 'end-op)
116 117 118
				  (function (lambda () (forward-thing thing 1)))))
			     (point)))
		      (real-beg
119 120 121
		       (progn
			 (funcall
			  (or (get thing 'beginning-op)
122 123 124 125 126
			      (function (lambda () (forward-thing thing -1)))))
			 (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
127 128

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

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

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

145 146 147
(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
148 149
    (goto-char (car bounds))))

150 151 152
(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
153 154
    (goto-char (cdr bounds))))

155
;;  Special cases
Richard M. Stallman's avatar
Richard M. Stallman committed
156

157
;;  Lines
158 159 160 161 162 163 164

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

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

165
;;  Sexps
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181

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

(defun end-of-sexp ()
  (let ((char-syntax (char-syntax (char-after (point)))))
    (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)

182 183 184 185 186 187 188 189 190
(defun beginning-of-sexp ()
  (let ((char-syntax (char-syntax (char-before (point)))))
    (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)

191
;;  Lists
Richard M. Stallman's avatar
Richard M. Stallman committed
192 193 194 195

(put 'list 'end-op (function (lambda () (up-list 1))))
(put 'list 'beginning-op 'backward-sexp)

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

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

201
(put 'filename 'end-op
202 203 204
     (lambda ()
       (re-search-forward (concat "\\=[" thing-at-point-file-name-chars "]*")
			  nil t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
205
(put 'filename 'beginning-op
206 207 208 209 210
     (lambda ()
       (if (re-search-backward (concat "[^" thing-at-point-file-name-chars "]")
			       nil t)
	   (forward-char)
	 (goto-char (point-min)))))
211

212 213
(defvar thing-at-point-url-path-regexp
  "[^]\t\n \"'()<>[^`{}]*[^]\t\n \"'()<>[^`{}.,;]+"
214
  "A regular expression probably matching the host and filename or e-mail part of a URL.")
215 216 217 218 219 220 221

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

222 223 224 225 226 227 228 229 230 231 232 233
(defvar thing-at-point-uri-schemes
  ;; Officials from http://www.iana.org/assignments/uri-schemes
  '("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:"
  ;; Compatibility
    "snews:")
  "Uniform Resource Identifier (URI) Schemes")

234
(defvar thing-at-point-url-regexp
235 236
  (concat "\\<\\(" (mapconcat 'identity thing-at-point-uri-schemes "\\|") "\\)"
          thing-at-point-url-path-regexp)
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
  "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 ()
  (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)))
	(let ((beginning (match-beginning 0))
	      (end (match-end 0)))
	  (cond (strip
		 (setq beginning (+ beginning 5))
		 (setq end (- end 1))))
	  (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.
263 264 265 266 267 268

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

269 270 271 272 273 274 275 276 277 278 279 280
  (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
281
	  (while (string-match "[ \t\n\r]+" url)
282
	    (setq url (replace-match "" t t url)))
283 284 285 286 287 288 289
	  (and short (setq url (concat (cond ((string-match "@" url)
                                              "mailto:")
					     ;; e.g. ftp.swiss... or ftp-swiss...
                                             ((string-match "^ftp" url)
                                              "ftp://")
                                             (t "http://"))
                                       url)))
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
	  (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)))))

329 330 331 332 333 334
(put 'url 'end-op
     (function (lambda ()
		 (let ((bounds (thing-at-point-bounds-of-url-at-point)))
		   (if bounds
		       (goto-char (cdr bounds))
		     (error "No URL here"))))))
335
(put 'url 'beginning-op
336 337 338 339 340
     (function (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
341

342
;;  Whitespace
Richard M. Stallman's avatar
Richard M. Stallman committed
343

344
(defun forward-whitespace (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
345
  (interactive "p")
346
  (if (natnump arg)
347
      (re-search-forward "[ \t]+\\|\n" nil 'move arg)
348
    (while (< arg 0)
349
      (if (re-search-backward "[ \t]+\\|\n" nil 'move)
Richard M. Stallman's avatar
Richard M. Stallman committed
350 351
	  (or (eq (char-after (match-beginning 0)) 10)
	      (skip-chars-backward " \t")))
352
      (setq arg (1+ arg)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
353

354
;;  Buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
355

356 357
(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
358

359
;;  Symbols
Richard M. Stallman's avatar
Richard M. Stallman committed
360

361
(defun forward-symbol (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
362
  (interactive "p")
363
  (if (natnump arg)
364
      (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
365
    (while (< arg 0)
366
      (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
Richard M. Stallman's avatar
Richard M. Stallman committed
367
	  (skip-syntax-backward "w_"))
368
      (setq arg (1+ arg)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
369

370
;;  Syntax blocks
371 372 373 374

(defun forward-same-syntax (&optional arg)
  (interactive "p")
  (while (< arg 0)
375
    (skip-syntax-backward
376 377 378 379 380 381
     (char-to-string (char-syntax (char-after (1- (point))))))
    (setq arg (1+ arg)))
  (while (> arg 0)
    (skip-syntax-forward (char-to-string (char-syntax (char-after (point)))))
    (setq arg (1- arg))))

382
;;  Aliases
Richard M. Stallman's avatar
Richard M. Stallman committed
383 384 385 386

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

387 388 389 390
(defun read-from-whole-string (str)
  "Read a lisp expression from STR.
Signal an error if the entire string was not used."
  (let* ((read-data (read-from-string str))
391
	 (more-left
Richard M. Stallman's avatar
Richard M. Stallman committed
392
	  (condition-case nil
Richard M. Stallman's avatar
Richard M. Stallman committed
393
	      ;; The call to `ignore' suppresses a compiler warning.
394
	      (progn (ignore (read-from-string (substring str (cdr read-data))))
Richard M. Stallman's avatar
Richard M. Stallman committed
395 396 397 398 399 400
		     t)
	    (end-of-file nil))))
    (if more-left
	(error "Can't read whole string")
      (car read-data))))

401 402
(defun form-at-point (&optional thing pred)
  (let ((sexp (condition-case nil
403
		  (read-from-whole-string (thing-at-point (or thing 'sexp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
404
		(error nil))))
405
    (if (or (not pred) (funcall pred sexp)) sexp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
406

Dave Love's avatar
Dave Love committed
407
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
408
(defun sexp-at-point ()   (form-at-point 'sexp))
Dave Love's avatar
Dave Love committed
409
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
410
(defun symbol-at-point () (form-at-point 'sexp 'symbolp))
Dave Love's avatar
Dave Love committed
411
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
412
(defun number-at-point () (form-at-point 'sexp 'numberp))
Dave Love's avatar
Dave Love committed
413
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
414 415
(defun list-at-point ()   (form-at-point 'list 'listp))

Miles Bader's avatar
Miles Bader committed
416
;;; arch-tag: bb65a163-dae2-4055-aedc-fe11f497f698
417
;;; thingatpt.el ends here