apropos.el 24.4 KB
Newer Older
1
;;; apropos.el --- apropos commands for users and programmers
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1989, 1994, 1995, 2001 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Author: Joe Wells <jbw@bigbird.bu.edu>
Karl Heuer's avatar
Karl Heuer committed
6
;; Rewritten: Daniel Pfeiffer <occitan@esperanto.org>
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: help
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11 12
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
13
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
14 15 16 17 18 19 20 21
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
25

Eric S. Raymond's avatar
Eric S. Raymond committed
26
;;; Commentary:
Richard M. Stallman's avatar
Richard M. Stallman committed
27 28 29 30 31 32 33 34 35 36 37 38 39

;; The ideas for this package were derived from the C code in
;; src/keymap.c and elsewhere.  The functions in this file should
;; always be byte-compiled for speed.  Someone should rewrite this in
;; C (as part of src/keymap.c) for speed.

;; The idea for super-apropos is based on the original implementation
;; by Lynn Slater <lrs@esl.com>.

;; History:
;; Fixed bug, current-local-map can return nil.
;; Change, doesn't calculate key-bindings unless needed.
;; Added super-apropos capability, changed print functions.
40 41
;;; Made fast-apropos and super-apropos share code.
;;; Sped up fast-apropos again.
Richard M. Stallman's avatar
Richard M. Stallman committed
42
;; Added apropos-do-all option.
43
;;; Added fast-command-apropos.
Richard M. Stallman's avatar
Richard M. Stallman committed
44
;; Changed doc strings to comments for helping functions.
45
;;; Made doc file buffer read-only, buried it.
Richard M. Stallman's avatar
Richard M. Stallman committed
46 47
;; Only call substitute-command-keys if do-all set.

48 49
;; Optionally use configurable faces to make the output more legible.
;; Differentiate between command, function and macro.
50 51 52 53 54 55 56 57
;; Apropos-command (ex command-apropos) does cmd and optionally user var.
;; Apropos shows all 3 aspects of symbols (fn, var and plist)
;; Apropos-documentation (ex super-apropos) now finds all it should.
;; New apropos-value snoops through all values and optionally plists.
;; Reading DOC file doesn't load nroff.
;; Added hypertext following of documentation, mouse-2 on variable gives value
;;   from buffer in active window.

Eric S. Raymond's avatar
Eric S. Raymond committed
58 59
;;; Code:

Miles Bader's avatar
Miles Bader committed
60 61
(require 'button)

Richard M. Stallman's avatar
Richard M. Stallman committed
62 63
(defgroup apropos nil
  "Apropos commands for users and programmers"
64
  :group 'help
Richard M. Stallman's avatar
Richard M. Stallman committed
65 66
  :prefix "apropos")

67
;; I see a degradation of maybe 10-20% only.
Richard M. Stallman's avatar
Richard M. Stallman committed
68
(defcustom apropos-do-all nil
69
  "*Whether the apropos commands should do more.
Richard M. Stallman's avatar
Richard M. Stallman committed
70 71 72 73

Slows them down more or less.  Set this non-nil if you have a fast machine."
  :group 'apropos
  :type 'boolean)
74 75


76 77
(defcustom apropos-symbol-face 'bold
  "*Face for symbol name in Apropos output, or nil for none."
Richard M. Stallman's avatar
Richard M. Stallman committed
78 79
  :group 'apropos
  :type 'face)
80

81 82
(defcustom apropos-keybinding-face 'underline
  "*Face for lists of keybinding in Apropos output, or nil for none."
Richard M. Stallman's avatar
Richard M. Stallman committed
83 84
  :group 'apropos
  :type 'face)
85

86 87 88 89
(defcustom apropos-label-face 'italic
  "*Face for label (`Command', `Variable' ...) in Apropos output.
A value of nil means don't use any special font for them, and also
turns off mouse highlighting."
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91
  :group 'apropos
  :type 'face)
92

93 94
(defcustom apropos-property-face 'bold-italic
  "*Face for property name in apropos output, or nil for none."
Richard M. Stallman's avatar
Richard M. Stallman committed
95 96
  :group 'apropos
  :type 'face)
97

98 99 100 101
(defcustom apropos-match-face 'secondary-selection
  "*Face for matching text in Apropos documentation/value, or nil for none.
This applies when you look for matches in the documentation or variable value
for the regexp; the part that matches gets displayed in this font."
Richard M. Stallman's avatar
Richard M. Stallman committed
102 103
  :group 'apropos
  :type 'face)
104

Richard M. Stallman's avatar
Richard M. Stallman committed
105

106
(defvar apropos-mode-map
107
  (let ((map (make-sparse-keymap)))
108 109 110 111
    (set-keymap-parent map button-buffer-map)
    ;; Use `apropos-follow' instead of just using the button
    ;; definition of RET, so that users can use it anywhere in an
    ;; apropos item, not just on top of a button.
112
    (define-key map "\C-m" 'apropos-follow)
113 114 115
    (define-key map " "    'scroll-up)
    (define-key map "\177" 'scroll-down)
    (define-key map "q"    'quit-window)
116
    map)
117
  "Keymap used in Apropos mode.")
118

Gerd Moellmann's avatar
Gerd Moellmann committed
119 120
(defvar apropos-mode-hook nil
  "*Hook run when mode is turned on.")
121

122 123 124 125
(defvar apropos-regexp nil
  "Regexp used in current apropos run.")

(defvar apropos-files-scanned ()
Karl Heuer's avatar
Karl Heuer committed
126
  "List of elc files already scanned in current run of `apropos-documentation'.")
127 128 129

(defvar apropos-accumulator ()
  "Alist of symbols already found in current apropos run.")
130

131
(defvar apropos-item ()
Dave Love's avatar
Dave Love committed
132
  "Current item in or for `apropos-accumulator'.")
133 134 135 136 137 138


;;; Button types used by apropos

(define-button-type 'apropos-symbol
  'face apropos-symbol-face
139 140 141
  'help-echo "mouse-2, RET: Display more help on this symbol"
  'action #'apropos-symbol-button-display-help
  'skip t)
142 143 144 145 146 147 148

(defun apropos-symbol-button-display-help (button)
  "Display further help for the `apropos-symbol' button BUTTON."
  (button-activate
   (or (apropos-next-label-button (button-start button))
       (error "There is nothing to follow for `%s'" (button-label button)))))

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
(define-button-type 'apropos-function
  'apropos-label "Function"
  'action (lambda (button)
	    (describe-function (button-get button 'apropos-symbol)))
  'help-echo "mouse-2, RET: Display more help on this function")
(define-button-type 'apropos-macro
  'apropos-label "Macro"
  'action (lambda (button)
	    (describe-function (button-get button 'apropos-symbol)))
  'help-echo "mouse-2, RET: Display more help on this macro")
(define-button-type 'apropos-command
  'apropos-label "Command"
  'action (lambda (button)
	    (describe-function (button-get button 'apropos-symbol)))
  'help-echo "mouse-2, RET: Display more help on this command")
  
;; We used to use `customize-variable-other-window' instead for a
;; customizable variable, but that is slow.  It is better to show an
;; ordinary help buffer and let the user click on the customization
;; button in that buffer, if he wants to.
;; Likewise for `customize-face-other-window'.
(define-button-type 'apropos-variable
  'apropos-label "Variable"
  'help-echo "mouse-2, RET: Display more help on this variable"
  'action (lambda (button)
	    (describe-variable (button-get button 'apropos-symbol))))

(define-button-type 'apropos-face
  'apropos-label "Face"
  'help-echo "mouse-2, RET: Display more help on this face"
  'action (lambda (button)
	    (describe-face (button-get button 'apropos-symbol))))

(define-button-type 'apropos-group
  'apropos-label "Group"
  'help-echo "mouse-2, RET: Display more help on this group"
  'action (lambda (button)
	    (customize-variable-other-window
	     (button-get button 'apropos-symbol))))

(define-button-type 'apropos-widget
  'apropos-label "Widget"
  'help-echo "mouse-2, RET: Display more help on this widget"
  'action (lambda (button)
	    (widget-browse-other-window (button-get button 'apropos-symbol))))

(define-button-type 'apropos-plist
  'apropos-label "Plist"
  'help-echo "mouse-2, RET: Display more help on this plist"
  'action (lambda (button)
	    (apropos-describe-plist (button-get button 'apropos-symbol))))
200 201

(defun apropos-next-label-button (pos)
202
  "Return the next apropos label button after POS, or nil if there's none.
203 204
Will also return nil if more than one `apropos-symbol' button is encountered
before finding a label."
205
  (let* ((button (next-button pos t))
206
	 (already-hit-symbol nil)
207 208
	 (label (and button (button-get button 'apropos-label)))
	 (type (and button (button-get button 'type))))
209
    (while (and button
210 211
		(not label)
		(or (not (eq type 'apropos-symbol))
212
		    (not already-hit-symbol)))
213
      (when (eq type 'apropos-symbol)
214 215 216
	(setq already-hit-symbol t))
      (setq button (next-button (button-start button)))
      (when button
217 218 219
	(setq label (button-get button 'apropos-label))
	(setq type (button-get button 'type))))
    (and label button)))
220

221

222
;;;###autoload
223
(define-derived-mode apropos-mode fundamental-mode "Apropos"
224 225
  "Major mode for following hyperlinks in output of apropos commands.

226
\\{apropos-mode-map}")
227

228
;;;###autoload
229 230
(defun apropos-variable (regexp &optional do-all)
  "Show user variables that match REGEXP.
Dave Love's avatar
Dave Love committed
231
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also show
232 233 234 235 236 237 238 239 240
normal variables."
  (interactive (list (read-string
                      (concat "Apropos "
                              (if (or current-prefix-arg apropos-do-all)
				  "variable"
				"user option")
                              " (regexp): "))
                     current-prefix-arg))
  (apropos-command regexp nil
241
		   (if (or do-all apropos-do-all)
242 243 244 245
		       #'(lambda (symbol)
			   (and (boundp symbol)
				(get symbol 'variable-documentation)))
		     'user-variable-p)))
246

247 248 249
;; For auld lang syne:
;;;###autoload
(fset 'command-apropos 'apropos-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
250
;;;###autoload
251
(defun apropos-command (apropos-regexp &optional do-all var-predicate)
Dave Love's avatar
Dave Love committed
252 253
  "Show commands (interactively callable functions) that match APROPOS-REGEXP.
With optional prefix DO-ALL, or if `apropos-do-all' is non-nil, also show
254
noninteractive functions.
255

256
If VAR-PREDICATE is non-nil, show only variables, and only those that
257
satisfy the predicate VAR-PREDICATE."
258 259 260 261
  (interactive (list (read-string (concat
				   "Apropos command "
				   (if (or current-prefix-arg
					   apropos-do-all)
262
				       "or function ")
263
				   "(regexp): "))
264
		     current-prefix-arg))
265
  (let ((message
266
	 (let ((standard-output (get-buffer-create "*Apropos*")))
267
	   (print-help-return-message 'identity))))
268 269 270
    (or do-all (setq do-all apropos-do-all))
    (setq apropos-accumulator
	  (apropos-internal apropos-regexp
271 272
			    (or var-predicate
				(if do-all 'functionp 'commandp))))
273 274 275 276 277
    (let ((tem apropos-accumulator))
      (while tem
	(if (get (car tem) 'apropos-inhibit)
	    (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
	(setq tem (cdr tem))))
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
    (let ((p apropos-accumulator)
	  doc symbol)
      (while p
	(setcar p (list
		   (setq symbol (car p))
		   (unless var-predicate
		     (if (functionp symbol)
			 (if (setq doc (documentation symbol t))
			     (substring doc 0 (string-match "\n" doc))
			   "(not documented)")))
		   (and var-predicate
			(funcall var-predicate symbol)
			(if (setq doc (documentation-property
				       symbol 'variable-documentation t))
			    (substring doc 0
				       (string-match "\n" doc))))))
	(setq p (cdr p))))
    (and (apropos-print t nil)
	 message
	 (message message))))
298 299 300


;;;###autoload
301
(defun apropos (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
302 303 304 305
  "Show all bound symbols whose names match APROPOS-REGEXP.
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also
show unbound symbols and key bindings, which is a little more
time-consuming.  Returns list of symbols and documentation found."
306
  (interactive "sApropos symbol (regexp): \nP")
307 308 309 310 311 312 313
  (setq apropos-accumulator
	(apropos-internal apropos-regexp
			  (and (not do-all)
			       (not apropos-do-all)
			       (lambda (symbol)
				 (or (fboundp symbol)
				     (boundp symbol)
314
				     (facep symbol)
315
				     (symbol-plist symbol))))))
316 317 318 319 320
  (let ((tem apropos-accumulator))
    (while tem
      (if (get (car tem) 'apropos-inhibit)
	  (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
      (setq tem (cdr tem))))
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
  (let ((p apropos-accumulator)
	symbol doc properties)
    (while p
      (setcar p (list
		 (setq symbol (car p))
		 (when (fboundp symbol)
		   (if (setq doc (condition-case nil
				     (documentation symbol t)
				   (void-function
				    "(alias for undefined function)")))
		       (substring doc 0 (string-match "\n" doc))
		     "(not documented)"))
		 (when (boundp symbol)
		   (if (setq doc (documentation-property
				  symbol 'variable-documentation t))
		       (substring doc 0 (string-match "\n" doc))
		     "(not documented)"))
		 (when (setq properties (symbol-plist symbol))
		   (setq doc (list (car properties)))
		   (while (setq properties (cdr (cdr properties)))
		     (setq doc (cons (car properties) doc)))
		   (mapconcat #'symbol-name (nreverse doc) " "))
		 (when (get symbol 'widget-type)
		   (if (setq doc (documentation-property
				  symbol 'widget-documentation t))
		       (substring doc 0
				  (string-match "\n" doc))
		     "(not documented)"))
		 (when (facep symbol)
		   (if (setq doc (documentation-property
				  symbol 'face-documentation t))
		       (substring doc 0
				  (string-match "\n" doc))
		     "(not documented)"))
		 (when (get symbol 'custom-group)
		   (if (setq doc (documentation-property
				  symbol 'group-documentation t))
		       (substring doc 0
				  (string-match "\n" doc))
		     "(not documented)"))))
      (setq p (cdr p))))
362
  (apropos-print
363
   (or do-all apropos-do-all)
364 365 366
   nil))


Richard M. Stallman's avatar
Richard M. Stallman committed
367
;;;###autoload
368
(defun apropos-value (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
369 370
  "Show all symbols whose value's printed image matches APROPOS-REGEXP.
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also looks
371
at the function and at the names and values of properties.
372
Returns list of symbols and values found."
373
  (interactive "sApropos value (regexp): \nP")
374 375 376
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator ())
   (let (f v p)
377 378 379
     (mapatoms
      (lambda (symbol)
	(setq f nil v nil p nil)
380 381 382
	(or (memq symbol '(apropos-regexp do-all apropos-accumulator
					  symbol f v p))
	    (setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
383
	(if do-all
384 385
	    (setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
		  p (apropos-format-plist symbol "\n    " t)))
386
	(if (or f v p)
387 388
	    (setq apropos-accumulator (cons (list symbol f v p)
					    apropos-accumulator))))))
389
  (apropos-print nil "\n----------------\n"))
390 391


392 393
;;;###autoload
(defun apropos-documentation (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
394 395
  "Show symbols whose documentation contain matches for APROPOS-REGEXP.
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also use
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
documentation that is not stored in the documentation file and show key
bindings.
Returns list of symbols and documentation found."
  (interactive "sApropos documentation (regexp): \nP")
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator () apropos-files-scanned ())
  (let ((standard-input (get-buffer-create " apropos-temp"))
	f v)
    (unwind-protect
	(save-excursion
	  (set-buffer standard-input)
	  (apropos-documentation-check-doc-file)
	  (if do-all
	      (mapatoms
	       (lambda (symbol)
		 (setq f (apropos-safe-documentation symbol)
412 413 414 415
		       v (get symbol 'variable-documentation))
		 (if (integerp v) (setq v))
		 (setq f (apropos-documentation-internal f)
		       v (apropos-documentation-internal v))
416 417 418 419 420 421 422 423 424 425 426
		 (if (or f v)
		     (if (setq apropos-item
			       (cdr (assq symbol apropos-accumulator)))
			 (progn
			   (if f
			       (setcar apropos-item f))
			   (if v
			       (setcar (cdr apropos-item) v)))
		       (setq apropos-accumulator
			     (cons (list symbol f v)
				   apropos-accumulator)))))))
427
	  (apropos-print nil "\n----------------\n"))
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
      (kill-buffer standard-input))))


(defun apropos-value-internal (predicate symbol function)
  (if (funcall predicate symbol)
      (progn
	(setq symbol (prin1-to-string (funcall function symbol)))
	(if (string-match apropos-regexp symbol)
	    (progn
	      (if apropos-match-face
		  (put-text-property (match-beginning 0) (match-end 0)
				     'face apropos-match-face
				     symbol))
	      symbol)))))

(defun apropos-documentation-internal (doc)
  (if (consp doc)
      (apropos-documentation-check-elc-file (car doc))
    (and doc
	 (string-match apropos-regexp doc)
	 (progn
	   (if apropos-match-face
	       (put-text-property (match-beginning 0)
				  (match-end 0)
				  'face apropos-match-face
				  (setq doc (copy-sequence doc))))
	   doc))))

(defun apropos-format-plist (pl sep &optional compare)
457 458 459 460
  (setq pl (symbol-plist pl))
  (let (p p-out)
    (while pl
      (setq p (format "%s %S" (car pl) (nth 1 pl)))
461 462
      (if (or (not compare) (string-match apropos-regexp p))
	  (if apropos-property-face
463
	      (put-text-property 0 (length (symbol-name (car pl)))
464
				 'face apropos-property-face p))
465
	(setq p nil))
466 467 468 469 470 471 472
      (if p
	  (progn
	    (and compare apropos-match-face
		 (put-text-property (match-beginning 0) (match-end 0)
				    'face apropos-match-face
				    p))
	    (setq p-out (concat p-out (if p-out sep) p))))
473 474 475
      (setq pl (nthcdr 2 pl)))
    p-out))

Richard M. Stallman's avatar
Richard M. Stallman committed
476

477
;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
478

479
(defun apropos-documentation-check-doc-file ()
480 481 482
  (let (type symbol (sepa 2) sepb beg end)
    (insert ?\^_)
    (backward-char)
483
    (insert-file-contents (concat doc-directory internal-doc-file-name))
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
    (forward-char)
    (while (save-excursion
	     (setq sepb (search-forward "\^_"))
	     (not (eobp)))
      (beginning-of-line 2)
      (if (save-restriction
	    (narrow-to-region (point) (1- sepb))
	    (re-search-forward apropos-regexp nil t))
	  (progn
	    (setq beg (match-beginning 0)
		  end (point))
	    (goto-char (1+ sepa))
	    (or (setq type (if (eq ?F (preceding-char))
			       1	; function documentation
			     2)		; variable documentation
		      symbol (read)
		      beg (- beg (point) 1)
		      end (- end (point) 1)
		      doc (buffer-substring (1+ (point)) (1- sepb))
		      apropos-item (assq symbol apropos-accumulator))
		(setq apropos-item (list symbol nil nil)
		      apropos-accumulator (cons apropos-item
						apropos-accumulator)))
	    (if apropos-match-face
		(put-text-property beg end 'face apropos-match-face doc))
	    (setcar (nthcdr type apropos-item) doc)))
      (setq sepa (goto-char sepb)))))
511 512 513 514

(defun apropos-documentation-check-elc-file (file)
  (if (member file apropos-files-scanned)
      nil
515
    (let (symbol doc beg end this-is-a-variable)
516 517 518 519 520 521
      (setq apropos-files-scanned (cons file apropos-files-scanned))
      (erase-buffer)
      (insert-file-contents file)
      (while (search-forward "\n#@" nil t)
	;; Read the comment length, and advance over it.
	(setq end (read)
522 523 524 525 526 527 528
	      beg (1+ (point))
	      end (+ (point) end -1))
	(forward-char)
	(if (save-restriction
	      ;; match ^ and $ relative to doc string
	      (narrow-to-region beg end)
	      (re-search-forward apropos-regexp nil t))
529
	    (progn
530 531 532 533 534
	      (goto-char (+ end 2))
	      (setq doc (buffer-substring beg end)
		    end (- (match-end 0) beg)
		    beg (- (match-beginning 0) beg)
		    this-is-a-variable (looking-at "(def\\(var\\|const\\) ")
535 536
		    symbol (progn
			     (skip-chars-forward "(a-z")
537
			     (forward-char)
538 539 540 541 542 543 544 545 546 547 548 549 550
			     (read))
		    symbol (if (consp symbol)
			       (nth 1 symbol)
			     symbol))
	      (if (if this-is-a-variable
		      (get symbol 'variable-documentation)
		    (and (fboundp symbol) (apropos-safe-documentation symbol)))
		  (progn
		    (or (setq apropos-item (assq symbol apropos-accumulator))
			(setq apropos-item (list symbol nil nil)
			      apropos-accumulator (cons apropos-item
							apropos-accumulator)))
		    (if apropos-match-face
551
			(put-text-property beg end 'face apropos-match-face
552 553 554
					   doc))
		    (setcar (nthcdr (if this-is-a-variable 2 1)
				    apropos-item)
555
			    doc)))))))))
556 557 558 559



(defun apropos-safe-documentation (function)
Dave Love's avatar
Dave Love committed
560
  "Like `documentation', except it avoids calling `get_doc_string'.
Richard M. Stallman's avatar
Richard M. Stallman committed
561
Will return nil instead."
562
  (while (and function (symbolp function))
Richard M. Stallman's avatar
Richard M. Stallman committed
563
    (setq function (if (fboundp function)
564
		       (symbol-function function))))
565 566
  (if (eq (car-safe function) 'macro)
      (setq function (cdr function)))
567
  (setq function (if (byte-code-function-p function)
568 569 570 571 572 573 574 575 576 577 578 579 580 581
		     (if (> (length function) 4)
			 (aref function 4))
		   (if (eq (car-safe function) 'autoload)
		       (nth 2 function)
		     (if (eq (car-safe function) 'lambda)
			 (if (stringp (nth 2 function))
			     (nth 2 function)
			   (if (stringp (nth 3 function))
			       (nth 3 function)))))))
  (if (integerp function)
      nil
    function))


582 583 584 585 586 587
(defun apropos-print (do-keys spacing)
  "Output result of apropos searching into buffer `*Apropos*'.
The value of `apropos-accumulator' is the list of items to output.
Each element should have the format (SYMBOL FN-DOC VAR-DOC [PLIST-DOC]).
The return value is the list that was in `apropos-accumulator', sorted
alphabetically by symbol name; but this function also sets
588 589 590 591
`apropos-accumulator' to nil before returning.

If SPACING is non-nil, it should be a string;
separate items with that string."
592 593 594 595
  (if (null apropos-accumulator)
      (message "No apropos matches for `%s'" apropos-regexp)
    (setq apropos-accumulator
	  (sort apropos-accumulator (lambda (a b)
596
				      (string-lessp (car a) (car b)))))
597
    (with-output-to-temp-buffer "*Apropos*"
598
      (let ((p apropos-accumulator)
599
	    (old-buffer (current-buffer))
600
	    symbol item)
601 602
	(set-buffer standard-output)
	(apropos-mode)
603
	(if (display-mouse-p)
604
	    (insert "If moving the mouse over text changes the text's color,\n"
605
		    (substitute-command-keys
606
		     "you can click \\[push-button] on that text to get more information.\n")))
607
	(insert "In this buffer, go to the name of the command, or function,"
608 609 610
		" or variable,\n"
		(substitute-command-keys
		 "and type \\[apropos-follow] to get full documentation.\n\n"))
611
	(while (consp p)
612 613
	  (when (and spacing (not (bobp)))
	    (princ spacing))
614 615
	  (setq apropos-item (car p)
		symbol (car apropos-item)
616 617 618 619 620 621 622
		p (cdr p))
	  (insert-text-button (symbol-name symbol)
			      'type 'apropos-symbol
			      ;; Can't use default, since user may have
			      ;; changed the variable!
			      ;; Just say `no' to variables containing faces!
			      'face apropos-symbol-face)
623
	  ;; Calculate key-bindings if we want them.
624 625 626
	  (and do-keys
	       (commandp symbol)
	       (indent-to 30 1)
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
	       (if (let ((keys
			  (save-excursion
			    (set-buffer old-buffer)
			    (where-is-internal symbol)))
			 filtered)
		     ;; Copy over the list of key sequences,
		     ;; omitting any that contain a buffer or a frame.
		     (while keys
		       (let ((key (car keys))
			     (i 0)
			     loser)
			 (while (< i (length key))
			   (if (or (framep (aref key i))
				   (bufferp (aref key i)))
			       (setq loser t))
			   (setq i (1+ i)))
			 (or loser
			     (setq filtered (cons key filtered))))
		       (setq keys (cdr keys)))
		     (setq item filtered))
		   ;; Convert the remaining keys to a string and insert.
		   (insert
649
		    (mapconcat
650
		     (lambda (key)
Dave Love's avatar
Dave Love committed
651
		       (setq key (condition-case ()
652 653
				     (key-description key)
				   (error)))
654
		       (if apropos-keybinding-face
655 656
			   (put-text-property 0 (length key)
					      'face apropos-keybinding-face
657 658 659
					      key))
		       key)
		     item ", "))
660 661 662 663 664 665 666
		 (insert "M-x")
		 (put-text-property (- (point) 3) (point)
				    'face apropos-keybinding-face)
		 (insert " " (symbol-name symbol) " ")
		 (insert "RET")
		 (put-text-property (- (point) 3) (point)
				    'face apropos-keybinding-face)))
667
	  (terpri)
668
	  (apropos-print-doc 1
669
			     (if (commandp symbol)
670
				 'apropos-command
671
			       (if (apropos-macrop symbol)
672 673
				   'apropos-macro
				 'apropos-function))
674
			     t)
675 676 677 678 679
	  (apropos-print-doc 2 'apropos-variable t)
	  (apropos-print-doc 6 'apropos-group t)
	  (apropos-print-doc 5 'apropos-face t)
	  (apropos-print-doc 4 'apropos-widget t)
	  (apropos-print-doc 3 'apropos-plist nil))
680
	(setq buffer-read-only t))))
681 682 683
  (prog1 apropos-accumulator
    (setq apropos-accumulator ())))	; permit gc

684

685 686 687 688 689 690 691 692 693
(defun apropos-macrop (symbol)
  "T if SYMBOL is a Lisp macro."
  (and (fboundp symbol)
       (consp (setq symbol
		    (symbol-function symbol)))
       (or (eq (car symbol) 'macro)
	   (if (eq (car symbol) 'autoload)
	       (memq (nth 4 symbol)
		     '(macro t))))))
694

695

696
(defun apropos-print-doc (i type do-keys)
697
  (if (stringp (setq i (nth i apropos-item)))
698 699
      (progn
	(insert "  ")
700 701
	(insert-text-button (button-type-get type 'apropos-label)
			    'type type
702 703 704 705
			    ;; Can't use the default button face, since
			    ;; user may have changed the variable!
			    ;; Just say `no' to variables containing faces!
			    'face apropos-label-face
706
			    'apropos-symbol (car apropos-item))
707
	(insert ": ")
708 709
	(insert (if do-keys (substitute-command-keys i) i))
	(or (bolp) (terpri)))))
710 711


712 713
(defun apropos-follow ()
  "Invokes any button at point, otherwise invokes the nearest label button."
714
  (interactive)
715 716 717
  (button-activate
   (or (apropos-next-label-button (line-beginning-position))
       (error "There is nothing to follow here"))))
718 719 720 721 722 723 724 725 726


(defun apropos-describe-plist (symbol)
  "Display a pretty listing of SYMBOL's plist."
  (with-output-to-temp-buffer "*Help*"
    (set-buffer standard-output)
    (princ "Symbol ")
    (prin1 symbol)
    (princ "'s plist is\n (")
727 728
    (if apropos-symbol-face
	(put-text-property 8 (- (point) 14) 'face apropos-symbol-face))
729
    (insert (apropos-format-plist symbol "\n  "))
730 731
    (princ ")")
    (print-help-return-message)))
Richard M. Stallman's avatar
Richard M. Stallman committed
732

733

Richard M. Stallman's avatar
Richard M. Stallman committed
734 735
(provide 'apropos)

Eric S. Raymond's avatar
Eric S. Raymond committed
736
;;; apropos.el ends here