Commit | Line | Data |
---|---|---|
2cd6a032 | 1 | ;;; find-func.el --- find the definition of the Emacs Lisp function near point |
fffee8be | 2 | |
d2922337 | 3 | ;; Copyright (C) 1997, 1999, 2001 Free Software Foundation, Inc. |
fffee8be DL |
4 | |
5 | ;; Author: Jens Petersen <petersen@kurims.kyoto-u.ac.jp> | |
6 | ;; Maintainer: petersen@kurims.kyoto-u.ac.jp | |
2cd6a032 | 7 | ;; Keywords: emacs-lisp, functions, variables |
fffee8be DL |
8 | ;; Created: 97/07/25 |
9 | ||
10 | ;; This file is part of GNU Emacs. | |
11 | ||
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
14 | ;; the Free Software Foundation; either version 2, or (at your option) | |
15 | ;; any later version. | |
16 | ||
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
24 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 | ;; Boston, MA 02111-1307, USA. | |
26 | ||
27 | ;;; Commentary: | |
28 | ;; | |
29 | ;; The funniest thing about this is that I can't imagine why a package | |
30 | ;; so obviously useful as this hasn't been written before!! | |
fffee8be | 31 | ;; ;;; find-func |
86f28125 RS |
32 | ;; (find-function-setup-keys) |
33 | ;; | |
34 | ;; or just: | |
35 | ;; | |
2cd6a032 | 36 | ;; (load "find-func") |
fffee8be | 37 | ;; |
86f28125 | 38 | ;; if you don't like the given keybindings and away you go! It does |
2cd6a032 RS |
39 | ;; pretty much what you would expect, putting the cursor at the |
40 | ;; definition of the function or variable at point. | |
fffee8be | 41 | ;; |
2cd6a032 | 42 | ;; The code started out from `describe-function', `describe-key' |
fffee8be DL |
43 | ;; ("help.el") and `fff-find-loaded-emacs-lisp-function' (Noah Friedman's |
44 | ;; "fff.el"). | |
45 | ||
e8af40ee | 46 | ;;; Code: |
fffee8be | 47 | |
2cd6a032 RS |
48 | (require 'loadhist) |
49 | ||
fffee8be | 50 | ;;; User variables: |
2cd6a032 | 51 | |
0b5bb3ec | 52 | (defgroup find-function nil |
2cd6a032 RS |
53 | "Finds the definition of the Emacs Lisp symbol near point." |
54 | ;; :prefix "find-function" | |
0b5bb3ec | 55 | :group 'lisp) |
fffee8be | 56 | |
2cd6a032 | 57 | (defcustom find-function-regexp |
d3d4fb62 RS |
58 | ;; Match things like (defun foo ...), (defmacro foo ...), |
59 | ;; (define-skeleton foo ...), (define-generic-mode 'foo ...), | |
d8f479c6 | 60 | ;; (define-derived-mode foo ...), (define-minor-mode foo) |
d3d4fb62 | 61 | "^\\s-*(\\(def\\(ine-skeleton\\|ine-generic-mode\\|ine-derived-mode\\|\ |
d2922337 GM |
62 | \[^cgv\W]\\w+\\*?\\)\\|define-minor-mode\ |
63 | \\|easy-mmode-define-global-mode\\)\\(\\s-\\|\n\\)+'?\ | |
848e8371 | 64 | %s\\(\\s-\\|$\\|\(\\|\)\\)" |
d3d4fb62 RS |
65 | "The regexp used by `find-function' to search for a function definition. |
66 | Note it must contain a `%s' at the place where `format' | |
2cd6a032 RS |
67 | should insert the function name. The default value avoids `defconst', |
68 | `defgroup', `defvar'. | |
fffee8be | 69 | |
2cd6a032 RS |
70 | Please send improvements and fixes to the maintainer." |
71 | :type 'regexp | |
86f28125 | 72 | :group 'find-function |
d8f479c6 | 73 | :version "21.1") |
2cd6a032 RS |
74 | |
75 | (defcustom find-variable-regexp | |
f35a7618 | 76 | "^\\s-*(def[^umag]\\(\\w\\|\\s_\\)+\\*?\\s-+%s\\(\\s-\\|$\\)" |
2cd6a032 RS |
77 | "The regexp used by `find-variable' to search for a variable definition. |
78 | It should match right up to the variable name. The default value | |
f35a7618 | 79 | avoids `defun', `defmacro', `defalias', `defadvice', `defgroup'. |
2cd6a032 RS |
80 | |
81 | Please send improvements and fixes to the maintainer." | |
82 | :type 'regexp | |
86f28125 | 83 | :group 'find-function |
a469e8ba | 84 | :version "21.1") |
fffee8be | 85 | |
0b5bb3ec | 86 | (defcustom find-function-source-path nil |
d3d4fb62 | 87 | "The default list of directories where `find-function' searches. |
fffee8be | 88 | |
d3d4fb62 | 89 | If this variable is nil then `find-function' searches `load-path' by |
0b5bb3ec SE |
90 | default." |
91 | :type '(repeat directory) | |
92 | :group 'find-function) | |
fffee8be | 93 | |
2cd6a032 RS |
94 | (defcustom find-function-recenter-line 1 |
95 | "The window line-number from which to start displaying a symbol definition. | |
96 | A value of nil implies center the beginning of the definition. | |
97 | See the function `center-to-window-line' for more information, and | |
98 | `find-function' and `find-variable'." | |
86f28125 | 99 | :group 'find-function |
a6223467 | 100 | :version "20.3") |
2cd6a032 RS |
101 | |
102 | (defcustom find-function-after-hook nil | |
103 | "Hook run after finding symbol definition. | |
104 | ||
105 | See the functions `find-function' and `find-variable'." | |
86f28125 | 106 | :group 'find-function |
a6223467 | 107 | :version "20.3") |
2cd6a032 RS |
108 | |
109 | ;;; Functions: | |
110 | ||
111 | (defun find-function-search-for-symbol (symbol variable-p library) | |
d3d4fb62 | 112 | "Search for SYMBOL. |
2cd6a032 | 113 | If VARIABLE-P is nil, `find-function-regexp' is used, otherwise |
d3d4fb62 | 114 | `find-variable-regexp' is used. The search is done in library LIBRARY." |
2cd6a032 RS |
115 | (if (null library) |
116 | (error "Don't know where `%s' is defined" symbol)) | |
78b6524e DL |
117 | (save-match-data |
118 | (if (string-match "\\.el\\(c\\)\\'" library) | |
119 | (setq library (substring library 0 (match-beginning 1)))) | |
120 | (let* ((path find-function-source-path) | |
121 | (compression (or (rassq 'jka-compr-handler file-name-handler-alist) | |
122 | (member 'crypt-find-file-hook find-file-hooks))) | |
123 | (filename (progn | |
124 | ;; use `file-name-sans-extension' here? (if it gets fixed) | |
125 | (if (string-match "\\(\\.el\\)\\'" library) | |
126 | (setq library (substring library 0 | |
127 | (match-beginning 1)))) | |
128 | (or (locate-library (concat library ".el") t path) | |
129 | (locate-library library t path) | |
130 | (if compression | |
131 | (or (locate-library (concat library ".el.gz") | |
132 | t path) | |
133 | (locate-library (concat library ".gz") | |
134 | t path))))))) | |
135 | (if (not filename) | |
136 | (error "The library `%s' is not in the path" library)) | |
137 | (with-current-buffer (find-file-noselect filename) | |
2cd6a032 RS |
138 | (let ((regexp (format (if variable-p |
139 | find-variable-regexp | |
140 | find-function-regexp) | |
141 | (regexp-quote (symbol-name symbol)))) | |
142 | (syn-table (syntax-table))) | |
143 | (unwind-protect | |
144 | (progn | |
145 | (set-syntax-table emacs-lisp-mode-syntax-table) | |
146 | (goto-char (point-min)) | |
147 | (if (re-search-forward regexp nil t) | |
148 | (progn | |
149 | (beginning-of-line) | |
150 | (cons (current-buffer) (point))) | |
d3d4fb62 | 151 | (error "Cannot find definition of `%s' in library `%s'" |
2cd6a032 RS |
152 | symbol library))) |
153 | (set-syntax-table syn-table))))))) | |
154 | ||
8a8a9abe | 155 | ;;;###autoload |
2cd6a032 | 156 | (defun find-function-noselect (function) |
d3d4fb62 | 157 | "Return a pair (BUFFER . POINT) pointing to the definition of FUNCTION. |
fffee8be DL |
158 | |
159 | Finds the Emacs Lisp library containing the definition of FUNCTION | |
2cd6a032 | 160 | in a buffer and the point of the definition. The buffer is |
fffee8be DL |
161 | not selected. |
162 | ||
2cd6a032 | 163 | If the file where FUNCTION is defined is not known, then it is |
d3d4fb62 | 164 | searched for in `find-function-source-path' if non nil, otherwise |
2cd6a032 | 165 | in `load-path'." |
fffee8be DL |
166 | (if (not function) |
167 | (error "You didn't specify a function")) | |
2cd6a032 RS |
168 | (and (subrp (symbol-function function)) |
169 | (error "%s is a primitive function" function)) | |
fffee8be | 170 | (let ((def (symbol-function function)) |
2cd6a032 | 171 | aliases) |
fffee8be DL |
172 | (while (symbolp def) |
173 | (or (eq def function) | |
174 | (if aliases | |
175 | (setq aliases (concat aliases | |
2cd6a032 | 176 | (format ", which is an alias for `%s'" |
fffee8be | 177 | (symbol-name def)))) |
2cd6a032 RS |
178 | (setq aliases (format "`%s' an alias for `%s'" |
179 | function (symbol-name def))))) | |
fffee8be DL |
180 | (setq function (symbol-function function) |
181 | def (symbol-function function))) | |
182 | (if aliases | |
183 | (message aliases)) | |
2cd6a032 RS |
184 | (let ((library |
185 | (cond ((eq (car-safe def) 'autoload) | |
186 | (nth 1 def)) | |
187 | ((symbol-file function))))) | |
188 | (find-function-search-for-symbol function nil library)))) | |
fffee8be | 189 | |
a469e8ba | 190 | (defalias 'function-at-point 'function-called-at-point) |
fffee8be | 191 | |
2cd6a032 RS |
192 | (defun find-function-read (&optional variable-p) |
193 | "Read and return an interned symbol, defaulting to the one near point. | |
fffee8be | 194 | |
2cd6a032 | 195 | If the optional VARIABLE-P is nil, then a function is gotten |
d3d4fb62 | 196 | defaulting to the value of the function `function-at-point', otherwise |
2cd6a032 RS |
197 | a variable is asked for, with the default coming from |
198 | `variable-at-point'." | |
199 | (let ((symb (funcall (if variable-p | |
200 | 'variable-at-point | |
201 | 'function-at-point))) | |
fffee8be DL |
202 | (enable-recursive-minibuffers t) |
203 | val) | |
2cd6a032 RS |
204 | (if (equal symb 0) |
205 | (setq symb nil)) | |
206 | (setq val (if variable-p | |
207 | (completing-read | |
208 | (concat "Find variable" | |
209 | (if symb | |
210 | (format " (default %s)" symb)) | |
211 | ": ") | |
212 | obarray 'boundp t nil) | |
213 | (completing-read | |
214 | (concat "Find function" | |
215 | (if symb | |
216 | (format " (default %s)" symb)) | |
217 | ": ") | |
218 | obarray 'fboundp t nil))) | |
fffee8be | 219 | (list (if (equal val "") |
2cd6a032 RS |
220 | symb |
221 | (intern val))))) | |
fffee8be | 222 | |
2cd6a032 | 223 | (defun find-function-do-it (symbol variable-p switch-fn) |
d3d4fb62 RS |
224 | "Find Emacs Lisp SYMBOL in a buffer and display it. |
225 | If VARIABLE-P is nil, a function definition is searched for, otherwise | |
2cd6a032 RS |
226 | a variable definition is searched for. The start of a definition is |
227 | centered according to the variable `find-function-recenter-line'. | |
d3d4fb62 | 228 | See also `find-function-after-hook' It is displayed with function SWITCH-FN. |
2cd6a032 RS |
229 | |
230 | Point is saved in the buffer if it is one of the current buffers." | |
86f28125 RS |
231 | (let* ((orig-point (point)) |
232 | (orig-buf (window-buffer)) | |
2cd6a032 | 233 | (orig-buffers (buffer-list)) |
86f28125 RS |
234 | (buffer-point (save-excursion |
235 | (funcall (if variable-p | |
236 | 'find-variable-noselect | |
237 | 'find-function-noselect) | |
238 | symbol))) | |
239 | (new-buf (car buffer-point)) | |
240 | (new-point (cdr buffer-point))) | |
2cd6a032 | 241 | (when buffer-point |
86f28125 | 242 | (when (memq new-buf orig-buffers) |
2cd6a032 | 243 | (push-mark orig-point)) |
86f28125 RS |
244 | (funcall switch-fn new-buf) |
245 | (goto-char new-point) | |
2cd6a032 | 246 | (recenter find-function-recenter-line) |
8d8ca3cf | 247 | (run-hooks 'find-function-after-hook)))) |
fffee8be | 248 | |
b07745ec | 249 | ;;;###autoload |
2cd6a032 | 250 | (defun find-function (function) |
c7efc289 | 251 | "Find the definition of the FUNCTION near point. |
fffee8be DL |
252 | |
253 | Finds the Emacs Lisp library containing the definition of the function | |
2cd6a032 RS |
254 | near point (selected by `function-at-point') in a buffer and |
255 | places point before the definition. Point is saved in the buffer if | |
256 | it is one of the current buffers. | |
fffee8be | 257 | |
2cd6a032 | 258 | The library where FUNCTION is defined is searched for in |
d3d4fb62 | 259 | `find-function-source-path', if non nil, otherwise in `load-path'. |
2cd6a032 RS |
260 | See also `find-function-recenter-line' and `find-function-after-hook'." |
261 | (interactive (find-function-read)) | |
262 | (find-function-do-it function nil 'switch-to-buffer)) | |
fffee8be | 263 | |
b07745ec | 264 | ;;;###autoload |
2cd6a032 | 265 | (defun find-function-other-window (function) |
c7efc289 | 266 | "Find, in another window, the definition of FUNCTION near point. |
fffee8be | 267 | |
2cd6a032 RS |
268 | See `find-function' for more details." |
269 | (interactive (find-function-read)) | |
270 | (find-function-do-it function nil 'switch-to-buffer-other-window)) | |
fffee8be | 271 | |
b07745ec | 272 | ;;;###autoload |
2cd6a032 | 273 | (defun find-function-other-frame (function) |
c7efc289 | 274 | "Find, in ananother frame, the definition of FUNCTION near point. |
fffee8be | 275 | |
2cd6a032 RS |
276 | See `find-function' for more details." |
277 | (interactive (find-function-read)) | |
278 | (find-function-do-it function nil 'switch-to-buffer-other-frame)) | |
279 | ||
e1acbda2 | 280 | ;;;###autoload |
2cd6a032 | 281 | (defun find-variable-noselect (variable) |
d3d4fb62 | 282 | "Return a pair `(buffer . point)' pointing to the definition of SYMBOL. |
2cd6a032 RS |
283 | |
284 | Finds the Emacs Lisp library containing the definition of SYMBOL | |
285 | in a buffer and the point of the definition. The buffer is | |
286 | not selected. | |
287 | ||
288 | The library where VARIABLE is defined is searched for in | |
d3d4fb62 | 289 | `find-function-source-path', if non nil, otherwise in `load-path'." |
2cd6a032 RS |
290 | (if (not variable) |
291 | (error "You didn't specify a variable")) | |
292 | (let ((library (symbol-file variable))) | |
293 | (find-function-search-for-symbol variable 'variable library))) | |
294 | ||
295 | ;;;###autoload | |
296 | (defun find-variable (variable) | |
c7efc289 | 297 | "Find the definition of the VARIABLE near point. |
2cd6a032 RS |
298 | |
299 | Finds the Emacs Lisp library containing the definition of the variable | |
300 | near point (selected by `variable-at-point') in a buffer and | |
301 | places point before the definition. Point is saved in the buffer if | |
302 | it is one of the current buffers. | |
303 | ||
304 | The library where VARIABLE is defined is searched for in | |
d3d4fb62 | 305 | `find-function-source-path', if non nil, otherwise in `load-path'. |
2cd6a032 RS |
306 | See also `find-function-recenter-line' and `find-function-after-hook'." |
307 | (interactive (find-function-read 'variable)) | |
308 | (find-function-do-it variable t 'switch-to-buffer)) | |
fffee8be | 309 | |
2cd6a032 RS |
310 | ;;;###autoload |
311 | (defun find-variable-other-window (variable) | |
c7efc289 | 312 | "Find, in another window, the definition of VARIABLE near point. |
2cd6a032 RS |
313 | |
314 | See `find-variable' for more details." | |
315 | (interactive (find-function-read 'variable)) | |
316 | (find-function-do-it variable t 'switch-to-buffer-other-window)) | |
317 | ||
318 | ;;;###autoload | |
319 | (defun find-variable-other-frame (variable) | |
c7efc289 | 320 | "Find, in annother frame, the definition of VARIABLE near point. |
2cd6a032 RS |
321 | |
322 | See `find-variable' for more details." | |
323 | (interactive (find-function-read 'variable)) | |
324 | (find-function-do-it variable t 'switch-to-buffer-other-frame)) | |
fffee8be | 325 | |
b07745ec | 326 | ;;;###autoload |
fffee8be DL |
327 | (defun find-function-on-key (key) |
328 | "Find the function that KEY invokes. KEY is a string. | |
329 | Point is saved if FUNCTION is in the current buffer." | |
330 | (interactive "kFind function on key: ") | |
4a8ea8dc | 331 | (save-excursion |
43920c26 | 332 | (let* ((event (and (eventp key) (aref key 0))) ; Null event OK below. |
4a8ea8dc DL |
333 | (start (event-start event)) |
334 | (modifiers (event-modifiers event)) | |
335 | (window (and (or (memq 'click modifiers) (memq 'down modifiers) | |
336 | (memq 'drag modifiers)) | |
337 | (posn-window start)))) | |
338 | ;; For a mouse button event, go to the button it applies to | |
339 | ;; to get the right key bindings. And go to the right place | |
340 | ;; in case the keymap depends on where you clicked. | |
341 | (when (windowp window) | |
342 | (set-buffer (window-buffer window)) | |
343 | (goto-char (posn-point start))) | |
344 | (let ((defn (key-binding key)) | |
345 | (key-desc (key-description key))) | |
346 | (if (or (null defn) (integerp defn)) | |
347 | (message "%s is unbound" key-desc) | |
348 | (if (consp defn) | |
349 | (message "%s runs %s" key-desc (prin1-to-string defn)) | |
350 | (find-function-other-window defn))))))) | |
2cd6a032 RS |
351 | |
352 | ;;;###autoload | |
353 | (defun find-function-at-point () | |
354 | "Find directly the function at point in the other window." | |
355 | (interactive) | |
356 | (let ((symb (function-at-point))) | |
357 | (when symb | |
358 | (find-function-other-window symb)))) | |
359 | ||
360 | ;;;###autoload | |
361 | (defun find-variable-at-point () | |
362 | "Find directly the function at point in the other window." | |
363 | (interactive) | |
364 | (let ((symb (variable-at-point))) | |
365 | (when (and symb (not (equal symb 0))) | |
366 | (find-variable-other-window symb)))) | |
fffee8be | 367 | |
86f28125 RS |
368 | ;;;###autoload |
369 | (defun find-function-setup-keys () | |
370 | "Define some key bindings for the find-function family of functions." | |
371 | (define-key ctl-x-map "F" 'find-function) | |
372 | (define-key ctl-x-4-map "F" 'find-function-other-window) | |
373 | (define-key ctl-x-5-map "F" 'find-function-other-frame) | |
374 | (define-key ctl-x-map "K" 'find-function-on-key) | |
375 | (define-key ctl-x-map "V" 'find-variable) | |
376 | (define-key ctl-x-4-map "V" 'find-variable-other-window) | |
377 | (define-key ctl-x-5-map "V" 'find-variable-other-frame)) | |
378 | ||
fffee8be DL |
379 | (provide 'find-func) |
380 | ||
381 | ;;; find-func.el ends here |