1 ;;; apropos.el --- apropos commands for users and programmers.
3 ;; Copyright (C) 1989, 1994, 1995 Free Software Foundation, Inc.
5 ;; Author: Joe Wells <jbw@bigbird.bu.edu>
6 ;; Rewritten: Daniel.Pfeiffer@Informatik.START.dbp.de, fax (+49 69) 7588-2389
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; The ideas for this package were derived from the C code in
29 ;; src/keymap.c and elsewhere. The functions in this file should
30 ;; always be byte-compiled for speed. Someone should rewrite this in
31 ;; C (as part of src/keymap.c) for speed.
33 ;; The idea for super-apropos is based on the original implementation
34 ;; by Lynn Slater <lrs@esl.com>.
37 ;; Fixed bug, current-local-map can return nil.
38 ;; Change, doesn't calculate key-bindings unless needed.
39 ;; Added super-apropos capability, changed print functions.
40 ;;; Made fast-apropos and super-apropos share code.
41 ;;; Sped up fast-apropos again.
42 ;; Added apropos-do-all option.
43 ;;; Added fast-command-apropos.
44 ;; Changed doc strings to comments for helping functions.
45 ;;; Made doc file buffer read-only, buried it.
46 ;; Only call substitute-command-keys if do-all set.
48 ;; Optionally use configurable faces to make the output more legible.
49 ;; Differentiate between command, function and macro.
50 ;; Apropos-command (ex command-apropos) does cmd and optionally user var.
51 ;; Apropos shows all 3 aspects of symbols (fn, var and plist)
52 ;; Apropos-documentation (ex super-apropos) now finds all it should.
53 ;; New apropos-value snoops through all values and optionally plists.
54 ;; Reading DOC file doesn't load nroff.
55 ;; Added hypertext following of documentation, mouse-2 on variable gives value
56 ;; from buffer in active window.
60 ;; I see a degradation of maybe 10-20% only.
61 (defvar apropos-do-all nil
62 "*Whether the apropos commands should do more.
63 Slows them down more or less. Set this non-nil if you have a fast machine.")
66 (defvar apropos-symbol-face
(if window-system
'bold
)
67 "*Face for symbol name in apropos output or `nil'.
68 This looks good, but slows down the commands several times.")
70 (defvar apropos-keybinding-face
(if window-system
'underline
)
71 "*Face for keybinding display in apropos output or `nil'.
72 This looks good, but slows down the commands several times.")
74 (defvar apropos-label-face
(if window-system
'italic
)
75 "*Face for label (Command, Variable ...) in apropos output or `nil'.
76 If this is `nil' no mouse highlighting occurs.
77 This looks good, but slows down the commands several times.
78 When this is a face name, as it is initially, it gets transformed to a
79 text-property list for efficiency.")
81 (defvar apropos-property-face
(if window-system
'bold-italic
)
82 "*Face for property name in apropos output or `nil'.
83 This looks good, but slows down the commands several times.")
85 (defvar apropos-match-face
(if window-system
'secondary-selection
)
86 "*Face for matching part in apropos-documentation/value output or `nil'.
87 This looks good, but slows down the commands several times.")
90 (defvar apropos-mode-map
91 (let ((map (make-sparse-keymap)))
92 (define-key map
"\C-m" 'apropos-follow
)
93 (define-key map
" " 'scroll-up
)
94 (define-key map
"\177" 'scroll-down
)
95 (define-key map
[mouse-2
] 'apropos-mouse-follow
)
96 (define-key map
[down-mouse-2
] nil
)
98 "Keymap used in Apropos mode.")
101 (defvar apropos-regexp nil
102 "Regexp used in current apropos run.")
104 (defvar apropos-files-scanned
()
105 "List of elc files already scanned in current run of `apropos-documentation'.")
107 (defvar apropos-accumulator
()
108 "Alist of symbols already found in current apropos run.")
110 (defvar apropos-item
()
111 "Current item in or for apropos-accumulator.")
113 (defun apropos-mode ()
114 "Major mode for following hyperlinks in output of apropos commands.
116 \\{apropos-mode-map}"
118 (kill-all-local-variables)
119 (use-local-map apropos-mode-map
)
120 (setq major-mode
'apropos-mode
121 mode-name
"Apropos"))
124 ;; For auld lang syne:
126 (fset 'command-apropos
'apropos-command
)
128 (defun apropos-command (apropos-regexp &optional do-all
)
129 "Shows commands (interactively callable functions) that match REGEXP.
130 With optional prefix ARG or if `apropos-do-all' is non-nil, also show
132 (interactive (list (read-string (concat "Apropos command "
133 (if (or current-prefix-arg
139 (let ((standard-output (get-buffer-create "*Apropos*")))
140 (print-help-return-message 'identity
))))
141 (or do-all
(setq do-all apropos-do-all
))
142 (setq apropos-accumulator
143 (apropos-internal apropos-regexp
145 (lambda (symbol) (or (commandp symbol
)
146 (user-variable-p symbol
)))
154 (setq symbol
(car p
))
155 (if (commandp symbol
)
156 (if (setq doc
(documentation symbol t
))
157 (substring doc
0 (string-match "\n" doc
))
160 (user-variable-p symbol
)
161 (if (setq doc
(documentation-property
162 symbol
'variable-documentation t
))
164 (string-match "\n" doc
))))))
167 (and message
(message message
)))))
171 (defun apropos (apropos-regexp &optional do-all
)
172 "Show all bound symbols whose names match REGEXP.
173 With optional prefix ARG or if `apropos-do-all' is non-nil, also show unbound
174 symbols and key bindings, which is a little more time-consuming.
175 Returns list of symbols and documentation found."
176 (interactive "sApropos symbol (regexp): \nP")
177 (setq apropos-accumulator
178 (apropos-internal apropos-regexp
185 (symbol-plist symbol
))))))
187 (or do-all apropos-do-all
)
189 (let (symbol doc properties
)
192 (setq symbol
(car p
))
193 (when (fboundp symbol
)
194 (if (setq doc
(documentation symbol t
))
195 (substring doc
0 (string-match "\n" doc
))
197 (when (boundp symbol
)
198 (if (setq doc
(documentation-property
199 symbol
'variable-documentation t
))
200 (substring doc
0 (string-match "\n" doc
))
202 (when (setq properties
(symbol-plist symbol
))
203 (setq doc
(list (car properties
)))
204 (while (setq properties
(cdr (cdr properties
)))
205 (setq doc
(cons (car properties
) doc
)))
206 (mapconcat #'symbol-name
(nreverse doc
) " "))
207 (when (get symbol
'widget-type
)
208 (if (setq doc
(documentation-property
209 symbol
'widget-documentation t
))
211 (string-match "\n" doc
))
214 (if (setq doc
(documentation-property
215 symbol
'face-documentation t
))
217 (string-match "\n" doc
))
219 (when (get symbol
'custom-group
)
220 (if (setq doc
(documentation-property
221 symbol
'group-documentation t
))
223 (string-match "\n" doc
))
224 "(not documented)"))))
230 (defun apropos-value (apropos-regexp &optional do-all
)
231 "Show all symbols whose value's printed image matches REGEXP.
232 With optional prefix ARG or if `apropos-do-all' is non-nil, also looks
233 at the function and at the names and values of properties.
234 Returns list of symbols and values found."
235 (interactive "sApropos value (regexp): \nP")
236 (or do-all
(setq do-all apropos-do-all
))
237 (setq apropos-accumulator
())
241 (setq f nil v nil p nil
)
242 (or (memq symbol
'(apropos-regexp do-all apropos-accumulator
244 (setq v
(apropos-value-internal 'boundp symbol
'symbol-value
)))
246 (setq f
(apropos-value-internal 'fboundp symbol
'symbol-function
)
247 p
(apropos-format-plist symbol
"\n " t
)))
249 (setq apropos-accumulator
(cons (list symbol f v p
)
250 apropos-accumulator
))))))
251 (apropos-print nil nil t
))
255 (defun apropos-documentation (apropos-regexp &optional do-all
)
256 "Show symbols whose documentation contain matches for REGEXP.
257 With optional prefix ARG or if `apropos-do-all' is non-nil, also use
258 documentation that is not stored in the documentation file and show key
260 Returns list of symbols and documentation found."
261 (interactive "sApropos documentation (regexp): \nP")
262 (or do-all
(setq do-all apropos-do-all
))
263 (setq apropos-accumulator
() apropos-files-scanned
())
264 (let ((standard-input (get-buffer-create " apropos-temp"))
268 (set-buffer standard-input
)
269 (apropos-documentation-check-doc-file)
273 (setq f
(apropos-safe-documentation symbol
)
274 v
(get symbol
'variable-documentation
))
275 (if (integerp v
) (setq v
))
276 (setq f
(apropos-documentation-internal f
)
277 v
(apropos-documentation-internal v
))
279 (if (setq apropos-item
280 (cdr (assq symbol apropos-accumulator
)))
283 (setcar apropos-item f
))
285 (setcar (cdr apropos-item
) v
)))
286 (setq apropos-accumulator
287 (cons (list symbol f v
)
288 apropos-accumulator
)))))))
289 (apropos-print nil nil t
))
290 (kill-buffer standard-input
))))
293 (defun apropos-value-internal (predicate symbol function
)
294 (if (funcall predicate symbol
)
296 (setq symbol
(prin1-to-string (funcall function symbol
)))
297 (if (string-match apropos-regexp symbol
)
299 (if apropos-match-face
300 (put-text-property (match-beginning 0) (match-end 0)
301 'face apropos-match-face
305 (defun apropos-documentation-internal (doc)
307 (apropos-documentation-check-elc-file (car doc
))
309 (string-match apropos-regexp doc
)
311 (if apropos-match-face
312 (put-text-property (match-beginning 0)
314 'face apropos-match-face
315 (setq doc
(copy-sequence doc
))))
318 (defun apropos-format-plist (pl sep
&optional compare
)
319 (setq pl
(symbol-plist pl
))
322 (setq p
(format "%s %S" (car pl
) (nth 1 pl
)))
323 (if (or (not compare
) (string-match apropos-regexp p
))
324 (if apropos-property-face
325 (put-text-property 0 (length (symbol-name (car pl
)))
326 'face apropos-property-face p
))
330 (and compare apropos-match-face
331 (put-text-property (match-beginning 0) (match-end 0)
332 'face apropos-match-face
334 (setq p-out
(concat p-out
(if p-out sep
) p
))))
335 (setq pl
(nthcdr 2 pl
)))
339 ;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
341 (defun apropos-documentation-check-doc-file ()
342 (let (type symbol
(sepa 2) sepb beg end
)
345 (insert-file-contents (concat doc-directory internal-doc-file-name
))
347 (while (save-excursion
348 (setq sepb
(search-forward "\^_"))
350 (beginning-of-line 2)
351 (if (save-restriction
352 (narrow-to-region (point) (1- sepb
))
353 (re-search-forward apropos-regexp nil t
))
355 (setq beg
(match-beginning 0)
357 (goto-char (1+ sepa
))
358 (or (setq type
(if (eq ?F
(preceding-char))
359 1 ; function documentation
360 2) ; variable documentation
362 beg
(- beg
(point) 1)
363 end
(- end
(point) 1)
364 doc
(buffer-substring (1+ (point)) (1- sepb
))
365 apropos-item
(assq symbol apropos-accumulator
))
366 (setq apropos-item
(list symbol nil nil
)
367 apropos-accumulator
(cons apropos-item
368 apropos-accumulator
)))
369 (if apropos-match-face
370 (put-text-property beg end
'face apropos-match-face doc
))
371 (setcar (nthcdr type apropos-item
) doc
)))
372 (setq sepa
(goto-char sepb
)))))
374 (defun apropos-documentation-check-elc-file (file)
375 (if (member file apropos-files-scanned
)
377 (let (symbol doc beg end this-is-a-variable
)
378 (setq apropos-files-scanned
(cons file apropos-files-scanned
))
380 (insert-file-contents file
)
381 (while (search-forward "\n#@" nil t
)
382 ;; Read the comment length, and advance over it.
385 end
(+ (point) end -
1))
387 (if (save-restriction
388 ;; match ^ and $ relative to doc string
389 (narrow-to-region beg end
)
390 (re-search-forward apropos-regexp nil t
))
392 (goto-char (+ end
2))
393 (setq doc
(buffer-substring beg end
)
394 end
(- (match-end 0) beg
)
395 beg
(- (match-beginning 0) beg
)
396 this-is-a-variable
(looking-at "(def\\(var\\|const\\) ")
398 (skip-chars-forward "(a-z")
401 symbol
(if (consp symbol
)
404 (if (if this-is-a-variable
405 (get symbol
'variable-documentation
)
406 (and (fboundp symbol
) (apropos-safe-documentation symbol
)))
408 (or (setq apropos-item
(assq symbol apropos-accumulator
))
409 (setq apropos-item
(list symbol nil nil
)
410 apropos-accumulator
(cons apropos-item
411 apropos-accumulator
)))
412 (if apropos-match-face
413 (put-text-property beg end
'face apropos-match-face
415 (setcar (nthcdr (if this-is-a-variable
2 1)
421 (defun apropos-safe-documentation (function)
422 "Like documentation, except it avoids calling `get_doc_string'.
423 Will return nil instead."
424 (while (and function
(symbolp function
))
425 (setq function
(if (fboundp function
)
426 (symbol-function function
))))
427 (if (eq (car-safe function
) 'macro
)
428 (setq function
(cdr function
)))
429 (setq function
(if (byte-code-function-p function
)
430 (if (> (length function
) 4)
432 (if (eq (car-safe function
) 'autoload
)
434 (if (eq (car-safe function
) 'lambda
)
435 (if (stringp (nth 2 function
))
437 (if (stringp (nth 3 function
))
438 (nth 3 function
)))))))
439 (if (integerp function
)
445 (defun apropos-print (do-keys doc-fn spacing
)
446 "Output result of various apropos commands with `apropos-regexp'.
447 APROPOS-ACCUMULATOR is a list. Optional DOC-FN is called for each element
448 of apropos-accumulator and may modify it resulting in (symbol fn-doc
449 var-doc [plist-doc]). Returns sorted list of symbols and documentation
451 (if (null apropos-accumulator
)
452 (message "No apropos matches for `%s'" apropos-regexp
)
454 (funcall doc-fn apropos-accumulator
))
455 (setq apropos-accumulator
456 (sort apropos-accumulator
(lambda (a b
)
457 (string-lessp (car a
) (car b
)))))
458 (and apropos-label-face
459 (symbolp apropos-label-face
)
460 (setq apropos-label-face
`(face ,apropos-label-face
461 mouse-face highlight
)))
462 (with-output-to-temp-buffer "*Apropos*"
463 (let ((p apropos-accumulator
)
464 (old-buffer (current-buffer))
465 symbol item point1 point2
)
466 (set-buffer standard-output
)
469 (insert "If you move the mouse over text that changes color,\n"
470 (substitute-command-keys
471 "you can click \\[apropos-mouse-follow] to get more information.\n")))
472 (insert (substitute-command-keys
473 "In this buffer, type \\[apropos-follow] to get full documentation.\n\n"))
475 (or (not spacing
) (bobp) (terpri))
476 (setq apropos-item
(car p
)
477 symbol
(car apropos-item
)
480 (princ symbol
) ; print symbol name
481 (setq point2
(point))
482 ;; Calculate key-bindings if we want them.
488 (set-buffer old-buffer
)
489 (where-is-internal symbol
)))
491 ;; Copy over the list of key sequences,
492 ;; omitting any that contain a buffer or a frame.
494 (let ((key (car keys
))
497 (while (< i
(length key
))
498 (if (or (framep (aref key i
))
499 (bufferp (aref key i
)))
503 (setq filtered
(cons key filtered
))))
504 (setq keys
(cdr keys
)))
505 (setq item filtered
))
506 ;; Convert the remaining keys to a string and insert.
510 (setq key
(key-description key
))
511 (if apropos-keybinding-face
512 (put-text-property 0 (length key
)
513 'face apropos-keybinding-face
518 (put-text-property (- (point) 3) (point)
519 'face apropos-keybinding-face
)
520 (insert " " (symbol-name symbol
) " ")
522 (put-text-property (- (point) 3) (point)
523 'face apropos-keybinding-face
)))
525 ;; only now so we don't propagate text attributes all over
526 (put-text-property point1 point2
'item
527 (if (eval `(or ,@(cdr apropos-item
)))
530 (if apropos-symbol-face
531 (put-text-property point1 point2
'face apropos-symbol-face
))
532 (apropos-print-doc 'describe-function
1
533 (if (commandp symbol
)
535 (if (apropos-macrop symbol
)
539 (if (get symbol
'custom-type
)
540 (apropos-print-doc 'customize-variable-other-window
2
541 "User Option" do-keys
)
542 (apropos-print-doc 'describe-variable
2
544 (apropos-print-doc 'customize-other-window
6 "Group" do-keys
)
545 (apropos-print-doc 'customize-face-other-window
5 "Face" do-keys
)
546 (apropos-print-doc 'widget-browse-other-window
4 "Widget" do-keys
)
547 (apropos-print-doc 'apropos-describe-plist
3
549 (prog1 apropos-accumulator
550 (setq apropos-accumulator
()))) ; permit gc
553 (defun apropos-macrop (symbol)
554 "T if SYMBOL is a Lisp macro."
555 (and (fboundp symbol
)
557 (symbol-function symbol
)))
558 (or (eq (car symbol
) 'macro
)
559 (if (eq (car symbol
) 'autoload
)
564 (defun apropos-print-doc (action i str do-keys
)
565 (if (stringp (setq i
(nth i apropos-item
)))
568 (put-text-property (- (point) 2) (1- (point))
571 (if apropos-label-face
572 (add-text-properties (- (point) (length str
) 2)
575 (insert (if do-keys
(substitute-command-keys i
) i
))
576 (or (bolp) (terpri)))))
579 (defun apropos-mouse-follow (event)
581 (let ((other (if (eq (current-buffer) (get-buffer "*Apropos*"))
585 (set-buffer (window-buffer (posn-window (event-start event
))))
586 (goto-char (posn-point (event-start event
)))
587 (or (and (not (eobp)) (get-text-property (point) 'mouse-face
))
588 (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face
))
589 (error "There is nothing to follow here"))
590 (apropos-follow other
))))
593 (defun apropos-follow (&optional other
)
595 (let* (;; Properties are always found at the beginning of the line.
596 (bol (save-excursion (beginning-of-line) (point)))
597 ;; If there is no `item' property here, look behind us.
598 (item (get-text-property bol
'item
))
599 (item-at (if item nil
(previous-single-property-change bol
'item
)))
600 ;; Likewise, if there is no `action' property here, look in front.
601 (action (get-text-property bol
'action
))
602 (action-at (if action nil
(next-single-property-change bol
'action
))))
603 (and (null item
) item-at
604 (setq item
(get-text-property (1- item-at
) 'item
)))
605 (and (null action
) action-at
606 (setq action
(get-text-property action-at
'action
)))
607 (if (not (and item action
))
608 (error "There is nothing to follow here"))
609 (if (consp item
) (error "There is nothing to follow in `%s'" (car item
)))
610 (if other
(set-buffer other
))
611 (funcall action item
)))
615 (defun apropos-describe-plist (symbol)
616 "Display a pretty listing of SYMBOL's plist."
617 (with-output-to-temp-buffer "*Help*"
618 (set-buffer standard-output
)
621 (princ "'s plist is\n (")
622 (if apropos-symbol-face
623 (put-text-property 8 (- (point) 14) 'face apropos-symbol-face
))
624 (insert (apropos-format-plist symbol
"\n "))
626 (print-help-return-message)))
630 ;;; apropos.el ends here