annotate lisp/emacs-lisp/find-func.el @ 83384:08b4dd6a6e87

Merged from miles@gnu.org--gnu-2005 (patch 578-592) Patches applied: * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-578 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-579 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-580 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-581 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-582 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-583 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-584 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-585 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-586 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-587 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-588 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-589 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-590 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-591 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-592 Update from CVS git-archimport-id: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-424
author Karoly Lorentey <lorentey@elte.hu>
date Wed, 12 Oct 2005 16:14:04 +0000
parents c45ae2a74f0f
children 22d687da5d5d fa0da9b57058
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
1 ;;; find-func.el --- find the definition of the Emacs Lisp function near point
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
2
64751
5b1a238fcbb4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64510
diff changeset
3 ;; Copyright (C) 1997, 1999, 2001, 2002, 2003, 2004,
5b1a238fcbb4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64510
diff changeset
4 ;; 2005 Free Software Foundation, Inc.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
5
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
6 ;; Author: Jens Petersen <petersen@kurims.kyoto-u.ac.jp>
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
7 ;; Maintainer: petersen@kurims.kyoto-u.ac.jp
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
8 ;; Keywords: emacs-lisp, functions, variables
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
9 ;; Created: 97/07/25
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
10
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
11 ;; This file is part of GNU Emacs.
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
12
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
14 ;; it under the terms of the GNU General Public License as published by
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
15 ;; the Free Software Foundation; either version 2, or (at your option)
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
16 ;; any later version.
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
17
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
18 ;; GNU Emacs is distributed in the hope that it will be useful,
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
21 ;; GNU General Public License for more details.
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
22
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
23 ;; You should have received a copy of the GNU General Public License
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64085
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 62908
diff changeset
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 62908
diff changeset
26 ;; Boston, MA 02110-1301, USA.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
27
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
28 ;;; Commentary:
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
29 ;;
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
30 ;; The funniest thing about this is that I can't imagine why a package
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
31 ;; so obviously useful as this hasn't been written before!!
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
32 ;; ;;; find-func
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
33 ;; (find-function-setup-keys)
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
34 ;;
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
35 ;; or just:
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
36 ;;
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
37 ;; (load "find-func")
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
38 ;;
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
39 ;; if you don't like the given keybindings and away you go! It does
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
40 ;; pretty much what you would expect, putting the cursor at the
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
41 ;; definition of the function or variable at point.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
42 ;;
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
43 ;; The code started out from `describe-function', `describe-key'
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
44 ;; ("help.el") and `fff-find-loaded-emacs-lisp-function' (Noah Friedman's
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
45 ;; "fff.el").
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
46
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 33198
diff changeset
47 ;;; Code:
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
48
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
49 (require 'loadhist)
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
50
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
51 ;;; User variables:
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
52
20962
54413501e4a9 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 20184
diff changeset
53 (defgroup find-function nil
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
54 "Finds the definition of the Emacs Lisp symbol near point."
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
55 ;; :prefix "find-function"
20962
54413501e4a9 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 20184
diff changeset
56 :group 'lisp)
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
57
45326
892ea515fb3a (find-function-search-for-symbol): Find funs defined with defun-cvs-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45257
diff changeset
58 (defconst find-function-space-re "\\(?:\\s-\\|\n\\|;.*\n\\)+")
892ea515fb3a (find-function-search-for-symbol): Find funs defined with defun-cvs-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45257
diff changeset
59
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
60 (defcustom find-function-regexp
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
61 ;; Match things like (defun foo ...), (defmacro foo ...),
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
62 ;; (define-skeleton foo ...), (define-generic-mode 'foo ...),
26558
2daba92c1033 (find-function-regexp): Use `define-minor-mode' after easy-menu
Dave Love <fx@gnu.org>
parents: 25424
diff changeset
63 ;; (define-derived-mode foo ...), (define-minor-mode foo)
45326
892ea515fb3a (find-function-search-for-symbol): Find funs defined with defun-cvs-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45257
diff changeset
64 (concat
892ea515fb3a (find-function-search-for-symbol): Find funs defined with defun-cvs-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45257
diff changeset
65 "^\\s-*(\\(def\\(ine-skeleton\\|ine-generic-mode\\|ine-derived-mode\\|\
64510
6c458b0fe83f (find-function-regexp): Add `define-compilation-mode'.
Juri Linkov <juri@jurta.org>
parents: 64085
diff changeset
66 ine-minor-mode\\|ine-compilation-mode\\|un-cvs-mode\\|foo\\|[^cfgv]\\w+\\*?\\)\
60628
532be1846a28 (find-function-regexp): Add defun-emitting macro `menu-bar-make-toggle'.
Juri Linkov <juri@jurta.org>
parents: 59996
diff changeset
67 \\|easy-mmode-define-global-mode\\|menu-bar-make-toggle\\)"
532be1846a28 (find-function-regexp): Add defun-emitting macro `menu-bar-make-toggle'.
Juri Linkov <juri@jurta.org>
parents: 59996
diff changeset
68 find-function-space-re
45326
892ea515fb3a (find-function-search-for-symbol): Find funs defined with defun-cvs-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45257
diff changeset
69 "\\('\\|\(quote \\)?%s\\(\\s-\\|$\\|\(\\|\)\\)")
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
70 "The regexp used by `find-function' to search for a function definition.
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
71 Note it must contain a `%s' at the place where `format'
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
72 should insert the function name. The default value avoids `defconst',
58261
212733e53508 (find-function-regexp): Optimize `define-minor-mode'. Add `defun-cvs-mode'.
Juri Linkov <juri@jurta.org>
parents: 55231
diff changeset
73 `defgroup', `defvar', `defface'.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
74
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
75 Please send improvements and fixes to the maintainer."
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
76 :type 'regexp
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
77 :group 'find-function
26558
2daba92c1033 (find-function-regexp): Use `define-minor-mode' after easy-menu
Dave Love <fx@gnu.org>
parents: 25424
diff changeset
78 :version "21.1")
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
79
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
80 (defcustom find-variable-regexp
59330
03306a6707b9 (find-variable-regexp): Avoid defface.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59122
diff changeset
81 (concat"^\\s-*(def[^fumag]\\(\\w\\|\\s_\\)+\\*?" find-function-space-re "%s\\(\\s-\\|$\\)")
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
82 "The regexp used by `find-variable' to search for a variable definition.
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
83 Note it must contain a `%s' at the place where `format'
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
84 should insert the variable name. The default value
59330
03306a6707b9 (find-variable-regexp): Avoid defface.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59122
diff changeset
85 avoids `defun', `defmacro', `defalias', `defadvice', `defgroup', `defface'.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
86
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
87 Please send improvements and fixes to the maintainer."
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
88 :type 'regexp
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
89 :group 'find-function
32226
2af46c6c8bde (find-function-regexp): Remove spurion.
Dave Love <fx@gnu.org>
parents: 26593
diff changeset
90 :version "21.1")
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
91
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
92 (defcustom find-face-regexp
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
93 (concat"^\\s-*(defface" find-function-space-re "%s\\(\\s-\\|$\\)")
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
94 "The regexp used by `find-face' to search for a face definition.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
95 Note it must contain a `%s' at the place where `format'
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
96 should insert the face name.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
97
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
98 Please send improvements and fixes to the maintainer."
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
99 :type 'regexp
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
100 :group 'find-function
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 59404
diff changeset
101 :version "22.1")
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
102
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
103 (defvar find-function-regexp-alist
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
104 '((nil . find-function-regexp)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
105 (defvar . find-variable-regexp)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
106 (defface . find-face-regexp))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
107 "Alist mapping definition types into regexp variables.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
108 Each regexp variable's value should actually be a format string
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
109 to be used to substitute the desired symbol name into the regexp.")
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
110 (put 'find-function-regexp-alist 'risky-local-variable t)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
111
20962
54413501e4a9 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 20184
diff changeset
112 (defcustom find-function-source-path nil
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
113 "The default list of directories where `find-function' searches.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
114
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
115 If this variable is nil then `find-function' searches `load-path' by
20962
54413501e4a9 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 20184
diff changeset
116 default."
54413501e4a9 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 20184
diff changeset
117 :type '(repeat directory)
54413501e4a9 Customized.
Stephen Eglen <stephen@gnu.org>
parents: 20184
diff changeset
118 :group 'find-function)
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
119
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
120 (defcustom find-function-recenter-line 1
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
121 "The window line-number from which to start displaying a symbol definition.
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
122 A value of nil implies center the beginning of the definition.
47298
c6dddb2746ee * emacs-lisp/cl-indent.el (extended-loop-p): Doc fix.
John Paul Wallington <jpw@pobox.com>
parents: 47255
diff changeset
123 See `find-function' and `find-variable'."
c6dddb2746ee * emacs-lisp/cl-indent.el (extended-loop-p): Doc fix.
John Paul Wallington <jpw@pobox.com>
parents: 47255
diff changeset
124 :type '(choice (const :tag "Center" nil)
c6dddb2746ee * emacs-lisp/cl-indent.el (extended-loop-p): Doc fix.
John Paul Wallington <jpw@pobox.com>
parents: 47255
diff changeset
125 integer)
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
126 :group 'find-function
23100
043247d0ced9 Fix :version tags to have a string value, not a float.
Andreas Schwab <schwab@suse.de>
parents: 22867
diff changeset
127 :version "20.3")
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
128
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
129 (defcustom find-function-after-hook nil
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
130 "Hook run after finding symbol definition.
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
131
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
132 See the functions `find-function' and `find-variable'."
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
133 :group 'find-function
23100
043247d0ced9 Fix :version tags to have a string value, not a float.
Andreas Schwab <schwab@suse.de>
parents: 22867
diff changeset
134 :version "20.3")
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
135
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
136 ;;; Functions:
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
137
47345
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
138 (defun find-library-suffixes ()
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
139 (let ((suffixes nil))
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
140 (dolist (suffix load-suffixes (nreverse suffixes))
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
141 (unless (string-match "elc" suffix) (push suffix suffixes)))))
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
142
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
143 (defun find-library-name (library)
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
144 "Return the full name of the elisp source of LIBRARY."
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
145 ;; If the library is byte-compiled, try to find a source library by
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
146 ;; the same name.
47610
8a24f7edde82 (find-library-name): Correctly find "f.el.gz" from "f.elc" or "f.elc.gz".
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47447
diff changeset
147 (if (string-match "\\.el\\(c\\(\\..*\\)?\\)\\'" library)
8a24f7edde82 (find-library-name): Correctly find "f.el.gz" from "f.elc" or "f.elc.gz".
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47447
diff changeset
148 (setq library (replace-match "" t t library)))
47345
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
149 (or (locate-file library
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
150 (or find-function-source-path load-path)
47447
85021da80289 (find-library-name): Typo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47446
diff changeset
151 (append (find-library-suffixes) '("")))
47446
8bd5dd6cc381 (find-library-name): Don't forget the empty suffix. Fix stale variable name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47345
diff changeset
152 (error "Can't find library %s" library)))
47345
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
153
55231
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
154 (defvar find-function-C-source-directory
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
155 (let ((dir (expand-file-name "src" source-directory)))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
156 (when (and (file-directory-p dir) (file-readable-p dir))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
157 dir))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
158 "Directory where the C source files of Emacs can be found.
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
159 If nil, do not try to find the source code of functions and variables
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
160 defined in C.")
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
161
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
162 (defun find-function-C-source (fun-or-var file type)
55231
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
163 "Find the source location where SUBR-OR-VAR is defined in FILE.
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
164 TYPE should be nil to find a function, or `defvar' to find a variable."
55231
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
165 (unless find-function-C-source-directory
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
166 (setq find-function-C-source-directory
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
167 (read-directory-name "Emacs C source dir: " nil nil t)))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
168 (setq file (expand-file-name file find-function-C-source-directory))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
169 (unless (file-readable-p file)
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
170 (error "The C source file %s is not available"
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
171 (file-name-nondirectory file)))
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
172 (unless type
55231
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
173 (setq fun-or-var (indirect-function fun-or-var)))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
174 (with-current-buffer (find-file-noselect file)
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
175 (goto-char (point-min))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
176 (unless (re-search-forward
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
177 (if type
55231
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
178 (concat "DEFVAR[A-Z_]*[ \t\n]*([ \t\n]*\""
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
179 (regexp-quote (symbol-name fun-or-var))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
180 "\"")
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
181 (concat "DEFUN[ \t\n]*([ \t\n]*\""
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
182 (regexp-quote (subr-name fun-or-var))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
183 "\""))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
184 nil t)
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
185 (error "Can't find source for %s" fun-or-var))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
186 (cons (current-buffer) (match-beginning 0))))
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
187
47345
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
188 ;;;###autoload
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
189 (defun find-library (library)
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
190 "Find the elisp source of LIBRARY."
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
191 (interactive
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
192 (list
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
193 (completing-read "Library name: "
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
194 'locate-file-completion
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
195 (cons (or find-function-source-path load-path)
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
196 (find-library-suffixes)))))
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
197 (let ((buf (find-file-noselect (find-library-name library))))
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
198 (condition-case nil (switch-to-buffer buf) (error (pop-to-buffer buf)))))
8268e926d8e9 (find-library-suffixes, find-library-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47298
diff changeset
199
45190
9c3195b605f7 (find-function-search-for-symbol): Add autoload cookie.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45150
diff changeset
200 ;;;###autoload
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
201 (defun find-function-search-for-symbol (symbol type library)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
202 "Search for SYMBOL's definition of type TYPE in LIBRARY.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
203 If TYPE is nil, look for a function definition.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
204 Otherwise, TYPE specifies the kind of definition,
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
205 and it is interpreted via `find-function-regexp-alist'.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
206 The search is done in the source for library LIBRARY."
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
207 (if (null library)
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
208 (error "Don't know where `%s' is defined" symbol))
46874
cbd462ecc9ad (find-function-search-for-symbol): Obey `definition-name' properties.
Richard M. Stallman <rms@gnu.org>
parents: 45326
diff changeset
209 ;; Some functions are defined as part of the construct
cbd462ecc9ad (find-function-search-for-symbol): Obey `definition-name' properties.
Richard M. Stallman <rms@gnu.org>
parents: 45326
diff changeset
210 ;; that defines something else.
55231
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
211 (while (and (symbolp symbol) (get symbol 'definition-name))
46874
cbd462ecc9ad (find-function-search-for-symbol): Obey `definition-name' properties.
Richard M. Stallman <rms@gnu.org>
parents: 45326
diff changeset
212 (setq symbol (get symbol 'definition-name)))
55231
7fc34677dcb8 (find-function-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
213 (if (string-match "\\`src/\\(.*\\.c\\)\\'" library)
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
214 (find-function-C-source symbol (match-string 1 library) type)
23862
d0e08cc0aa3d (find-function-search-for-symbol):
Dave Love <fx@gnu.org>
parents: 23737
diff changeset
215 (if (string-match "\\.el\\(c\\)\\'" library)
d0e08cc0aa3d (find-function-search-for-symbol):
Dave Love <fx@gnu.org>
parents: 23737
diff changeset
216 (setq library (substring library 0 (match-beginning 1))))
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
217 (let* ((filename (find-library-name library))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
218 (regexp-symbol (cdr (assq type find-function-regexp-alist))))
23862
d0e08cc0aa3d (find-function-search-for-symbol):
Dave Love <fx@gnu.org>
parents: 23737
diff changeset
219 (with-current-buffer (find-file-noselect filename)
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
220 (let ((regexp (format (symbol-value regexp-symbol)
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
221 (regexp-quote (symbol-name symbol))))
45120
254bce531056 (find-function-search-for-symbol): Bind case-fold-search when searching.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 40480
diff changeset
222 (case-fold-search))
45150
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
223 (with-syntax-table emacs-lisp-mode-syntax-table
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
224 (goto-char (point-min))
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
225 (if (or (re-search-forward regexp nil t)
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
226 (re-search-forward
45326
892ea515fb3a (find-function-search-for-symbol): Find funs defined with defun-cvs-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45257
diff changeset
227 (concat "^([^ ]+" find-function-space-re "['(]"
45150
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
228 (regexp-quote (symbol-name symbol))
58261
212733e53508 (find-function-regexp): Optimize `define-minor-mode'. Add `defun-cvs-mode'.
Juri Linkov <juri@jurta.org>
parents: 55231
diff changeset
229 "\\_>")
45150
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
230 nil t))
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
231 (progn
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
232 (beginning-of-line)
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
233 (cons (current-buffer) (point)))
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
234 (error "Cannot find definition of `%s' in library `%s'"
4a2bcce6b13a (find-function-search-for-symbol): Use with-syntax-table.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 45120
diff changeset
235 symbol library))))))))
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
236
22851
2c2eb47ec8e3 (find-function-noselect): Autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 22759
diff changeset
237 ;;;###autoload
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
238 (defun find-function-noselect (function)
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
239 "Return a pair (BUFFER . POINT) pointing to the definition of FUNCTION.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
240
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
241 Finds the Emacs Lisp library containing the definition of FUNCTION
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
242 in a buffer and the point of the definition. The buffer is
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
243 not selected.
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
244
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
245 If the file where FUNCTION is defined is not known, then it is
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
246 searched for in `find-function-source-path' if non nil, otherwise
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
247 in `load-path'."
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
248 (if (not function)
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
249 (error "You didn't specify a function"))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
250 (let ((def (symbol-function function))
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
251 aliases)
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
252 (while (symbolp def)
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
253 (or (eq def function)
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
254 (if aliases
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
255 (setq aliases (concat aliases
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
256 (format ", which is an alias for `%s'"
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
257 (symbol-name def))))
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
258 (setq aliases (format "`%s' an alias for `%s'"
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
259 function (symbol-name def)))))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
260 (setq function (symbol-function function)
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
261 def (symbol-function function)))
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
262 (if aliases
65590
c45ae2a74f0f message format spec fixes, commit # 9
Deepak Goel <deego@gnufans.org>
parents: 64751
diff changeset
263 (message "%s" aliases))
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
264 (let ((library
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
265 (cond ((eq (car-safe def) 'autoload)
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
266 (nth 1 def))
62908
af6dffb5d180 * emacs-lisp/find-func.el (find-function-noselect): Handle
Masatake YAMATO <jet@gyve.org>
parents: 60628
diff changeset
267 ((subrp def)
af6dffb5d180 * emacs-lisp/find-func.el (find-function-noselect): Handle
Masatake YAMATO <jet@gyve.org>
parents: 60628
diff changeset
268 (help-C-file-name def 'subr))
59122
9b98188d56ae (find-function-noselect): Call symbol-file with `defun'.
Richard M. Stallman <rms@gnu.org>
parents: 58261
diff changeset
269 ((symbol-file function 'defun)))))
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
270 (find-function-search-for-symbol function nil library))))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
271
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
272 (defun find-function-read (&optional type)
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
273 "Read and return an interned symbol, defaulting to the one near point.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
274
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
275 If TYPE is nil, insist on a symbol with a function definition.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
276 Otherwise TYPE should be `defvar' or `defface'.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
277 If TYPE is nil, defaults using `function-called-at-point',
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
278 otherwise uses `variable-at-point'."
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
279 (let ((symb (if (null type)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
280 (function-called-at-point)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
281 (if (eq type 'defvar)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
282 (variable-at-point)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
283 (variable-at-point t))))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
284 (predicate (cdr (assq type '((nil . fboundp) (defvar . boundp)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
285 (defface . facep)))))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
286 (prompt (cdr (assq type '((nil . "function") (defvar . "variable")
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
287 (defface . "face")))))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
288 (enable-recursive-minibuffers t)
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
289 val)
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
290 (if (equal symb 0)
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
291 (setq symb nil))
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
292 (setq val (completing-read
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
293 (concat "Find "
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
294 prompt
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
295 (if symb
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
296 (format " (default %s)" symb))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
297 ": ")
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
298 obarray predicate t nil))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
299 (list (if (equal val "")
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
300 symb
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
301 (intern val)))))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
302
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
303 (defun find-function-do-it (symbol type switch-fn)
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
304 "Find Emacs Lisp SYMBOL in a buffer and display it.
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
305 TYPE is nil to search for a function definition,
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
306 or else `defvar' or `defface'.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
307
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
308 The variable `find-function-recenter-line' controls how
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
309 to recenter the display. SWITCH-FN is the function to call
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
310 to display and select the buffer.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
311 See also `find-function-after-hook'.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
312
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
313 Set mark before moving, if the buffer already existed."
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
314 (let* ((orig-point (point))
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
315 (orig-buf (window-buffer))
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
316 (orig-buffers (buffer-list))
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
317 (buffer-point (save-excursion
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
318 (find-definition-noselect symbol type)))
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
319 (new-buf (car buffer-point))
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
320 (new-point (cdr buffer-point)))
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
321 (when buffer-point
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
322 (when (memq new-buf orig-buffers)
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
323 (push-mark orig-point))
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
324 (funcall switch-fn new-buf)
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
325 (goto-char new-point)
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
326 (recenter find-function-recenter-line)
33198
167dad6064bf (find-function-do-it): Quote the hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33155
diff changeset
327 (run-hooks 'find-function-after-hook))))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
328
20184
c8d4024e07de (find-function, find-function-other-window, find-function-other-frame,
Dave Love <fx@gnu.org>
parents: 20183
diff changeset
329 ;;;###autoload
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
330 (defun find-function (function)
24021
a937ab82e54f More doc fixes.
Dave Love <fx@gnu.org>
parents: 24013
diff changeset
331 "Find the definition of the FUNCTION near point.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
332
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
333 Finds the Emacs Lisp library containing the definition of the function
59377
b9540957b07c (find-variable, find-variable-other-window, find-variable-other-frame):
Richard M. Stallman <rms@gnu.org>
parents: 59367
diff changeset
334 near point (selected by `function-called-at-point') in a buffer and
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
335 places point before the definition.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
336 Set mark before moving, if the buffer already existed.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
337
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
338 The library where FUNCTION is defined is searched for in
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
339 `find-function-source-path', if non nil, otherwise in `load-path'.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
340 See also `find-function-recenter-line' and `find-function-after-hook'."
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
341 (interactive (find-function-read))
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
342 (find-function-do-it function nil 'switch-to-buffer))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
343
20184
c8d4024e07de (find-function, find-function-other-window, find-function-other-frame,
Dave Love <fx@gnu.org>
parents: 20183
diff changeset
344 ;;;###autoload
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
345 (defun find-function-other-window (function)
24021
a937ab82e54f More doc fixes.
Dave Love <fx@gnu.org>
parents: 24013
diff changeset
346 "Find, in another window, the definition of FUNCTION near point.
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
347
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
348 See `find-function' for more details."
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
349 (interactive (find-function-read))
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
350 (find-function-do-it function nil 'switch-to-buffer-other-window))
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
351
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
352 ;;;###autoload
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
353 (defun find-function-other-frame (function)
24021
a937ab82e54f More doc fixes.
Dave Love <fx@gnu.org>
parents: 24013
diff changeset
354 "Find, in ananother frame, the definition of FUNCTION near point.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
355
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
356 See `find-function' for more details."
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
357 (interactive (find-function-read))
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
358 (find-function-do-it function nil 'switch-to-buffer-other-frame))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
359
23659
e221aa952b5b (find-variable-noselect): Autoload.
Karl Heuer <kwzh@gnu.org>
parents: 23287
diff changeset
360 ;;;###autoload
40480
5ebd79883369 (find-function-search-for-symbol):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38557
diff changeset
361 (defun find-variable-noselect (variable &optional file)
5ebd79883369 (find-function-search-for-symbol):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38557
diff changeset
362 "Return a pair `(BUFFER . POINT)' pointing to the definition of SYMBOL.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
363
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
364 Finds the Emacs Lisp library containing the definition of SYMBOL
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
365 in a buffer, and the point of the definition. It does not switch
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
366 to the buffer or display it.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
367
40480
5ebd79883369 (find-function-search-for-symbol):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38557
diff changeset
368 The library where VARIABLE is defined is searched for in FILE or
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
369 `find-function-source-path', if non nil, otherwise in `load-path'."
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
370 (if (not variable)
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
371 (error "You didn't specify a variable"))
59122
9b98188d56ae (find-function-noselect): Call symbol-file with `defun'.
Richard M. Stallman <rms@gnu.org>
parents: 58261
diff changeset
372 (let ((library (or file (symbol-file variable 'defvar))))
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
373 (find-function-search-for-symbol variable 'defvar library)))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
374
20184
c8d4024e07de (find-function, find-function-other-window, find-function-other-frame,
Dave Love <fx@gnu.org>
parents: 20183
diff changeset
375 ;;;###autoload
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
376 (defun find-variable (variable)
24021
a937ab82e54f More doc fixes.
Dave Love <fx@gnu.org>
parents: 24013
diff changeset
377 "Find the definition of the VARIABLE near point.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
378
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
379 Finds the Emacs Lisp library containing the definition of the variable
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
380 near point (selected by `variable-at-point') in a buffer and
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
381 places point before the definition.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
382
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
383 Set mark before moving, if the buffer already existed.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
384
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
385 The library where VARIABLE is defined is searched for in
24013
2f040734bd5f Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 23862
diff changeset
386 `find-function-source-path', if non nil, otherwise in `load-path'.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
387 See also `find-function-recenter-line' and `find-function-after-hook'."
59377
b9540957b07c (find-variable, find-variable-other-window, find-variable-other-frame):
Richard M. Stallman <rms@gnu.org>
parents: 59367
diff changeset
388 (interactive (find-function-read 'defvar))
b9540957b07c (find-variable, find-variable-other-window, find-variable-other-frame):
Richard M. Stallman <rms@gnu.org>
parents: 59367
diff changeset
389 (find-function-do-it variable 'defvar 'switch-to-buffer))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
390
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
391 ;;;###autoload
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
392 (defun find-variable-other-window (variable)
24021
a937ab82e54f More doc fixes.
Dave Love <fx@gnu.org>
parents: 24013
diff changeset
393 "Find, in another window, the definition of VARIABLE near point.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
394
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
395 See `find-variable' for more details."
59377
b9540957b07c (find-variable, find-variable-other-window, find-variable-other-frame):
Richard M. Stallman <rms@gnu.org>
parents: 59367
diff changeset
396 (interactive (find-function-read 'defvar))
b9540957b07c (find-variable, find-variable-other-window, find-variable-other-frame):
Richard M. Stallman <rms@gnu.org>
parents: 59367
diff changeset
397 (find-function-do-it variable 'defvar 'switch-to-buffer-other-window))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
398
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
399 ;;;###autoload
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
400 (defun find-variable-other-frame (variable)
24021
a937ab82e54f More doc fixes.
Dave Love <fx@gnu.org>
parents: 24013
diff changeset
401 "Find, in annother frame, the definition of VARIABLE near point.
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
402
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
403 See `find-variable' for more details."
59377
b9540957b07c (find-variable, find-variable-other-window, find-variable-other-frame):
Richard M. Stallman <rms@gnu.org>
parents: 59367
diff changeset
404 (interactive (find-function-read 'defvar))
b9540957b07c (find-variable, find-variable-other-window, find-variable-other-frame):
Richard M. Stallman <rms@gnu.org>
parents: 59367
diff changeset
405 (find-function-do-it variable 'defvar 'switch-to-buffer-other-frame))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
406
20184
c8d4024e07de (find-function, find-function-other-window, find-function-other-frame,
Dave Love <fx@gnu.org>
parents: 20183
diff changeset
407 ;;;###autoload
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
408 (defun find-definition-noselect (symbol type &optional file)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
409 "Return a pair `(BUFFER . POINT)' pointing to the definition of SYMBOL.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
410 TYPE says what type of definition: nil for a function,
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
411 `defvar' or `defface' for a variable or face. This functoin
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
412 does not switch to the buffer or display it.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
413
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
414 The library where SYMBOL is defined is searched for in FILE or
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
415 `find-function-source-path', if non nil, otherwise in `load-path'."
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
416 (if (not symbol)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
417 (error "You didn't specify a symbol"))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
418 (if (null type)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
419 (find-function-noselect symbol)
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
420 (let ((library (or file (symbol-file symbol type))))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
421 (find-function-search-for-symbol symbol type library))))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
422
59404
f737c7344fc4 (find-face-definition): Renamed from find-face.
Richard M. Stallman <rms@gnu.org>
parents: 59377
diff changeset
423 ;; For symmetry, this should be called find-face; but some programs
f737c7344fc4 (find-face-definition): Renamed from find-face.
Richard M. Stallman <rms@gnu.org>
parents: 59377
diff changeset
424 ;; assume that, if that name is defined, it means something else.
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
425 ;;;###autoload
59404
f737c7344fc4 (find-face-definition): Renamed from find-face.
Richard M. Stallman <rms@gnu.org>
parents: 59377
diff changeset
426 (defun find-face-definition (face)
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
427 "Find the definition of FACE. FACE defaults to the name near point.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
428
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
429 Finds the Emacs Lisp library containing the definition of the face
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
430 near point (selected by `variable-at-point') in a buffer and
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
431 places point before the definition.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
432
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
433 Set mark before moving, if the buffer already existed.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
434
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
435 The library where FACE is defined is searched for in
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
436 `find-function-source-path', if non nil, otherwise in `load-path'.
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
437 See also `find-function-recenter-line' and `find-function-after-hook'."
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
438 (interactive (find-function-read 'defface))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
439 (find-function-do-it face 'defface 'switch-to-buffer))
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
440
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
441 ;;;###autoload
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
442 (defun find-function-on-key (key)
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
443 "Find the function that KEY invokes. KEY is a string.
59367
3827f56f03b6 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 59330
diff changeset
444 Set mark before moving, if the buffer already existed."
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
445 (interactive "kFind function on key: ")
51097
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
446 (let (defn)
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
447 (save-excursion
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
448 (let* ((event (and (eventp key) (aref key 0))) ; Null event OK below.
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
449 (start (event-start event))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
450 (modifiers (event-modifiers event))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
451 (window (and (or (memq 'click modifiers) (memq 'down modifiers)
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
452 (memq 'drag modifiers))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
453 (posn-window start))))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
454 ;; For a mouse button event, go to the button it applies to
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
455 ;; to get the right key bindings. And go to the right place
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
456 ;; in case the keymap depends on where you clicked.
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
457 (when (windowp window)
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
458 (set-buffer (window-buffer window))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
459 (goto-char (posn-point start)))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
460 (setq defn (key-binding key))))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
461 (let ((key-desc (key-description key)))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
462 (if (or (null defn) (integerp defn))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
463 (message "%s is unbound" key-desc)
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
464 (if (consp defn)
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
465 (message "%s runs %s" key-desc (prin1-to-string defn))
37a69a2f1992 (find-function-on-key): Move the call to find-function-other-window
Richard M. Stallman <rms@gnu.org>
parents: 49598
diff changeset
466 (find-function-other-window defn))))))
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
467
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
468 ;;;###autoload
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
469 (defun find-function-at-point ()
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
470 "Find directly the function at point in the other window."
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
471 (interactive)
59377
b9540957b07c (find-variable, find-variable-other-window, find-variable-other-frame):
Richard M. Stallman <rms@gnu.org>
parents: 59367
diff changeset
472 (let ((symb (function-called-at-point)))
22641
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
473 (when symb
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
474 (find-function-other-window symb))))
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
475
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
476 ;;;###autoload
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
477 (defun find-variable-at-point ()
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
478 "Find directly the function at point in the other window."
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
479 (interactive)
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
480 (let ((symb (variable-at-point)))
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
481 (when (and symb (not (equal symb 0)))
1c5197790616 Require `loadhist'. Variable
Richard M. Stallman <rms@gnu.org>
parents: 22487
diff changeset
482 (find-variable-other-window symb))))
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
483
22759
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
484 ;;;###autoload
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
485 (defun find-function-setup-keys ()
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
486 "Define some key bindings for the find-function family of functions."
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
487 (define-key ctl-x-map "F" 'find-function)
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
488 (define-key ctl-x-4-map "F" 'find-function-other-window)
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
489 (define-key ctl-x-5-map "F" 'find-function-other-frame)
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
490 (define-key ctl-x-map "K" 'find-function-on-key)
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
491 (define-key ctl-x-map "V" 'find-variable)
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
492 (define-key ctl-x-4-map "V" 'find-variable-other-window)
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
493 (define-key ctl-x-5-map "V" 'find-variable-other-frame))
be3e1a724828 (find-function-regexp): Added :version 20.3.
Richard M. Stallman <rms@gnu.org>
parents: 22641
diff changeset
494
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
495 (provide 'find-func)
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
496
59330
03306a6707b9 (find-variable-regexp): Avoid defface.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59122
diff changeset
497 ;; arch-tag: 43ecd81c-74dc-4d9a-8f63-a61e55670d64
20183
add8b7b3a7da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
498 ;;; find-func.el ends here