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 <occitan@esperanto.org>
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.
61 "Apropos commands for users and programmers"
65 ;; I see a degradation of maybe 10-20% only.
66 (defcustom apropos-do-all nil
67 "*Whether the apropos commands should do more.
69 Slows them down more or less. Set this non-nil if you have a fast machine."
74 (defcustom apropos-symbol-face 'bold
75 "*Face for symbol name in Apropos output, or nil for none."
79 (defcustom apropos-keybinding-face 'underline
80 "*Face for lists of keybinding in Apropos output, or nil for none."
84 (defcustom apropos-label-face 'italic
85 "*Face for label (`Command', `Variable' ...) in Apropos output.
86 A value of nil means don't use any special font for them, and also
87 turns off mouse highlighting."
91 (defcustom apropos-property-face 'bold-italic
92 "*Face for property name in apropos output, or nil for none."
96 (defcustom apropos-match-face 'secondary-selection
97 "*Face for matching text in Apropos documentation/value, or nil for none.
98 This applies when you look for matches in the documentation or variable value
99 for the regexp; the part that matches gets displayed in this font."
104 (defvar apropos-mode-map
105 (let ((map (make-sparse-keymap)))
106 (define-key map "\C-m" 'apropos-follow)
107 (define-key map " " 'scroll-up)
108 (define-key map "\177" 'scroll-down)
109 (define-key map "q" 'quit-window)
110 (define-key map [mouse-2] 'apropos-mouse-follow)
111 (define-key map [down-mouse-2] nil)
113 "Keymap used in Apropos mode.")
116 (defvar apropos-regexp nil
117 "Regexp used in current apropos run.")
119 (defvar apropos-files-scanned ()
120 "List of elc files already scanned in current run of `apropos-documentation'.")
122 (defvar apropos-accumulator ()
123 "Alist of symbols already found in current apropos run.")
125 (defvar apropos-item ()
126 "Current item in or for apropos-accumulator.")
129 (defun apropos-mode ()
130 "Major mode for following hyperlinks in output of apropos commands.
132 \\{apropos-mode-map}"
134 (kill-all-local-variables)
135 (use-local-map apropos-mode-map)
136 (setq major-mode 'apropos-mode
137 mode-name "Apropos"))
140 (defun apropos-variable (regexp &optional do-all)
141 "Show user variables that match REGEXP.
142 With optional prefix ARG or if `apropos-do-all' is non-nil, also show
144 (interactive (list (read-string
146 (if (or current-prefix-arg apropos-do-all)
151 (apropos-command regexp nil
152 (if (or do-all apropos-do-all)
155 (get symbol 'variable-documentation)))
158 ;; For auld lang syne:
160 (fset 'command-apropos 'apropos-command)
162 (defun apropos-command (apropos-regexp &optional do-all var-predicate)
163 "Show commands (interactively callable functions) that match REGEXP.
164 With optional prefix ARG, or if `apropos-do-all' is non-nil, also show
165 noninteractive functions.
167 If VAR-PREDICATE is non-nil, show only variables, and only those that
168 satisfy the predicate VAR-PREDICATE."
169 (interactive (list (read-string (concat
171 (if (or current-prefix-arg
177 (let ((standard-output (get-buffer-create "*Apropos*")))
178 (print-help-return-message 'identity))))
179 (or do-all (setq do-all apropos-do-all))
180 (setq apropos-accumulator
181 (apropos-internal apropos-regexp
183 (if do-all 'functionp 'commandp))))
184 (let ((tem apropos-accumulator))
186 (if (get (car tem) 'apropos-inhibit)
187 (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
188 (setq tem (cdr tem))))
189 (let ((p apropos-accumulator)
193 (setq symbol (car p))
194 (unless var-predicate
195 (if (functionp symbol)
196 (if (setq doc (documentation symbol t))
197 (substring doc 0 (string-match "\n" doc))
198 "(not documented)")))
200 (funcall var-predicate symbol)
201 (if (setq doc (documentation-property
202 symbol 'variable-documentation t))
204 (string-match "\n" doc))))))
206 (and (apropos-print t nil)
212 (defun apropos (apropos-regexp &optional do-all)
213 "Show all bound symbols whose names match REGEXP.
214 With optional prefix ARG or if `apropos-do-all' is non-nil, also show unbound
215 symbols and key bindings, which is a little more time-consuming.
216 Returns list of symbols and documentation found."
217 (interactive "sApropos symbol (regexp): \nP")
218 (setq apropos-accumulator
219 (apropos-internal apropos-regexp
226 (symbol-plist symbol))))))
227 (let ((tem apropos-accumulator))
229 (if (get (car tem) 'apropos-inhibit)
230 (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
231 (setq tem (cdr tem))))
232 (let ((p apropos-accumulator)
233 symbol doc properties)
236 (setq symbol (car p))
237 (when (fboundp symbol)
238 (if (setq doc (condition-case nil
239 (documentation symbol t)
241 "(alias for undefined function)")))
242 (substring doc 0 (string-match "\n" doc))
244 (when (boundp symbol)
245 (if (setq doc (documentation-property
246 symbol 'variable-documentation t))
247 (substring doc 0 (string-match "\n" doc))
249 (when (setq properties (symbol-plist symbol))
250 (setq doc (list (car properties)))
251 (while (setq properties (cdr (cdr properties)))
252 (setq doc (cons (car properties) doc)))
253 (mapconcat #'symbol-name (nreverse doc) " "))
254 (when (get symbol 'widget-type)
255 (if (setq doc (documentation-property
256 symbol 'widget-documentation t))
258 (string-match "\n" doc))
261 (if (setq doc (documentation-property
262 symbol 'face-documentation t))
264 (string-match "\n" doc))
266 (when (get symbol 'custom-group)
267 (if (setq doc (documentation-property
268 symbol 'group-documentation t))
270 (string-match "\n" doc))
271 "(not documented)"))))
274 (or do-all apropos-do-all)
279 (defun apropos-value (apropos-regexp &optional do-all)
280 "Show all symbols whose value's printed image matches REGEXP.
281 With optional prefix ARG or if `apropos-do-all' is non-nil, also looks
282 at the function and at the names and values of properties.
283 Returns list of symbols and values found."
284 (interactive "sApropos value (regexp): \nP")
285 (or do-all (setq do-all apropos-do-all))
286 (setq apropos-accumulator ())
290 (setq f nil v nil p nil)
291 (or (memq symbol '(apropos-regexp do-all apropos-accumulator
293 (setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
295 (setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
296 p (apropos-format-plist symbol "\n " t)))
298 (setq apropos-accumulator (cons (list symbol f v p)
299 apropos-accumulator))))))
300 (apropos-print nil t))
304 (defun apropos-documentation (apropos-regexp &optional do-all)
305 "Show symbols whose documentation contain matches for REGEXP.
306 With optional prefix ARG or if `apropos-do-all' is non-nil, also use
307 documentation that is not stored in the documentation file and show key
309 Returns list of symbols and documentation found."
310 (interactive "sApropos documentation (regexp): \nP")
311 (or do-all (setq do-all apropos-do-all))
312 (setq apropos-accumulator () apropos-files-scanned ())
313 (let ((standard-input (get-buffer-create " apropos-temp"))
317 (set-buffer standard-input)
318 (apropos-documentation-check-doc-file)
322 (setq f (apropos-safe-documentation symbol)
323 v (get symbol 'variable-documentation))
324 (if (integerp v) (setq v))
325 (setq f (apropos-documentation-internal f)
326 v (apropos-documentation-internal v))
328 (if (setq apropos-item
329 (cdr (assq symbol apropos-accumulator)))
332 (setcar apropos-item f))
334 (setcar (cdr apropos-item) v)))
335 (setq apropos-accumulator
336 (cons (list symbol f v)
337 apropos-accumulator)))))))
338 (apropos-print nil t))
339 (kill-buffer standard-input))))
342 (defun apropos-value-internal (predicate symbol function)
343 (if (funcall predicate symbol)
345 (setq symbol (prin1-to-string (funcall function symbol)))
346 (if (string-match apropos-regexp symbol)
348 (if apropos-match-face
349 (put-text-property (match-beginning 0) (match-end 0)
350 'face apropos-match-face
354 (defun apropos-documentation-internal (doc)
356 (apropos-documentation-check-elc-file (car doc))
358 (string-match apropos-regexp doc)
360 (if apropos-match-face
361 (put-text-property (match-beginning 0)
363 'face apropos-match-face
364 (setq doc (copy-sequence doc))))
367 (defun apropos-format-plist (pl sep &optional compare)
368 (setq pl (symbol-plist pl))
371 (setq p (format "%s %S" (car pl) (nth 1 pl)))
372 (if (or (not compare) (string-match apropos-regexp p))
373 (if apropos-property-face
374 (put-text-property 0 (length (symbol-name (car pl)))
375 'face apropos-property-face p))
379 (and compare apropos-match-face
380 (put-text-property (match-beginning 0) (match-end 0)
381 'face apropos-match-face
383 (setq p-out (concat p-out (if p-out sep) p))))
384 (setq pl (nthcdr 2 pl)))
388 ;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
390 (defun apropos-documentation-check-doc-file ()
391 (let (type symbol (sepa 2) sepb beg end)
394 (insert-file-contents (concat doc-directory internal-doc-file-name))
396 (while (save-excursion
397 (setq sepb (search-forward "\^_"))
399 (beginning-of-line 2)
400 (if (save-restriction
401 (narrow-to-region (point) (1- sepb))
402 (re-search-forward apropos-regexp nil t))
404 (setq beg (match-beginning 0)
406 (goto-char (1+ sepa))
407 (or (setq type (if (eq ?F (preceding-char))
408 1 ; function documentation
409 2) ; variable documentation
411 beg (- beg (point) 1)
412 end (- end (point) 1)
413 doc (buffer-substring (1+ (point)) (1- sepb))
414 apropos-item (assq symbol apropos-accumulator))
415 (setq apropos-item (list symbol nil nil)
416 apropos-accumulator (cons apropos-item
417 apropos-accumulator)))
418 (if apropos-match-face
419 (put-text-property beg end 'face apropos-match-face doc))
420 (setcar (nthcdr type apropos-item) doc)))
421 (setq sepa (goto-char sepb)))))
423 (defun apropos-documentation-check-elc-file (file)
424 (if (member file apropos-files-scanned)
426 (let (symbol doc beg end this-is-a-variable)
427 (setq apropos-files-scanned (cons file apropos-files-scanned))
429 (insert-file-contents file)
430 (while (search-forward "\n#@" nil t)
431 ;; Read the comment length, and advance over it.
434 end (+ (point) end -1))
436 (if (save-restriction
437 ;; match ^ and $ relative to doc string
438 (narrow-to-region beg end)
439 (re-search-forward apropos-regexp nil t))
441 (goto-char (+ end 2))
442 (setq doc (buffer-substring beg end)
443 end (- (match-end 0) beg)
444 beg (- (match-beginning 0) beg)
445 this-is-a-variable (looking-at "(def\\(var\\|const\\) ")
447 (skip-chars-forward "(a-z")
450 symbol (if (consp symbol)
453 (if (if this-is-a-variable
454 (get symbol 'variable-documentation)
455 (and (fboundp symbol) (apropos-safe-documentation symbol)))
457 (or (setq apropos-item (assq symbol apropos-accumulator))
458 (setq apropos-item (list symbol nil nil)
459 apropos-accumulator (cons apropos-item
460 apropos-accumulator)))
461 (if apropos-match-face
462 (put-text-property beg end 'face apropos-match-face
464 (setcar (nthcdr (if this-is-a-variable 2 1)
470 (defun apropos-safe-documentation (function)
471 "Like documentation, except it avoids calling `get_doc_string'.
472 Will return nil instead."
473 (while (and function (symbolp function))
474 (setq function (if (fboundp function)
475 (symbol-function function))))
476 (if (eq (car-safe function) 'macro)
477 (setq function (cdr function)))
478 (setq function (if (byte-code-function-p function)
479 (if (> (length function) 4)
481 (if (eq (car-safe function) 'autoload)
483 (if (eq (car-safe function) 'lambda)
484 (if (stringp (nth 2 function))
486 (if (stringp (nth 3 function))
487 (nth 3 function)))))))
488 (if (integerp function)
494 (defvar apropos-label-properties nil
495 "List of face properties to use for a label.
496 Bound by `apropos-print' for use by `apropos-print-doc'.")
498 (defun apropos-print (do-keys spacing)
499 "Output result of apropos searching into buffer `*Apropos*'.
500 The value of `apropos-accumulator' is the list of items to output.
501 Each element should have the format (SYMBOL FN-DOC VAR-DOC [PLIST-DOC]).
502 The return value is the list that was in `apropos-accumulator', sorted
503 alphabetically by symbol name; but this function also sets
504 `apropos-accumulator' to nil before returning."
505 (if (null apropos-accumulator)
506 (message "No apropos matches for `%s'" apropos-regexp)
507 (setq apropos-accumulator
508 (sort apropos-accumulator (lambda (a b)
509 (string-lessp (car a) (car b)))))
510 (setq apropos-label-properties
511 (if (and apropos-label-face
512 (symbolp apropos-label-face))
513 `(face ,apropos-label-face
514 mouse-face highlight)))
515 (with-output-to-temp-buffer "*Apropos*"
516 (let ((p apropos-accumulator)
517 (old-buffer (current-buffer))
518 symbol item point1 point2)
519 (set-buffer standard-output)
522 (insert "If you move the mouse over text that changes color,\n"
523 (substitute-command-keys
524 "you can click \\[apropos-mouse-follow] to get more information.\n")))
525 (insert (substitute-command-keys
526 "In this buffer, type \\[apropos-follow] to get full documentation.\n\n"))
528 (or (not spacing) (bobp) (terpri))
529 (setq apropos-item (car p)
530 symbol (car apropos-item)
533 (princ symbol) ; print symbol name
534 (setq point2 (point))
535 ;; Calculate key-bindings if we want them.
541 (set-buffer old-buffer)
542 (where-is-internal symbol)))
544 ;; Copy over the list of key sequences,
545 ;; omitting any that contain a buffer or a frame.
547 (let ((key (car keys))
550 (while (< i (length key))
551 (if (or (framep (aref key i))
552 (bufferp (aref key i)))
556 (setq filtered (cons key filtered))))
557 (setq keys (cdr keys)))
558 (setq item filtered))
559 ;; Convert the remaining keys to a string and insert.
563 (setq key (condition-case ()
564 (key-description key)
566 (if apropos-keybinding-face
567 (put-text-property 0 (length key)
568 'face apropos-keybinding-face
573 (put-text-property (- (point) 3) (point)
574 'face apropos-keybinding-face)
575 (insert " " (symbol-name symbol) " ")
577 (put-text-property (- (point) 3) (point)
578 'face apropos-keybinding-face)))
580 ;; only now so we don't propagate text attributes all over
581 (put-text-property point1 point2 'item
582 (if (eval `(or ,@(cdr apropos-item)))
585 (if apropos-symbol-face
586 (put-text-property point1 point2 'face apropos-symbol-face))
587 (apropos-print-doc 'describe-function 1
588 (if (commandp symbol)
590 (if (apropos-macrop symbol)
594 ;; We used to use `customize-variable-other-window' instead
595 ;; for a customizable variable, but that is slow.
596 ;; It is better to show an ordinary help buffer
597 ;; and let the user click on the customization button
598 ;; in that buffer, if he wants to.
599 ;; Likewise for `customize-face-other-window'.
600 (apropos-print-doc 'describe-variable 2 "Variable" t)
601 (apropos-print-doc 'customize-group-other-window 6 "Group" t)
602 (apropos-print-doc 'describe-face 5 "Face" t)
603 (apropos-print-doc 'widget-browse-other-window 4 "Widget" t)
604 (apropos-print-doc 'apropos-describe-plist 3
606 (setq buffer-read-only t))))
607 (prog1 apropos-accumulator
608 (setq apropos-accumulator ()))) ; permit gc
611 (defun apropos-macrop (symbol)
612 "T if SYMBOL is a Lisp macro."
613 (and (fboundp symbol)
615 (symbol-function symbol)))
616 (or (eq (car symbol) 'macro)
617 (if (eq (car symbol) 'autoload)
622 (defun apropos-print-doc (action i str do-keys)
623 (if (stringp (setq i (nth i apropos-item)))
626 (put-text-property (- (point) 2) (1- (point))
629 (if apropos-label-properties
630 (add-text-properties (- (point) (length str) 2)
632 apropos-label-properties))
633 (insert (if do-keys (substitute-command-keys i) i))
634 (or (bolp) (terpri)))))
637 (defun apropos-mouse-follow (event)
639 (let ((other (if (eq (current-buffer) (get-buffer "*Apropos*"))
643 (set-buffer (window-buffer (posn-window (event-start event))))
644 (goto-char (posn-point (event-start event)))
645 (or (and (not (eobp)) (get-text-property (point) 'mouse-face))
646 (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
647 (error "There is nothing to follow here"))
648 (apropos-follow other))))
651 (defun apropos-follow (&optional other)
653 (let* (;; Properties are always found at the beginning of the line.
654 (bol (save-excursion (beginning-of-line) (point)))
655 ;; If there is no `item' property here, look behind us.
656 (item (get-text-property bol 'item))
657 (item-at (if item nil (previous-single-property-change bol 'item)))
658 ;; Likewise, if there is no `action' property here, look in front.
659 (action (get-text-property bol 'action))
660 (action-at (if action nil (next-single-property-change bol 'action))))
661 (and (null item) item-at
662 (setq item (get-text-property (1- item-at) 'item)))
663 (and (null action) action-at
664 (setq action (get-text-property action-at 'action)))
665 (if (not (and item action))
666 (error "There is nothing to follow here"))
667 (if (consp item) (error "There is nothing to follow in `%s'" (car item)))
668 (if other (set-buffer other))
669 (funcall action item)))
673 (defun apropos-describe-plist (symbol)
674 "Display a pretty listing of SYMBOL's plist."
675 (with-output-to-temp-buffer "*Help*"
676 (set-buffer standard-output)
679 (princ "'s plist is\n (")
680 (if apropos-symbol-face
681 (put-text-property 8 (- (point) 14) 'face apropos-symbol-face))
682 (insert (apropos-format-plist symbol "\n "))
684 (print-help-return-message)))
688 ;;; apropos.el ends here