Mercurial > emacs
annotate lisp/apropos.el @ 10183:7e28ad5e1042
(isearch-done): Don't print msg about mark if we don't set it.
Fix paren error.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sat, 17 Dec 1994 00:41:34 +0000 |
parents | 58037e770f67 |
children | 84c786359b07 |
rev | line source |
---|---|
662
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
1 ;;; apropos.el --- faster apropos commands. |
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
2 |
7300 | 3 ;; Copyright (C) 1989, 1994 Free Software Foundation, Inc. |
845 | 4 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
662
diff
changeset
|
5 ;; Author: Joe Wells <jbw@bigbird.bu.edu> |
2247
2c7997f249eb
Add or correct keywords
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1894
diff
changeset
|
6 ;; Keywords: help |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
662
diff
changeset
|
7 |
367 | 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 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
662
diff
changeset
|
12 ;; the Free Software Foundation; either version 2, or (at your option) |
367 | 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 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
662
diff
changeset
|
24 ;;; Commentary: |
367 | 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 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
662
diff
changeset
|
46 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
662
diff
changeset
|
47 |
367 | 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 ;;;###autoload | |
9213
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
54 (defun apropos (regexp &optional do-all pred no-header) |
367 | 55 "Show all symbols whose names contain matches for REGEXP. |
6264
f1fa434c9090
(apropos, super-apropos): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
6263
diff
changeset
|
56 If optional argument DO-ALL is non-nil (prefix argument if interactive), |
f1fa434c9090
(apropos, super-apropos): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
6263
diff
changeset
|
57 or if `apropos-do-all' is non-nil, does more (time-consuming) work such as |
367 | 58 showing key bindings. Optional argument PRED is called with each symbol, and |
59 if it returns nil, the symbol is not shown. | |
60 | |
9213
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
61 Optional argument NO-HEADER means don't print `Function:' or `Variable:' |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
62 in the output. |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
63 |
367 | 64 Returns list of symbols and documentation found." |
65 (interactive "sApropos (regexp): \nP") | |
66 (setq do-all (or apropos-do-all do-all)) | |
67 (let ((apropos-accumulate (apropos-internal regexp pred))) | |
68 (if (null apropos-accumulate) | |
69 (message "No apropos matches for `%s'" regexp) | |
70 (apropos-get-doc apropos-accumulate) | |
71 (with-output-to-temp-buffer "*Help*" | |
9213
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
72 (apropos-print-matches apropos-accumulate regexp nil |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
73 do-all no-header))) |
367 | 74 apropos-accumulate)) |
75 | |
76 ;; Takes LIST of symbols and adds documentation. Modifies LIST in place. | |
77 ;; Resulting alist is of form ((symbol fn-doc var-doc) ...). Should only be | |
78 ;; called by apropos. Returns LIST. | |
79 | |
80 (defun apropos-get-doc (list) | |
81 (let ((p list) | |
82 fn-doc var-doc symbol) | |
83 (while (consp p) | |
84 (setq symbol (car p) | |
85 fn-doc (and (fboundp symbol) | |
86 (documentation symbol)) | |
87 var-doc (documentation-property symbol 'variable-documentation) | |
88 fn-doc (and fn-doc | |
89 (substring fn-doc 0 (string-match "\n" fn-doc))) | |
90 var-doc (and var-doc | |
91 (substring var-doc 0 (string-match "\n" var-doc)))) | |
92 (setcar p (list symbol fn-doc var-doc)) | |
93 (setq p (cdr p))) | |
94 list)) | |
95 | |
96 ;;;###autoload | |
97 (defun super-apropos (regexp &optional do-all) | |
98 "Show symbols whose names/documentation contain matches for REGEXP. | |
6264
f1fa434c9090
(apropos, super-apropos): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
6263
diff
changeset
|
99 If optional argument DO-ALL is non-nil (prefix argument if interactive), |
f1fa434c9090
(apropos, super-apropos): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
6263
diff
changeset
|
100 or if `apropos-do-all' is non-nil, does more (time-consuming) work such as |
367 | 101 showing key bindings and documentation that is not stored in the documentation |
102 file. | |
103 | |
104 Returns list of symbols and documentation found." | |
105 (interactive "sSuper Apropos: \nP") | |
106 (setq do-all (or apropos-do-all do-all)) | |
107 (let (apropos-accumulate fn-doc var-doc item) | |
108 (setq apropos-accumulate (super-apropos-check-doc-file regexp)) | |
109 (if (null apropos-accumulate) | |
110 (message "No apropos matches for `%s'" regexp) | |
111 (if do-all (mapatoms 'super-apropos-accumulate)) | |
112 (with-output-to-temp-buffer "*Help*" | |
113 (apropos-print-matches apropos-accumulate nil t do-all))) | |
114 apropos-accumulate)) | |
115 | |
116 ;; Finds all documentation related to REGEXP in internal-doc-file-name. | |
117 ;; Returns an alist of form ((symbol fn-doc var-doc) ...). | |
118 | |
119 (defun super-apropos-check-doc-file (regexp) | |
6263
f2b01e6e4a1f
(super-apropos-check-doc-file): Use doc-directory instead of data-directory.
Karl Heuer <kwzh@gnu.org>
parents:
5928
diff
changeset
|
120 (let* ((doc-file (concat doc-directory internal-doc-file-name)) |
6853
581a72b47b19
(super-apropos-check-doc-file): Force Fundamental mode.
Richard M. Stallman <rms@gnu.org>
parents:
6525
diff
changeset
|
121 (doc-buffer |
581a72b47b19
(super-apropos-check-doc-file): Force Fundamental mode.
Richard M. Stallman <rms@gnu.org>
parents:
6525
diff
changeset
|
122 ;; Force fundamental mode for the DOC file. |
581a72b47b19
(super-apropos-check-doc-file): Force Fundamental mode.
Richard M. Stallman <rms@gnu.org>
parents:
6525
diff
changeset
|
123 (let (auto-mode-alist) |
581a72b47b19
(super-apropos-check-doc-file): Force Fundamental mode.
Richard M. Stallman <rms@gnu.org>
parents:
6525
diff
changeset
|
124 (find-file-noselect doc-file t))) |
367 | 125 type symbol doc sym-list) |
126 (save-excursion | |
127 (set-buffer doc-buffer) | |
128 ;; a user said he might accidentally edit the doc file | |
129 (setq buffer-read-only t) | |
130 (bury-buffer doc-buffer) | |
131 (goto-char (point-min)) | |
132 (while (re-search-forward regexp nil t) | |
133 (search-backward "\C-_") | |
134 (setq type (if (eq ?F (char-after (1+ (point)))) | |
135 1 ;function documentation | |
136 2) ;variable documentation | |
137 symbol (progn | |
138 (forward-char 2) | |
139 (read doc-buffer)) | |
140 doc (buffer-substring | |
141 (point) | |
142 (progn | |
143 (if (search-forward "\C-_" nil 'move) | |
144 (1- (point)) | |
145 (point)))) | |
146 item (assq symbol sym-list)) | |
5366
9fb443ed4acf
(super-apropos-check-doc-file): Verify that the doc
Richard M. Stallman <rms@gnu.org>
parents:
5297
diff
changeset
|
147 (and (if (= type 1) |
5928
0a2c25c9400c
(super-apropos-check-doc-file): Don't attempt to retrieve function
Karl Heuer <kwzh@gnu.org>
parents:
5366
diff
changeset
|
148 (and (fboundp symbol) (documentation symbol)) |
5366
9fb443ed4acf
(super-apropos-check-doc-file): Verify that the doc
Richard M. Stallman <rms@gnu.org>
parents:
5297
diff
changeset
|
149 (documentation-property symbol 'variable-documentation)) |
9fb443ed4acf
(super-apropos-check-doc-file): Verify that the doc
Richard M. Stallman <rms@gnu.org>
parents:
5297
diff
changeset
|
150 (or item |
9fb443ed4acf
(super-apropos-check-doc-file): Verify that the doc
Richard M. Stallman <rms@gnu.org>
parents:
5297
diff
changeset
|
151 (setq item (list symbol nil nil) |
9fb443ed4acf
(super-apropos-check-doc-file): Verify that the doc
Richard M. Stallman <rms@gnu.org>
parents:
5297
diff
changeset
|
152 sym-list (cons item sym-list))) |
9fb443ed4acf
(super-apropos-check-doc-file): Verify that the doc
Richard M. Stallman <rms@gnu.org>
parents:
5297
diff
changeset
|
153 (setcar (nthcdr type item) doc)))) |
367 | 154 sym-list)) |
155 | |
156 ;; This is passed as the argument to map-atoms, so it is called once for every | |
157 ;; symbol in obarray. Takes one argument SYMBOL, and finds any memory-resident | |
158 ;; documentation on that symbol if it matches a variable regexp. WARNING: this | |
159 ;; function depends on the symbols fn-doc var-doc regexp and item being bound | |
160 ;; correctly when it is called!" | |
161 | |
162 (defun super-apropos-accumulate (symbol) | |
163 (cond ((string-match regexp (symbol-name symbol)) | |
164 (setq item (apropos-get-accum-item symbol)) | |
165 (setcar (cdr item) (or (safe-documentation symbol) | |
166 (nth 1 item))) | |
167 (setcar (nthcdr 2 item) (or (safe-documentation-property symbol) | |
168 (nth 2 item)))) | |
169 (t | |
170 (and (setq fn-doc (safe-documentation symbol)) | |
171 (string-match regexp fn-doc) | |
172 (setcar (cdr (apropos-get-accum-item symbol)) fn-doc)) | |
173 (and (setq var-doc (safe-documentation-property symbol)) | |
174 (string-match regexp var-doc) | |
175 (setcar (nthcdr 2 (apropos-get-accum-item symbol)) var-doc)))) | |
176 nil) | |
177 | |
178 ;; Prints the symbols and documentation in alist MATCHES of form ((symbol | |
179 ;; fn-doc var-doc) ...). Uses optional argument REGEXP to speed up searching | |
180 ;; for keybindings. The names of all symbols in MATCHES must match REGEXP. | |
181 ;; Displays in the buffer pointed to by standard-output. Optional argument | |
182 ;; SPACING means put blank lines in between each symbol's documentation. | |
183 ;; Optional argument DO-ALL means do more time-consuming work, specifically, | |
184 ;; consulting key bindings. Should only be called within a | |
185 ;; with-output-to-temp-buffer. | |
186 | |
9213
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
187 (defun apropos-print-matches (matches &optional regexp |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
188 spacing do-all no-header) |
367 | 189 (setq matches (sort matches (function |
190 (lambda (a b) | |
191 (string-lessp (car a) (car b)))))) | |
192 (let ((p matches) | |
193 (old-buffer (current-buffer)) | |
2946
1f24ead69a2f
(apropos-print-matches): Bind tem.
Richard M. Stallman <rms@gnu.org>
parents:
2937
diff
changeset
|
194 item keys-done symbol tem) |
367 | 195 (save-excursion |
196 (set-buffer standard-output) | |
197 (or matches (princ "No matches found.")) | |
198 (while (consp p) | |
199 (setq item (car p) | |
200 symbol (car item) | |
201 p (cdr p)) | |
202 (or (not spacing) (bobp) (terpri)) | |
203 (princ symbol) ;print symbol name | |
204 ;; don't calculate key-bindings unless needed | |
205 (cond ((and do-all (commandp symbol) (not keys-done)) | |
206 (save-excursion | |
207 (set-buffer old-buffer) | |
208 (apropos-match-keys matches regexp)) | |
209 (setq keys-done t))) | |
210 (cond ((and do-all | |
211 (or (setq tem (nthcdr 3 item)) | |
212 (commandp symbol))) | |
213 (indent-to 30 1) | |
214 (if tem | |
215 (princ (mapconcat 'key-description tem ", ")) | |
216 (princ "(not bound to any keys)")))) | |
217 (terpri) | |
218 (cond ((setq tem (nth 1 item)) | |
9213
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
219 (let ((substed (if do-all (substitute-command-keys tem) tem))) |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
220 (if no-header |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
221 (princ " ") |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
222 (princ " Function: ") |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
223 (if (> (length substed) 67) |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
224 (princ "\n "))) |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
225 (princ substed)))) |
367 | 226 (or (bolp) (terpri)) |
227 (cond ((setq tem (nth 2 item)) | |
9213
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
228 (let ((substed (if do-all (substitute-command-keys tem) tem))) |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
229 (if no-header |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
230 (princ " ") |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
231 (princ " Variable: ") |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
232 (if (> (length substed) 67) |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
233 (princ "\n "))) |
177bb6670a97
(apropos-print-matches): Add newline after
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
234 (princ substed)))) |
9860
49a20a98c276
(apropos-print-matches): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9213
diff
changeset
|
235 (or (bolp) (terpri))) |
49a20a98c276
(apropos-print-matches): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9213
diff
changeset
|
236 (help-mode))) |
367 | 237 t) |
238 | |
239 ;; Find key bindings for symbols that are cars in ALIST. Optionally, first | |
240 ;; match the symbol name against REGEXP. Modifies ALIST in place. Each key | |
241 ;; binding is added as a string to the end of the list in ALIST whose car is | |
242 ;; the corresponding symbol. The pointer to ALIST is returned. | |
243 | |
244 (defun apropos-match-keys (alist &optional regexp) | |
245 (let* ((current-local-map (current-local-map)) | |
10162
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
246 ;; Get a list of the top-level maps now active. |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
247 (top-maps |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
248 (if overriding-local-map |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
249 (list overriding-local-map (current-global-map)) |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
250 (append (current-minor-mode-maps) |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
251 (if current-local-map |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
252 (list current-local-map (current-global-map)) |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
253 (list (current-global-map)))))) |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
254 ;; Turn that into a list of all the maps including submaps. |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
255 (maps (apply 'append (mapcar 'accessible-keymaps top-maps))) |
367 | 256 map ;map we are now inspecting |
257 sequence ;key sequence to reach map | |
258 i ;index into vector map | |
259 command ;what is bound to current keys | |
260 key ;last key to reach command | |
261 local ;local binding for sequence + key | |
262 item) ;symbol data item in alist | |
263 ;; examine all reachable keymaps | |
264 (while (consp maps) | |
265 (setq map (cdr (car maps)) | |
266 sequence (car (car maps)) ;keys to reach this map | |
267 maps (cdr maps)) | |
2937
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
268 ;; Skip the leading `keymap', doc string, etc. |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
269 (if (eq (car map) 'keymap) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
270 (setq map (cdr map))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
271 (while (stringp (car-safe map)) |
367 | 272 (setq map (cdr map))) |
10162
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
273 |
2937
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
274 (while (consp map) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
275 (cond ((consp (car map)) |
367 | 276 (setq command (cdr (car map)) |
2937
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
277 key (car (car map))) |
10162
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
278 ;; Skip any menu prompt and help string in this key binding. |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
279 (while (and (consp command) (stringp (car command))) |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
280 (setq command (cdr command))) |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
281 ;; Skip any cached equivalent key. |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
282 (and (consp command) |
58037e770f67
(apropos-match-keys): Handle menu bindings with cached equivalent keys.
Richard M. Stallman <rms@gnu.org>
parents:
9860
diff
changeset
|
283 (consp (car command)) |
2937
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
284 (setq command (cdr command))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
285 ;; if is a symbol, and matches optional regexp, and is a car |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
286 ;; in alist, and is not shadowed by a different local binding, |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
287 ;; record it |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
288 (and (symbolp command) |
5297
969ebd50eb72
(apropos-match-keys): If REGEXP is nil, always act as if it matched.
Richard M. Stallman <rms@gnu.org>
parents:
3563
diff
changeset
|
289 (if regexp |
969ebd50eb72
(apropos-match-keys): If REGEXP is nil, always act as if it matched.
Richard M. Stallman <rms@gnu.org>
parents:
3563
diff
changeset
|
290 (string-match regexp (symbol-name command)) |
969ebd50eb72
(apropos-match-keys): If REGEXP is nil, always act as if it matched.
Richard M. Stallman <rms@gnu.org>
parents:
3563
diff
changeset
|
291 t) |
2937
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
292 (setq item (assq command alist)) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
293 (if (or (vectorp sequence) (not (integerp key))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
294 (setq key (vconcat sequence (vector key))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
295 (setq key (concat sequence (char-to-string key)))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
296 ;; checking if shadowed by local binding. |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
297 ;; either no local map, no local binding, or runs off the |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
298 ;; binding tree (number), or is the same binding |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
299 (or (not current-local-map) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
300 (not (setq local (lookup-key current-local-map key))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
301 (numberp local) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
302 (eq command local)) |
6525
7e1e1ccc238c
(apropos-match-keys): Skip duplicate keybindings.
Karl Heuer <kwzh@gnu.org>
parents:
6329
diff
changeset
|
303 ;; check if this binding is already recorded |
7e1e1ccc238c
(apropos-match-keys): Skip duplicate keybindings.
Karl Heuer <kwzh@gnu.org>
parents:
6329
diff
changeset
|
304 ;; (this can happen due to inherited keymaps) |
7e1e1ccc238c
(apropos-match-keys): Skip duplicate keybindings.
Karl Heuer <kwzh@gnu.org>
parents:
6329
diff
changeset
|
305 (not (member key (nthcdr 3 item))) |
2937
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
306 ;; add this key binding to the item in alist |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
307 (nconc item (cons key nil)))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
308 ((vectorp (car map)) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
309 (let ((i 0) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
310 (vec (car map)) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
311 (len (length (car map)))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
312 (while (< i len) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
313 (setq command (aref vec i)) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
314 (setq key i) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
315 ;; Skip any menu prompt in this key binding. |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
316 (and (consp command) (symbolp (cdr command)) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
317 (setq command (cdr command))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
318 ;; This is the same as the code in the previous case. |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
319 (and (symbolp command) |
5297
969ebd50eb72
(apropos-match-keys): If REGEXP is nil, always act as if it matched.
Richard M. Stallman <rms@gnu.org>
parents:
3563
diff
changeset
|
320 (if regexp |
969ebd50eb72
(apropos-match-keys): If REGEXP is nil, always act as if it matched.
Richard M. Stallman <rms@gnu.org>
parents:
3563
diff
changeset
|
321 (string-match regexp (symbol-name command)) |
969ebd50eb72
(apropos-match-keys): If REGEXP is nil, always act as if it matched.
Richard M. Stallman <rms@gnu.org>
parents:
3563
diff
changeset
|
322 t) |
2937
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
323 (setq item (assq command alist)) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
324 (if (or (vectorp sequence) (not (integerp key))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
325 (setq key (vconcat sequence (vector key))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
326 (setq key (concat sequence (char-to-string key)))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
327 ;; checking if shadowed by local binding. |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
328 ;; either no local map, no local binding, or runs off the |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
329 ;; binding tree (number), or is the same binding |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
330 (or (not current-local-map) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
331 (not (setq local (lookup-key current-local-map key))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
332 (numberp local) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
333 (eq command local)) |
6525
7e1e1ccc238c
(apropos-match-keys): Skip duplicate keybindings.
Karl Heuer <kwzh@gnu.org>
parents:
6329
diff
changeset
|
334 ;; check if this binding is already recorded |
7e1e1ccc238c
(apropos-match-keys): Skip duplicate keybindings.
Karl Heuer <kwzh@gnu.org>
parents:
6329
diff
changeset
|
335 ;; (this can happen due to inherited keymaps) |
7e1e1ccc238c
(apropos-match-keys): Skip duplicate keybindings.
Karl Heuer <kwzh@gnu.org>
parents:
6329
diff
changeset
|
336 (not (member key (nthcdr 3 item))) |
2937
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
337 ;; add this key binding to the item in alist |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
338 (nconc item (cons key nil))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
339 (setq i (1+ i)))))) |
e38ff71093b5
(apropos-match-keys): Handle modern keymap structure.
Richard M. Stallman <rms@gnu.org>
parents:
2247
diff
changeset
|
340 (setq map (cdr map))))) |
367 | 341 alist) |
342 | |
343 ;; Get an alist item in alist apropos-accumulate whose car is SYMBOL. Creates | |
344 ;; the item if not already present. Modifies apropos-accumulate in place. | |
345 | |
346 (defun apropos-get-accum-item (symbol) | |
347 (or (assq symbol apropos-accumulate) | |
348 (progn | |
349 (setq apropos-accumulate | |
350 (cons (list symbol nil nil) apropos-accumulate)) | |
351 (assq symbol apropos-accumulate)))) | |
352 | |
353 (defun safe-documentation (function) | |
354 "Like documentation, except it avoids calling `get_doc_string'. | |
355 Will return nil instead." | |
356 (while (symbolp function) | |
357 (setq function (if (fboundp function) | |
358 (symbol-function function) | |
359 0))) | |
3563
804e4f30b7ce
(safe-documentation): Don't crash on byte-compiled macro.
Richard M. Stallman <rms@gnu.org>
parents:
2946
diff
changeset
|
360 (if (eq (car-safe function) 'macro) |
804e4f30b7ce
(safe-documentation): Don't crash on byte-compiled macro.
Richard M. Stallman <rms@gnu.org>
parents:
2946
diff
changeset
|
361 (setq function (cdr function))) |
367 | 362 (if (not (consp function)) |
363 nil | |
364 (if (not (memq (car function) '(lambda autoload))) | |
365 nil | |
366 (setq function (nth 2 function)) | |
367 (if (stringp function) | |
368 function | |
369 nil)))) | |
370 | |
371 (defun safe-documentation-property (symbol) | |
372 "Like documentation-property, except it avoids calling `get_doc_string'. | |
373 Will return nil instead." | |
374 (setq symbol (get symbol 'variable-documentation)) | |
375 (if (numberp symbol) | |
376 nil | |
377 symbol)) | |
378 | |
662
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
379 ;;; apropos.el ends here |