1 ;;; find-func.el --- find the definition of the Emacs Lisp function near point -*- lexical-binding:t -*-
3 ;; Copyright (C) 1997, 1999, 2001-2016 Free Software Foundation, Inc.
5 ;; Author: Jens Petersen <petersen@kurims.kyoto-u.ac.jp>
6 ;; Maintainer: petersen@kurims.kyoto-u.ac.jp
7 ;; Keywords: emacs-lisp, functions, variables
10 ;; This file is part of GNU Emacs.
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 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; The funniest thing about this is that I can't imagine why a package
28 ;; so obviously useful as this hasn't been written before!!
30 ;; (find-function-setup-keys)
36 ;; if you don't like the given keybindings and away you go! It does
37 ;; pretty much what you would expect, putting the cursor at the
38 ;; definition of the function or variable at point.
40 ;; The code started out from `describe-function', `describe-key'
41 ;; ("help.el") and `fff-find-loaded-emacs-lisp-function' (Noah Friedman's
48 (defgroup find-function nil
49 "Finds the definition of the Emacs Lisp symbol near point."
50 ;; :prefix "find-function"
53 (defconst find-function-space-re "\\(?:\\s-\\|\n\\|;.*\n\\)+")
55 (defcustom find-function-regexp
56 ;; Match things like (defun foo ...), (defmacro foo ...),
57 ;; (define-skeleton foo ...), (define-generic-mode 'foo ...),
58 ;; (define-derived-mode foo ...), (define-minor-mode foo)
60 "^\\s-*(\\(def\\(ine-skeleton\\|ine-generic-mode\\|ine-derived-mode\\|\
61 ine\\(?:-global\\)?-minor-mode\\|ine-compilation-mode\\|un-cvs-mode\\|\
62 foo\\|\\(?:[^icfgv]\\|g[^r]\\)\\(\\w\\|\\s_\\)+\\*?\\)\\|easy-mmode-define-[a-z-]+\\|easy-menu-define\\|\
63 menu-bar-make-toggle\\)"
64 find-function-space-re
65 "\\('\\|(quote \\)?%s\\(\\s-\\|$\\|[()]\\)")
66 "The regexp used by `find-function' to search for a function definition.
67 Note it must contain a `%s' at the place where `format'
68 should insert the function name. The default value avoids `defconst',
69 `defgroup', `defvar', `defface'.
71 Please send improvements and fixes to the maintainer."
76 (defcustom find-variable-regexp
78 "^\\s-*(\\(def[^fumag]\\(\\w\\|\\s_\\)+\\*?\\|\
79 easy-mmode-def\\(map\\|syntax\\)\\|easy-menu-define\\)"
80 find-function-space-re
82 "The regexp used by `find-variable' to search for a variable definition.
83 Note it must contain a `%s' at the place where `format'
84 should insert the variable name. The default value
85 avoids `defun', `defmacro', `defalias', `defadvice', `defgroup', `defface'.
87 Please send improvements and fixes to the maintainer."
92 (defcustom find-face-regexp
93 (concat"^\\s-*(defface" find-function-space-re "%s\\(\\s-\\|$\\)")
94 "The regexp used by `find-face' to search for a face definition.
95 Note it must contain a `%s' at the place where `format'
96 should insert the face name.
98 Please send improvements and fixes to the maintainer."
100 :group 'find-function
103 (defcustom find-feature-regexp
105 "The regexp used by `xref-find-definitions' when searching for a feature definition.
106 Note it must contain a `%s' at the place where `format'
107 should insert the feature name."
108 ;; We search for ";;; Code" rather than (feature '%s) because the
109 ;; former is near the start of the code, and the latter is very
110 ;; uninteresting. If the regexp is not found, just goes to
111 ;; (point-min), which is acceptable in this case.
116 (defcustom find-alias-regexp
118 "The regexp used by `xref-find-definitions' to search for an alias definition.
119 Note it must contain a `%s' at the place where `format'
120 should insert the feature name."
125 (defvar find-function-regexp-alist
126 '((nil . find-function-regexp)
127 (defvar . find-variable-regexp)
128 (defface . find-face-regexp)
129 (feature . find-feature-regexp)
130 (defalias . find-alias-regexp))
131 "Alist mapping definition types into regexp variables.
132 Each regexp variable's value should actually be a format string
133 to be used to substitute the desired symbol name into the regexp.
134 Instead of regexp variable, types can be mapped to functions as well,
135 in which case the function is called with one argument (the object
136 we're looking for) and it should search for it.")
137 (put 'find-function-regexp-alist 'risky-local-variable t)
139 (defcustom find-function-source-path nil
140 "The default list of directories where `find-function' searches.
142 If this variable is nil then `find-function' searches `load-path' by
144 :type '(repeat directory)
145 :group 'find-function)
147 (defcustom find-function-recenter-line 1
148 "The window line-number from which to start displaying a symbol definition.
149 A value of nil implies center the beginning of the definition.
150 See `find-function' and `find-variable'."
151 :type '(choice (const :tag "Center" nil)
153 :group 'find-function
156 (defcustom find-function-after-hook nil
157 "Hook run after finding symbol definition.
159 See the functions `find-function' and `find-variable'."
161 :group 'find-function
166 (defun find-library-suffixes ()
167 (let ((suffixes nil))
168 (dolist (suffix (get-load-suffixes) (nreverse suffixes))
169 (unless (string-match "elc" suffix) (push suffix suffixes)))))
171 (defun find-library--load-name (library)
172 (let ((name library))
173 (dolist (dir load-path)
174 (let ((rel (file-relative-name library dir)))
175 (if (and (not (string-match "\\`\\.\\./" rel))
176 (< (length rel) (length name)))
178 (unless (equal name library) name)))
180 (defun find-library-name (library)
181 "Return the absolute file name of the Emacs Lisp source of LIBRARY.
182 LIBRARY should be a string (the name of the library)."
183 ;; If the library is byte-compiled, try to find a source library by
185 (if (string-match "\\.el\\(c\\(\\..*\\)?\\)\\'" library)
186 (setq library (replace-match "" t t library)))
189 (or find-function-source-path load-path)
190 (find-library-suffixes))
192 (or find-function-source-path load-path)
193 load-file-rep-suffixes)
194 (when (file-name-absolute-p library)
195 (let ((rel (find-library--load-name library)))
199 (or find-function-source-path load-path)
200 (find-library-suffixes))
202 (or find-function-source-path load-path)
203 load-file-rep-suffixes)))))
204 (error "Can't find library %s" library)))
206 (defvar find-function-C-source-directory
207 (let ((dir (expand-file-name "src" source-directory)))
208 (if (file-accessible-directory-p dir) dir))
209 "Directory where the C source files of Emacs can be found.
210 If nil, do not try to find the source code of functions and variables
213 (declare-function ad-get-advice-info "advice" (function))
215 (defun find-function-advised-original (func)
216 "Return the original function definition of an advised function FUNC.
217 If FUNC is not a symbol, return it. Else, if it's not advised,
218 return the symbol's function definition."
219 (or (and (symbolp func)
221 (let ((ofunc (advice--symbol-function func)))
222 (if (advice--p ofunc)
227 (defun find-function-C-source (fun-or-var file type)
228 "Find the source location where FUN-OR-VAR is defined in FILE.
229 TYPE should be nil to find a function, or `defvar' to find a variable."
230 (let ((dir (or find-function-C-source-directory
231 (read-directory-name "Emacs C source dir: " nil nil t))))
232 (setq file (expand-file-name file dir))
233 (if (file-readable-p file)
234 (if (null find-function-C-source-directory)
235 (setq find-function-C-source-directory dir))
236 (error "The C source file %s is not available"
237 (file-name-nondirectory file))))
239 ;; Either or both an alias and its target might be advised.
240 (setq fun-or-var (find-function-advised-original
242 (find-function-advised-original fun-or-var)))))
243 (with-current-buffer (find-file-noselect file)
244 (goto-char (point-min))
245 (unless (re-search-forward
247 (concat "DEFVAR[A-Z_]*[ \t\n]*([ \t\n]*\""
248 (regexp-quote (symbol-name fun-or-var))
250 (concat "DEFUN[ \t\n]*([ \t\n]*\""
251 (regexp-quote (subr-name (advice--cd*r fun-or-var)))
254 (error "Can't find source for %s" fun-or-var))
255 (cons (current-buffer) (match-beginning 0))))
258 (defun find-library (library)
259 "Find the Emacs Lisp source of LIBRARY.
260 LIBRARY should be a string (the name of the library)."
262 (let* ((dirs (or find-function-source-path load-path))
263 (suffixes (find-library-suffixes))
264 (table (apply-partially 'locate-file-completion-table
266 (def (if (eq (function-called-at-point) 'require)
267 ;; `function-called-at-point' may return 'require
268 ;; with `point' anywhere on this line. So wrap the
269 ;; `save-excursion' below in a `condition-case' to
270 ;; avoid reporting a scan-error here.
276 (thing-at-point 'symbol))
278 (thing-at-point 'symbol))))
279 (when (and def (not (test-completion def table)))
282 (completing-read (if def (format "Library name (default %s): " def)
284 table nil nil nil nil def))))
285 (let ((buf (find-file-noselect (find-library-name library))))
286 (condition-case nil (switch-to-buffer buf) (error (pop-to-buffer buf)))))
289 (defun find-function-search-for-symbol (symbol type library)
290 "Search for SYMBOL's definition of type TYPE in LIBRARY.
291 Visit the library in a buffer, and return a cons cell (BUFFER . POSITION),
292 or just (BUFFER . nil) if the definition can't be found in the file.
294 If TYPE is nil, look for a function definition.
295 Otherwise, TYPE specifies the kind of definition,
296 and it is interpreted via `find-function-regexp-alist'.
297 The search is done in the source for library LIBRARY."
299 (error "Don't know where `%s' is defined" symbol))
300 ;; Some functions are defined as part of the construct
301 ;; that defines something else.
302 (while (and (symbolp symbol) (get symbol 'definition-name))
303 (setq symbol (get symbol 'definition-name)))
304 (if (string-match "\\`src/\\(.*\\.\\(c\\|m\\)\\)\\'" library)
305 (find-function-C-source symbol (match-string 1 library) type)
306 (when (string-match "\\.el\\(c\\)\\'" library)
307 (setq library (substring library 0 (match-beginning 1))))
308 ;; Strip extension from .emacs.el to make sure symbol is searched in
310 (when (string-match "\\.emacs\\(.el\\)" library)
311 (setq library (substring library 0 (match-beginning 1))))
312 (let* ((filename (find-library-name library))
313 (regexp-symbol (cdr (assq type find-function-regexp-alist))))
314 (with-current-buffer (find-file-noselect filename)
315 (let ((regexp (if (functionp regexp-symbol) regexp-symbol
316 (format (symbol-value regexp-symbol)
317 ;; Entry for ` (backquote) macro in loaddefs.el,
318 ;; (defalias (quote \`)..., has a \ but
319 ;; (symbol-name symbol) doesn't. Add an
320 ;; optional \ to catch this.
322 (regexp-quote (symbol-name symbol))))))
324 (with-syntax-table emacs-lisp-mode-syntax-table
325 (goto-char (point-min))
326 (if (if (functionp regexp)
327 (funcall regexp symbol)
328 (or (re-search-forward regexp nil t)
329 ;; `regexp' matches definitions using known forms like
330 ;; `defun', or `defvar'. But some functions/variables
331 ;; are defined using special macros (or functions), so
332 ;; if `regexp' can't find the definition, we look for
333 ;; something of the form "(SOMETHING <symbol> ...)".
334 ;; This fails to distinguish function definitions from
335 ;; variable declarations (or even uses thereof), but is
336 ;; a good pragmatic fallback.
338 (concat "^([^ ]+" find-function-space-re "['(]?"
339 (regexp-quote (symbol-name symbol))
344 (cons (current-buffer) (point)))
345 (cons (current-buffer) nil))))))))
347 (defun find-function-library (function &optional lisp-only verbose)
348 "Return the pair (ORIG-FUNCTION . LIBRARY) for FUNCTION.
350 ORIG-FUNCTION is the original name, after removing all advice and
351 resolving aliases. LIBRARY is an absolute file name, a relative
352 file name inside the C sources directory, or a name of an
355 If ORIG-FUNCTION is a built-in function and LISP-ONLY is non-nil,
358 If VERBOSE is non-nil, and FUNCTION is an alias, display a
359 message about the whole chain of aliases."
360 (let ((def (when (symbolp function)
361 (or (fboundp function)
362 (signal 'void-function (list function)))
363 (find-function-advised-original function)))
365 ;; FIXME for completeness, it might be nice to print something like:
366 ;; foo (which is advised), which is an alias for bar (which is advised).
367 (while (and def (symbolp def))
368 (or (eq def function)
370 (setq aliases (if aliases
373 ", which is an alias for `%s'"
375 (format-message "`%s' is an alias for `%s'"
376 function (symbol-name def)))))
377 (setq function (find-function-advised-original function)
378 def (find-function-advised-original function)))
380 (message "%s" aliases))
383 ((autoloadp def) (nth 1 def))
386 (error "%s is a built-in function" function))
387 (help-C-file-name def 'subr))
388 ((symbol-file function 'defun))))))
391 (defun find-function-noselect (function &optional lisp-only)
392 "Return a pair (BUFFER . POINT) pointing to the definition of FUNCTION.
394 Finds the source file containing the definition of FUNCTION
395 in a buffer and the point of the definition. The buffer is
396 not selected. If the function definition can't be found in
397 the buffer, returns (BUFFER).
399 If FUNCTION is a built-in function, this function normally
400 attempts to find it in the Emacs C sources; however, if LISP-ONLY
401 is non-nil, signal an error instead.
403 If the file where FUNCTION is defined is not known, then it is
404 searched for in `find-function-source-path' if non-nil, otherwise
407 (error "You didn't specify a function"))
408 (let ((func-lib (find-function-library function lisp-only t)))
409 (find-function-search-for-symbol (car func-lib) nil (cdr func-lib))))
411 (defun find-function-read (&optional type)
412 "Read and return an interned symbol, defaulting to the one near point.
414 If TYPE is nil, insist on a symbol with a function definition.
415 Otherwise TYPE should be `defvar' or `defface'.
416 If TYPE is nil, defaults using `function-called-at-point',
417 otherwise uses `variable-at-point'."
418 (let* ((symb1 (cond ((null type) (function-called-at-point))
419 ((eq type 'defvar) (variable-at-point))
420 (t (variable-at-point t))))
421 (symb (unless (eq symb1 0) symb1))
422 (predicate (cdr (assq type '((nil . fboundp)
424 (defface . facep)))))
425 (prompt-type (cdr (assq type '((nil . "function")
426 (defvar . "variable")
427 (defface . "face")))))
428 (prompt (concat "Find " prompt-type
429 (and symb (format " (default %s)" symb))
431 (enable-recursive-minibuffers t))
432 (list (intern (completing-read
433 prompt obarray predicate
434 t nil nil (and symb (symbol-name symb)))))))
436 (defun find-function-do-it (symbol type switch-fn)
437 "Find Emacs Lisp SYMBOL in a buffer and display it.
438 TYPE is nil to search for a function definition,
439 or else `defvar' or `defface'.
441 The variable `find-function-recenter-line' controls how
442 to recenter the display. SWITCH-FN is the function to call
443 to display and select the buffer.
444 See also `find-function-after-hook'.
446 Set mark before moving, if the buffer already existed."
447 (let* ((orig-point (point))
448 (orig-buffers (buffer-list))
449 (buffer-point (save-excursion
450 (find-definition-noselect symbol type)))
451 (new-buf (car buffer-point))
452 (new-point (cdr buffer-point)))
454 (when (memq new-buf orig-buffers)
455 (push-mark orig-point))
456 (funcall switch-fn new-buf)
457 (when new-point (goto-char new-point))
458 (recenter find-function-recenter-line)
459 (run-hooks 'find-function-after-hook))))
462 (defun find-function (function)
463 "Find the definition of the FUNCTION near point.
465 Finds the source file containing the definition of the function
466 near point (selected by `function-called-at-point') in a buffer and
467 places point before the definition.
468 Set mark before moving, if the buffer already existed.
470 The library where FUNCTION is defined is searched for in
471 `find-function-source-path', if non-nil, otherwise in `load-path'.
472 See also `find-function-recenter-line' and `find-function-after-hook'."
473 (interactive (find-function-read))
474 (find-function-do-it function nil 'switch-to-buffer))
477 (defun find-function-other-window (function)
478 "Find, in another window, the definition of FUNCTION near point.
480 See `find-function' for more details."
481 (interactive (find-function-read))
482 (find-function-do-it function nil 'switch-to-buffer-other-window))
485 (defun find-function-other-frame (function)
486 "Find, in another frame, the definition of FUNCTION near point.
488 See `find-function' for more details."
489 (interactive (find-function-read))
490 (find-function-do-it function nil 'switch-to-buffer-other-frame))
493 (defun find-variable-noselect (variable &optional file)
494 "Return a pair `(BUFFER . POINT)' pointing to the definition of VARIABLE.
496 Finds the library containing the definition of VARIABLE in a buffer and
497 the point of the definition. The buffer is not selected.
498 If the variable's definition can't be found in the buffer, return (BUFFER).
500 The library where VARIABLE is defined is searched for in FILE or
501 `find-function-source-path', if non-nil, otherwise in `load-path'."
503 (error "You didn't specify a variable")
504 (let ((library (or file
505 (symbol-file variable 'defvar)
506 (help-C-file-name variable 'var))))
507 (find-function-search-for-symbol variable 'defvar library))))
510 (defun find-variable (variable)
511 "Find the definition of the VARIABLE at or before point.
513 Finds the library containing the definition of the variable
514 near point (selected by `variable-at-point') in a buffer and
515 places point before the definition.
517 Set mark before moving, if the buffer already existed.
519 The library where VARIABLE is defined is searched for in
520 `find-function-source-path', if non-nil, otherwise in `load-path'.
521 See also `find-function-recenter-line' and `find-function-after-hook'."
522 (interactive (find-function-read 'defvar))
523 (find-function-do-it variable 'defvar 'switch-to-buffer))
526 (defun find-variable-other-window (variable)
527 "Find, in another window, the definition of VARIABLE near point.
529 See `find-variable' for more details."
530 (interactive (find-function-read 'defvar))
531 (find-function-do-it variable 'defvar 'switch-to-buffer-other-window))
534 (defun find-variable-other-frame (variable)
535 "Find, in another frame, the definition of VARIABLE near point.
537 See `find-variable' for more details."
538 (interactive (find-function-read 'defvar))
539 (find-function-do-it variable 'defvar 'switch-to-buffer-other-frame))
542 (defun find-definition-noselect (symbol type &optional file)
543 "Return a pair `(BUFFER . POINT)' pointing to the definition of SYMBOL.
544 If the definition can't be found in the buffer, return (BUFFER).
545 TYPE says what type of definition: nil for a function, `defvar' for a
546 variable, `defface' for a face. This function does not switch to the
547 buffer nor display it.
549 The library where SYMBOL is defined is searched for in FILE or
550 `find-function-source-path', if non-nil, otherwise in `load-path'."
553 (error "You didn't specify a symbol"))
555 (find-function-noselect symbol))
557 (find-variable-noselect symbol file))
559 (let ((library (or file (symbol-file symbol type))))
560 (find-function-search-for-symbol symbol type library)))))
562 ;; For symmetry, this should be called find-face; but some programs
563 ;; assume that, if that name is defined, it means something else.
565 (defun find-face-definition (face)
566 "Find the definition of FACE. FACE defaults to the name near point.
568 Finds the Emacs Lisp library containing the definition of the face
569 near point (selected by `variable-at-point') in a buffer and
570 places point before the definition.
572 Set mark before moving, if the buffer already existed.
574 The library where FACE is defined is searched for in
575 `find-function-source-path', if non-nil, otherwise in `load-path'.
576 See also `find-function-recenter-line' and `find-function-after-hook'."
577 (interactive (find-function-read 'defface))
578 (find-function-do-it face 'defface 'switch-to-buffer))
580 (defun find-function-on-key-do-it (key find-fn)
581 "Find the function that KEY invokes. KEY is a string.
582 Set mark before moving, if the buffer already existed.
584 FIND-FN is the function to call to navigate to the function."
587 (let* ((event (and (eventp key) (aref key 0))) ; Null event OK below.
588 (start (event-start event))
589 (modifiers (event-modifiers event))
590 (window (and (or (memq 'click modifiers) (memq 'down modifiers)
591 (memq 'drag modifiers))
592 (posn-window start))))
593 ;; For a mouse button event, go to the button it applies to
594 ;; to get the right key bindings. And go to the right place
595 ;; in case the keymap depends on where you clicked.
596 (when (windowp window)
597 (set-buffer (window-buffer window))
598 (goto-char (posn-point start)))
599 (setq defn (key-binding key))))
600 (let ((key-desc (key-description key)))
601 (if (or (null defn) (integerp defn))
602 (message "%s is unbound" key-desc)
604 (message "%s runs %s" key-desc (prin1-to-string defn))
605 (funcall find-fn defn))))))
608 (defun find-function-on-key (key)
609 "Find the function that KEY invokes. KEY is a string.
610 Set mark before moving, if the buffer already existed."
611 (interactive "kFind function on key: ")
612 (find-function-on-key-do-it key #'find-function))
615 (defun find-function-on-key-other-window (key)
616 "Find, in the other window, the function that KEY invokes.
617 See `find-function-on-key'."
618 (interactive "kFind function on key: ")
619 (find-function-on-key-do-it key #'find-function-other-window))
622 (defun find-function-on-key-other-frame (key)
623 "Find, in the other frame, the function that KEY invokes.
624 See `find-function-on-key'."
625 (interactive "kFind function on key: ")
626 (find-function-on-key-do-it key #'find-function-other-frame))
629 (defun find-function-at-point ()
630 "Find directly the function at point in the other window."
632 (let ((symb (function-called-at-point)))
634 (find-function-other-window symb))))
637 (defun find-variable-at-point ()
638 "Find directly the variable at point in the other window."
640 (let ((symb (variable-at-point)))
641 (when (and symb (not (equal symb 0)))
642 (find-variable-other-window symb))))
645 (defun find-function-setup-keys ()
646 "Define some key bindings for the find-function family of functions."
647 (define-key ctl-x-map "F" 'find-function)
648 (define-key ctl-x-4-map "F" 'find-function-other-window)
649 (define-key ctl-x-5-map "F" 'find-function-other-frame)
650 (define-key ctl-x-map "K" 'find-function-on-key)
651 (define-key ctl-x-4-map "K" 'find-function-on-key-other-window)
652 (define-key ctl-x-5-map "K" 'find-function-on-key-other-frame)
653 (define-key ctl-x-map "V" 'find-variable)
654 (define-key ctl-x-4-map "V" 'find-variable-other-window)
655 (define-key ctl-x-5-map "V" 'find-variable-other-frame))
659 ;;; find-func.el ends here