Commit | Line | Data |
---|---|---|
c0274f38 ER |
1 | ;;; apropos.el --- faster apropos commands. |
2 | ||
9750e079 ER |
3 | ;; Copyright (C) 1989 Free Software Foundation, Inc. |
4 | ||
e5167999 | 5 | ;; Author: Joe Wells <jbw@bigbird.bu.edu> |
e9571d2a | 6 | ;; Keywords: help |
e5167999 | 7 | |
6f8e447f RS |
8 | ;; This file is part of GNU Emacs. |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
e5167999 | 12 | ;; the Free Software Foundation; either version 2, or (at your option) |
6f8e447f RS |
13 | ;; any later version. |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to | |
22 | ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
23 | ||
e5167999 | 24 | ;;; Commentary: |
6f8e447f RS |
25 | |
26 | ;; The ideas for this package were derived from the C code in | |
27 | ;; src/keymap.c and elsewhere. The functions in this file should | |
28 | ;; always be byte-compiled for speed. Someone should rewrite this in | |
29 | ;; C (as part of src/keymap.c) for speed. | |
30 | ||
31 | ;; The idea for super-apropos is based on the original implementation | |
32 | ;; by Lynn Slater <lrs@esl.com>. | |
33 | ||
34 | ;; History: | |
35 | ;; Fixed bug, current-local-map can return nil. | |
36 | ;; Change, doesn't calculate key-bindings unless needed. | |
37 | ;; Added super-apropos capability, changed print functions. | |
38 | ;; Made fast-apropos and super-apropos share code. | |
39 | ;; Sped up fast-apropos again. | |
40 | ;; Added apropos-do-all option. | |
41 | ;; Added fast-command-apropos. | |
42 | ;; Changed doc strings to comments for helping functions. | |
43 | ;; Made doc file buffer read-only, buried it. | |
44 | ;; Only call substitute-command-keys if do-all set. | |
45 | ||
e5167999 ER |
46 | ;;; Code: |
47 | ||
6f8e447f RS |
48 | (defvar apropos-do-all nil |
49 | "*Whether `apropos' and `super-apropos' should do everything that they can. | |
50 | Makes them run 2 or 3 times slower. Set this non-nil if you have a fast | |
51 | machine.") | |
52 | ||
53 | ;; If there isn't already a lisp variable named internal-doc-file-name, create | |
54 | ;; it and document it. This is so the code will work right after RMS adds | |
55 | ;; internal-doc-file-name. | |
56 | ;(or (boundp 'internal-doc-file-name) | |
1e6dacf6 | 57 | ; (setq internal-doc-file-name (concat data-directory "DOC"))) |
6f8e447f RS |
58 | ;(or (documentation-property 'internal-doc-file-name 'variable-documentation) |
59 | ; (put 'internal-doc-file-name 'variable-documentation | |
60 | ; "The complete pathname of the documentation file that contains all | |
61 | ;documentation for functions and variables defined before Emacs is dumped.")) | |
62 | ||
63 | ;;;###autoload | |
64 | (defun apropos (regexp &optional do-all pred) | |
65 | "Show all symbols whose names contain matches for REGEXP. | |
66 | If optional argument DO-ALL is non-nil, does more (time-consuming) work such as | |
67 | showing key bindings. Optional argument PRED is called with each symbol, and | |
68 | if it returns nil, the symbol is not shown. | |
69 | ||
70 | Returns list of symbols and documentation found." | |
71 | (interactive "sApropos (regexp): \nP") | |
72 | (setq do-all (or apropos-do-all do-all)) | |
73 | (let ((apropos-accumulate (apropos-internal regexp pred))) | |
74 | (if (null apropos-accumulate) | |
75 | (message "No apropos matches for `%s'" regexp) | |
76 | (apropos-get-doc apropos-accumulate) | |
77 | (with-output-to-temp-buffer "*Help*" | |
78 | (apropos-print-matches apropos-accumulate regexp nil do-all))) | |
79 | apropos-accumulate)) | |
80 | ||
81 | ;; If "C-h a" still has its original binding of command-apropos, change it to | |
82 | ;; use fast-command-apropos. I don't use substitute-key-definition because | |
83 | ;; it's slow. | |
84 | ;(if (eq 'command-apropos (lookup-key help-map "a")) | |
85 | ; (define-key help-map "a" 'fast-command-apropos)) | |
86 | ||
87 | ;; Takes LIST of symbols and adds documentation. Modifies LIST in place. | |
88 | ;; Resulting alist is of form ((symbol fn-doc var-doc) ...). Should only be | |
89 | ;; called by apropos. Returns LIST. | |
90 | ||
91 | (defun apropos-get-doc (list) | |
92 | (let ((p list) | |
93 | fn-doc var-doc symbol) | |
94 | (while (consp p) | |
95 | (setq symbol (car p) | |
96 | fn-doc (and (fboundp symbol) | |
97 | (documentation symbol)) | |
98 | var-doc (documentation-property symbol 'variable-documentation) | |
99 | fn-doc (and fn-doc | |
100 | (substring fn-doc 0 (string-match "\n" fn-doc))) | |
101 | var-doc (and var-doc | |
102 | (substring var-doc 0 (string-match "\n" var-doc)))) | |
103 | (setcar p (list symbol fn-doc var-doc)) | |
104 | (setq p (cdr p))) | |
105 | list)) | |
106 | ||
107 | ;;;###autoload | |
108 | (defun super-apropos (regexp &optional do-all) | |
109 | "Show symbols whose names/documentation contain matches for REGEXP. | |
110 | If optional argument DO-ALL is non-nil, does more (time-consuming) work such as | |
111 | showing key bindings and documentation that is not stored in the documentation | |
112 | file. | |
113 | ||
114 | Returns list of symbols and documentation found." | |
115 | (interactive "sSuper Apropos: \nP") | |
116 | (setq do-all (or apropos-do-all do-all)) | |
117 | (let (apropos-accumulate fn-doc var-doc item) | |
118 | (setq apropos-accumulate (super-apropos-check-doc-file regexp)) | |
119 | (if (null apropos-accumulate) | |
120 | (message "No apropos matches for `%s'" regexp) | |
121 | (if do-all (mapatoms 'super-apropos-accumulate)) | |
122 | (with-output-to-temp-buffer "*Help*" | |
123 | (apropos-print-matches apropos-accumulate nil t do-all))) | |
124 | apropos-accumulate)) | |
125 | ||
126 | ;; Finds all documentation related to REGEXP in internal-doc-file-name. | |
127 | ;; Returns an alist of form ((symbol fn-doc var-doc) ...). | |
128 | ||
129 | (defun super-apropos-check-doc-file (regexp) | |
8ada529b RS |
130 | (let* ((doc-file (concat data-directory internal-doc-file-name)) |
131 | (doc-buffer (find-file-noselect doc-file t)) | |
132 | ;; (doc-buffer (or (get-file-buffer doc-file) | |
133 | ;; (find-file-noselect doc-file))) | |
6f8e447f RS |
134 | type symbol doc sym-list) |
135 | (save-excursion | |
136 | (set-buffer doc-buffer) | |
137 | ;; a user said he might accidentally edit the doc file | |
138 | (setq buffer-read-only t) | |
139 | (bury-buffer doc-buffer) | |
140 | (goto-char (point-min)) | |
141 | (while (re-search-forward regexp nil t) | |
142 | (search-backward "\C-_") | |
143 | (setq type (if (eq ?F (char-after (1+ (point)))) | |
144 | 1 ;function documentation | |
145 | 2) ;variable documentation | |
146 | symbol (progn | |
147 | (forward-char 2) | |
148 | (read doc-buffer)) | |
149 | doc (buffer-substring | |
150 | (point) | |
151 | (progn | |
152 | (if (search-forward "\C-_" nil 'move) | |
153 | (1- (point)) | |
154 | (point)))) | |
155 | item (assq symbol sym-list)) | |
7c09e2e3 RS |
156 | (and (if (= type 1) |
157 | (documentation symbol) | |
158 | (documentation-property symbol 'variable-documentation)) | |
159 | (or item | |
160 | (setq item (list symbol nil nil) | |
161 | sym-list (cons item sym-list))) | |
162 | (setcar (nthcdr type item) doc)))) | |
6f8e447f RS |
163 | sym-list)) |
164 | ||
165 | ;; This is passed as the argument to map-atoms, so it is called once for every | |
166 | ;; symbol in obarray. Takes one argument SYMBOL, and finds any memory-resident | |
167 | ;; documentation on that symbol if it matches a variable regexp. WARNING: this | |
168 | ;; function depends on the symbols fn-doc var-doc regexp and item being bound | |
169 | ;; correctly when it is called!" | |
170 | ||
171 | (defun super-apropos-accumulate (symbol) | |
172 | (cond ((string-match regexp (symbol-name symbol)) | |
173 | (setq item (apropos-get-accum-item symbol)) | |
174 | (setcar (cdr item) (or (safe-documentation symbol) | |
175 | (nth 1 item))) | |
176 | (setcar (nthcdr 2 item) (or (safe-documentation-property symbol) | |
177 | (nth 2 item)))) | |
178 | (t | |
179 | (and (setq fn-doc (safe-documentation symbol)) | |
180 | (string-match regexp fn-doc) | |
181 | (setcar (cdr (apropos-get-accum-item symbol)) fn-doc)) | |
182 | (and (setq var-doc (safe-documentation-property symbol)) | |
183 | (string-match regexp var-doc) | |
184 | (setcar (nthcdr 2 (apropos-get-accum-item symbol)) var-doc)))) | |
185 | nil) | |
186 | ||
187 | ;; Prints the symbols and documentation in alist MATCHES of form ((symbol | |
188 | ;; fn-doc var-doc) ...). Uses optional argument REGEXP to speed up searching | |
189 | ;; for keybindings. The names of all symbols in MATCHES must match REGEXP. | |
190 | ;; Displays in the buffer pointed to by standard-output. Optional argument | |
191 | ;; SPACING means put blank lines in between each symbol's documentation. | |
192 | ;; Optional argument DO-ALL means do more time-consuming work, specifically, | |
193 | ;; consulting key bindings. Should only be called within a | |
194 | ;; with-output-to-temp-buffer. | |
195 | ||
196 | (defun apropos-print-matches (matches &optional regexp spacing do-all) | |
197 | (setq matches (sort matches (function | |
198 | (lambda (a b) | |
199 | (string-lessp (car a) (car b)))))) | |
200 | (let ((p matches) | |
201 | (old-buffer (current-buffer)) | |
2b019431 | 202 | item keys-done symbol tem) |
6f8e447f RS |
203 | (save-excursion |
204 | (set-buffer standard-output) | |
205 | (or matches (princ "No matches found.")) | |
206 | (while (consp p) | |
207 | (setq item (car p) | |
208 | symbol (car item) | |
209 | p (cdr p)) | |
210 | (or (not spacing) (bobp) (terpri)) | |
211 | (princ symbol) ;print symbol name | |
212 | ;; don't calculate key-bindings unless needed | |
213 | (cond ((and do-all (commandp symbol) (not keys-done)) | |
214 | (save-excursion | |
215 | (set-buffer old-buffer) | |
216 | (apropos-match-keys matches regexp)) | |
217 | (setq keys-done t))) | |
218 | (cond ((and do-all | |
219 | (or (setq tem (nthcdr 3 item)) | |
220 | (commandp symbol))) | |
221 | (indent-to 30 1) | |
222 | (if tem | |
223 | (princ (mapconcat 'key-description tem ", ")) | |
224 | (princ "(not bound to any keys)")))) | |
225 | (terpri) | |
226 | (cond ((setq tem (nth 1 item)) | |
227 | (princ " Function: ") | |
228 | (princ (if do-all (substitute-command-keys tem) tem)))) | |
229 | (or (bolp) (terpri)) | |
230 | (cond ((setq tem (nth 2 item)) | |
231 | (princ " Variable: ") | |
232 | (princ (if do-all (substitute-command-keys tem) tem)))) | |
233 | (or (bolp) (terpri))))) | |
234 | t) | |
235 | ||
236 | ;; Find key bindings for symbols that are cars in ALIST. Optionally, first | |
237 | ;; match the symbol name against REGEXP. Modifies ALIST in place. Each key | |
238 | ;; binding is added as a string to the end of the list in ALIST whose car is | |
239 | ;; the corresponding symbol. The pointer to ALIST is returned. | |
240 | ||
241 | (defun apropos-match-keys (alist &optional regexp) | |
242 | (let* ((current-local-map (current-local-map)) | |
243 | (maps (append (and current-local-map | |
244 | (accessible-keymaps current-local-map)) | |
245 | (accessible-keymaps (current-global-map)))) | |
246 | map ;map we are now inspecting | |
247 | sequence ;key sequence to reach map | |
248 | i ;index into vector map | |
249 | command ;what is bound to current keys | |
250 | key ;last key to reach command | |
251 | local ;local binding for sequence + key | |
252 | item) ;symbol data item in alist | |
253 | ;; examine all reachable keymaps | |
254 | (while (consp maps) | |
255 | (setq map (cdr (car maps)) | |
256 | sequence (car (car maps)) ;keys to reach this map | |
257 | maps (cdr maps)) | |
4fa88406 RS |
258 | ;; Skip the leading `keymap', doc string, etc. |
259 | (if (eq (car map) 'keymap) | |
260 | (setq map (cdr map))) | |
261 | (while (stringp (car-safe map)) | |
6f8e447f | 262 | (setq map (cdr map))) |
4fa88406 RS |
263 | (while (consp map) |
264 | (cond ((consp (car map)) | |
6f8e447f | 265 | (setq command (cdr (car map)) |
4fa88406 RS |
266 | key (car (car map))) |
267 | ;; Skip any menu prompt in this key binding. | |
268 | (and (consp command) (symbolp (cdr command)) | |
269 | (setq command (cdr command))) | |
270 | ;; if is a symbol, and matches optional regexp, and is a car | |
271 | ;; in alist, and is not shadowed by a different local binding, | |
272 | ;; record it | |
273 | (and (symbolp command) | |
12fbf178 RS |
274 | (if regexp |
275 | (string-match regexp (symbol-name command)) | |
276 | t) | |
4fa88406 RS |
277 | (setq item (assq command alist)) |
278 | (if (or (vectorp sequence) (not (integerp key))) | |
279 | (setq key (vconcat sequence (vector key))) | |
280 | (setq key (concat sequence (char-to-string key)))) | |
281 | ;; checking if shadowed by local binding. | |
282 | ;; either no local map, no local binding, or runs off the | |
283 | ;; binding tree (number), or is the same binding | |
284 | (or (not current-local-map) | |
285 | (not (setq local (lookup-key current-local-map key))) | |
286 | (numberp local) | |
287 | (eq command local)) | |
288 | ;; add this key binding to the item in alist | |
289 | (nconc item (cons key nil)))) | |
290 | ((vectorp (car map)) | |
291 | (let ((i 0) | |
292 | (vec (car map)) | |
293 | (len (length (car map)))) | |
294 | (while (< i len) | |
295 | (setq command (aref vec i)) | |
296 | (setq key i) | |
297 | ;; Skip any menu prompt in this key binding. | |
298 | (and (consp command) (symbolp (cdr command)) | |
299 | (setq command (cdr command))) | |
300 | ;; This is the same as the code in the previous case. | |
301 | (and (symbolp command) | |
12fbf178 RS |
302 | (if regexp |
303 | (string-match regexp (symbol-name command)) | |
304 | t) | |
4fa88406 RS |
305 | (setq item (assq command alist)) |
306 | (if (or (vectorp sequence) (not (integerp key))) | |
307 | (setq key (vconcat sequence (vector key))) | |
308 | (setq key (concat sequence (char-to-string key)))) | |
309 | ;; checking if shadowed by local binding. | |
310 | ;; either no local map, no local binding, or runs off the | |
311 | ;; binding tree (number), or is the same binding | |
312 | (or (not current-local-map) | |
313 | (not (setq local (lookup-key current-local-map key))) | |
314 | (numberp local) | |
315 | (eq command local)) | |
316 | ;; add this key binding to the item in alist | |
317 | (nconc item (cons key nil))) | |
318 | (setq i (1+ i)))))) | |
319 | (setq map (cdr map))))) | |
6f8e447f RS |
320 | alist) |
321 | ||
322 | ;; Get an alist item in alist apropos-accumulate whose car is SYMBOL. Creates | |
323 | ;; the item if not already present. Modifies apropos-accumulate in place. | |
324 | ||
325 | (defun apropos-get-accum-item (symbol) | |
326 | (or (assq symbol apropos-accumulate) | |
327 | (progn | |
328 | (setq apropos-accumulate | |
329 | (cons (list symbol nil nil) apropos-accumulate)) | |
330 | (assq symbol apropos-accumulate)))) | |
331 | ||
332 | (defun safe-documentation (function) | |
333 | "Like documentation, except it avoids calling `get_doc_string'. | |
334 | Will return nil instead." | |
335 | (while (symbolp function) | |
336 | (setq function (if (fboundp function) | |
337 | (symbol-function function) | |
338 | 0))) | |
d2e1218f RS |
339 | (if (eq (car-safe function) 'macro) |
340 | (setq function (cdr function))) | |
6f8e447f RS |
341 | (if (not (consp function)) |
342 | nil | |
6f8e447f RS |
343 | (if (not (memq (car function) '(lambda autoload))) |
344 | nil | |
345 | (setq function (nth 2 function)) | |
346 | (if (stringp function) | |
347 | function | |
348 | nil)))) | |
349 | ||
350 | (defun safe-documentation-property (symbol) | |
351 | "Like documentation-property, except it avoids calling `get_doc_string'. | |
352 | Will return nil instead." | |
353 | (setq symbol (get symbol 'variable-documentation)) | |
354 | (if (numberp symbol) | |
355 | nil | |
356 | symbol)) | |
357 | ||
c0274f38 | 358 | ;;; apropos.el ends here |