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

3
;; Copyright (C) 1991,92,93,94,95,1996 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5

;; Author: Mike Williams <mikew@gopher.dosli.govt.nz>
Richard M. Stallman's avatar
Richard M. Stallman committed
6
;; Keywords: extensions, matching, mouse
Richard M. Stallman's avatar
Richard M. Stallman committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20
;; 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
21
;;; Commentary:
Erik Naggum's avatar
Erik Naggum committed
22

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

(provide 'thingatpt)

Erik Naggum's avatar
Erik Naggum committed
50
;; Basic movement
Richard M. Stallman's avatar
Richard M. Stallman committed
51 52

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

Erik Naggum's avatar
Erik Naggum committed
61
;; General routines
Richard M. Stallman's avatar
Richard M. Stallman committed
62 63

;;;###autoload
64 65 66 67 68 69 70 71 72 73 74
(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."
Richard M. Stallman's avatar
Richard M. Stallman committed
75 76 77
  (let ((orig (point)))
    (condition-case nil
	(save-excursion
78
	  ;; Try moving forward, then back.
Richard M. Stallman's avatar
Richard M. Stallman committed
79 80
	  (let ((end (progn 
		       (funcall 
81 82
			(or (get thing 'end-op) 
			    (function (lambda () (forward-thing thing 1)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
83 84 85
		       (point)))
		(beg (progn 
		       (funcall 
86 87
			(or (get thing 'beginning-op) 
			    (function (lambda () (forward-thing thing -1)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
88
		       (point))))
89 90 91 92 93 94 95 96 97 98 99 100 101 102
	    (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
		       (progn 
			 (funcall 
			  (or (get thing 'end-op) 
			      (function (lambda () (forward-thing thing 1)))))
			 (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,
103 104 105 106 107 108 109 110 111 112
	      ;; so that we can find a thing that ends at ORIG.
	      (let ((beg (progn 
			   (funcall 
			    (or (get thing 'beginning-op) 
				(function (lambda () (forward-thing thing -1)))))
			   (point)))
		    (end (progn 
			   (funcall 
			    (or (get thing 'end-op) 
				(function (lambda () (forward-thing thing 1)))))
113 114 115 116 117 118 119 120 121
			   (point)))
		    (real-beg
		     (progn 
		       (funcall 
			(or (get thing 'end-op) 
			    (function (lambda () (forward-thing thing -1)))))
		       (point))))
		(if (and real-beg end (<= real-beg orig) (<= orig end))
		    (cons real-beg end))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
122 123 124
      (error nil))))

;;;###autoload
125 126 127 128 129 130 131 132 133
(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."
  (let ((bounds (bounds-of-thing-at-point thing)))
Richard M. Stallman's avatar
Richard M. Stallman committed
134 135 136
    (if bounds 
	(buffer-substring (car bounds) (cdr bounds)))))

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

139 140 141
(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
142 143
    (goto-char (car bounds))))

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

Erik Naggum's avatar
Erik Naggum committed
149
;;  Special cases 
Richard M. Stallman's avatar
Richard M. Stallman committed
150

Erik Naggum's avatar
Erik Naggum committed
151
;;  Lines 
152 153 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
     (function (lambda () (if (bolp) (forward-line -1) (beginning-of-line)))))

Erik Naggum's avatar
Erik Naggum committed
159
;;  Sexps 
Richard M. Stallman's avatar
Richard M. Stallman committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175

(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)

Erik Naggum's avatar
Erik Naggum committed
176
;;  Lists 
Richard M. Stallman's avatar
Richard M. Stallman committed
177 178 179 180

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

181
;;  Filenames and URLs
Richard M. Stallman's avatar
Richard M. Stallman committed
182

183
(defvar thing-at-point-file-name-chars "~/A-Za-z0-9---_.${}#%,:"
Richard M. Stallman's avatar
Richard M. Stallman committed
184 185 186
  "Characters allowable in filenames.")

(put 'filename 'end-op    
187
     '(lambda () (skip-chars-forward thing-at-point-file-name-chars)))
Richard M. Stallman's avatar
Richard M. Stallman committed
188
(put 'filename 'beginning-op
189 190
     '(lambda () (skip-chars-backward thing-at-point-file-name-chars)))

191
(defvar thing-at-point-url-chars "~/A-Za-z0-9---_@$%&=.,"
192 193 194
  "Characters allowable in a URL.")

(put 'url 'end-op    
195 196
     '(lambda () (skip-chars-forward (concat ":" thing-at-point-url-chars))
	(skip-chars-backward ".,:")))
197 198 199 200 201 202 203
(put 'url 'beginning-op
     '(lambda ()
	(skip-chars-backward thing-at-point-url-chars)
	(or (= (preceding-char) ?:)
	    (error "No URL here"))
	(forward-char -1)
	(skip-chars-backward "a-zA-Z")))
Richard M. Stallman's avatar
Richard M. Stallman committed
204

Erik Naggum's avatar
Erik Naggum committed
205
;;  Whitespace 
Richard M. Stallman's avatar
Richard M. Stallman committed
206

207
(defun forward-whitespace (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
208
  (interactive "p")
209
  (if (natnump arg) 
210
      (re-search-forward "[ \t]+\\|\n" nil 'move arg)
211
    (while (< arg 0)
212
      (if (re-search-backward "[ \t]+\\|\n" nil 'move)
Richard M. Stallman's avatar
Richard M. Stallman committed
213 214
	  (or (eq (char-after (match-beginning 0)) 10)
	      (skip-chars-backward " \t")))
215
      (setq arg (1+ arg)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
216

Erik Naggum's avatar
Erik Naggum committed
217
;;  Buffer 
Richard M. Stallman's avatar
Richard M. Stallman committed
218 219 220 221

(put 'buffer 'end-op 'end-of-buffer)
(put 'buffer 'beginning-op 'beginning-of-buffer)

Erik Naggum's avatar
Erik Naggum committed
222
;;  Symbols 
Richard M. Stallman's avatar
Richard M. Stallman committed
223

224
(defun forward-symbol (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
225
  (interactive "p")
226
  (if (natnump arg) 
227
      (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
228
    (while (< arg 0)
229
      (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
Richard M. Stallman's avatar
Richard M. Stallman committed
230
	  (skip-syntax-backward "w_"))
231
      (setq arg (1+ arg)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
232

Erik Naggum's avatar
Erik Naggum committed
233
;;  Syntax blocks 
234 235 236 237 238 239 240 241 242 243 244

(defun forward-same-syntax (&optional arg)
  (interactive "p")
  (while (< arg 0)
    (skip-syntax-backward 
     (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))))

Erik Naggum's avatar
Erik Naggum committed
245
;;  Aliases 
Richard M. Stallman's avatar
Richard M. Stallman committed
246 247 248 249

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

250 251 252 253
(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))
Richard M. Stallman's avatar
Richard M. Stallman committed
254 255
	 (more-left 
	  (condition-case nil
256
	      (progn (read-from-string (substring str (cdr read-data)))
Richard M. Stallman's avatar
Richard M. Stallman committed
257 258 259 260 261 262
		     t)
	    (end-of-file nil))))
    (if more-left
	(error "Can't read whole string")
      (car read-data))))

263
(defun form-at-point (&optional thing pred) 
Richard M. Stallman's avatar
Richard M. Stallman committed
264
  (let ((sexp (condition-case nil 
265
		  (read-from-whole-string (thing-at-point (or thing 'sexp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
266
		(error nil))))
267
    (if (or (not pred) (funcall pred sexp)) sexp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
268 269 270 271 272 273 274

(defun sexp-at-point ()   (form-at-point 'sexp))
(defun symbol-at-point () (form-at-point 'sexp 'symbolp))
(defun number-at-point () (form-at-point 'sexp 'numberp))
(defun list-at-point ()   (form-at-point 'list 'listp))

;; thingatpt.el ends here.