apropos.el 30.5 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, 2002 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
(defvar apropos-show-scores nil
  "*Show apropos scores if non-nil.")

125 126 127
(defvar apropos-regexp nil
  "Regexp used in current apropos run.")

128 129 130 131 132 133
(defvar apropos-orig-regexp nil
  "Regexp as entered by user.")

(defvar apropos-all-regexp nil
  "Regexp matching apropos-all-words.")

134
(defvar apropos-files-scanned ()
Karl Heuer's avatar
Karl Heuer committed
135
  "List of elc files already scanned in current run of `apropos-documentation'.")
136 137 138

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

140
(defvar apropos-item ()
Dave Love's avatar
Dave Love committed
141
  "Current item in or for `apropos-accumulator'.")
142

143 144 145 146 147 148 149 150 151 152 153 154 155 156
(defvar apropos-synonyms '(
  ("find" "open" "edit")
  ("kill" "cut")
  ("yank" "paste"))
  "List of synonyms known by apropos.
Each element is a list of words where the first word is the standard emacs
term, and the rest of the words are alternative terms.")

(defvar apropos-words ()
  "Current list of words.")

(defvar apropos-all-words ()
  "Current list of words and synonyms.")

157 158 159 160 161

;;; Button types used by apropos

(define-button-type 'apropos-symbol
  'face apropos-symbol-face
162 163 164
  'help-echo "mouse-2, RET: Display more help on this symbol"
  'action #'apropos-symbol-button-display-help
  'skip t)
165 166 167 168 169 170 171

(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)))))

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
(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")
Pavel Janík's avatar
Pavel Janík committed
187

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
;; 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)
209
	    (customize-group-other-window
210 211 212 213 214 215 216 217 218 219 220 221 222
	     (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))))
223 224

(defun apropos-next-label-button (pos)
225
  "Return the next apropos label button after POS, or nil if there's none.
226 227
Will also return nil if more than one `apropos-symbol' button is encountered
before finding a label."
228
  (let* ((button (next-button pos t))
229
	 (already-hit-symbol nil)
230 231
	 (label (and button (button-get button 'apropos-label)))
	 (type (and button (button-get button 'type))))
232
    (while (and button
233 234
		(not label)
		(or (not (eq type 'apropos-symbol))
235
		    (not already-hit-symbol)))
236
      (when (eq type 'apropos-symbol)
237 238 239
	(setq already-hit-symbol t))
      (setq button (next-button (button-start button)))
      (when button
240 241 242
	(setq label (button-get button 'apropos-label))
	(setq type (button-get button 'type))))
    (and label button)))
243

244

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
(defun apropos-words-to-regexp (words wild)
  "Make regexp matching any two of the words in WORDS."
  (concat "\\("
	  (mapconcat 'identity words "\\|")
	  "\\)" wild
	  (if (cdr words) 
	      (concat "\\("
		      (mapconcat 'identity words "\\|")
		      "\\)")
	    "")))

(defun apropos-rewrite-regexp (regexp)
  "Rewrite a list of words to a regexp matching all permutations.
If REGEXP is already a regexp, don't modify it."
  (setq apropos-orig-regexp regexp)
  (setq apropos-words () apropos-all-words ())
  (if (string-equal (regexp-quote regexp) regexp)
      ;; We don't actually make a regexp matching all permutations.
      ;; Instead, for e.g. "a b c", we make a regexp matching
      ;; any combination of two or more words like this:
      ;; (a|b|c).*(a|b|c) which may give some false matches,
      ;; but as long as it also gives the right ones, that's ok.
      (let ((words (split-string regexp "[ \t]+")))
	(dolist (word words)
	  (let ((syn apropos-synonyms) (s word) (a word))
	    (while syn
	      (if (member word (car syn))
		  (progn
		    (setq a (mapconcat 'identity (car syn) "\\|"))
		    (if (member word (cdr (car syn)))
			(setq s a))
		    (setq syn nil))
		(setq syn (cdr syn))))
	    (setq apropos-words (cons s apropos-words)
		  apropos-all-words (cons a apropos-all-words))))
	(setq apropos-all-regexp (apropos-words-to-regexp apropos-all-words ".+"))
	(apropos-words-to-regexp apropos-words ".*?"))
    (setq apropos-all-regexp regexp)))

(defun apropos-calc-scores (str words)
  "Return apropos scores for string STR matching WORDS.
Value is a list of offsets of the words into the string."
  (let ((scores ())
	i)
    (if words
	(dolist (word words scores)
	  (if (setq i (string-match word str))
	      (setq scores (cons i scores))))
      ;; Return list of start and end position of regexp
      (string-match apropos-regexp str)
      (list (match-beginning 0) (match-end 0)))))

(defun apropos-score-str (str)
  "Return apropos score for string STR."
  (if str
300 301 302
      (let* (
	     (l (length str))
	     (score (- (/ l 10)))
303 304
	    i)
	(dolist (s (apropos-calc-scores str apropos-all-words) score)
305
	  (setq score (+ score 1000 (/ (* (- l s) 1000) l)))))
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
      0))

(defun apropos-score-doc (doc)
  "Return apropos score for documentation string DOC."
  (if doc
      (let ((score 0)
	    (l (length doc))
	    i)
	(dolist (s (apropos-calc-scores doc apropos-all-words) score)
	  (setq score (+ score 50 (/ (* (- l s) 50) l)))))
      0))
	  
(defun apropos-score-symbol (symbol &optional weight)
  "Return apropos score for SYMBOL."
  (setq symbol (symbol-name symbol))
  (let ((score 0)
	(l (length symbol))
	i)
    (dolist (s (apropos-calc-scores symbol apropos-words) (* score (or weight 3)))
      (setq score (+ score (- 60 l) (/ (* (- l s) 60) l))))))

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
(defun apropos-true-hit (str words)
  "Return t if STR is a genuine hit.
This may fail if only one of the keywords is matched more than once.
This requires that at least 2 keywords (unless only one was given)."
  (or (not str)
      (not words)
      (not (cdr words))
      (> (length (apropos-calc-scores str words)) 1)))

(defun apropos-false-hit-symbol (symbol)
  "Return t if SYMBOL is not really matched by the current keywords."
  (not (apropos-true-hit (symbol-name symbol) apropos-words)))

(defun apropos-false-hit-str (str)
  "Return t if STR is not really matched by the current keywords."
  (not (apropos-true-hit str apropos-words)))

(defun apropos-true-hit-doc (doc)
  "Return t if DOC is really matched by the current keywords."
  (apropos-true-hit doc apropos-all-words))

348
;;;###autoload
349
(define-derived-mode apropos-mode fundamental-mode "Apropos"
350 351
  "Major mode for following hyperlinks in output of apropos commands.

352
\\{apropos-mode-map}")
353

354
;;;###autoload
355 356
(defun apropos-variable (regexp &optional do-all)
  "Show user variables that match REGEXP.
Dave Love's avatar
Dave Love committed
357
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also show
358 359 360 361 362 363
normal variables."
  (interactive (list (read-string
                      (concat "Apropos "
                              (if (or current-prefix-arg apropos-do-all)
				  "variable"
				"user option")
364
                              " (regexp or words): "))
365 366
                     current-prefix-arg))
  (apropos-command regexp nil
367
		   (if (or do-all apropos-do-all)
368 369 370 371
		       #'(lambda (symbol)
			   (and (boundp symbol)
				(get symbol 'variable-documentation)))
		     'user-variable-p)))
372

373 374
;; For auld lang syne:
;;;###autoload
375
(defalias 'command-apropos 'apropos-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
376
;;;###autoload
377
(defun apropos-command (apropos-regexp &optional do-all var-predicate)
Dave Love's avatar
Dave Love committed
378 379
  "Show commands (interactively callable functions) that match APROPOS-REGEXP.
With optional prefix DO-ALL, or if `apropos-do-all' is non-nil, also show
380
noninteractive functions.
381

382
If VAR-PREDICATE is non-nil, show only variables, and only those that
383
satisfy the predicate VAR-PREDICATE."
384 385 386 387
  (interactive (list (read-string (concat
				   "Apropos command "
				   (if (or current-prefix-arg
					   apropos-do-all)
388
				       "or function ")
389
				   "(regexp or words): "))
390
		     current-prefix-arg))
391
  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
392
  (let ((message
393
	 (let ((standard-output (get-buffer-create "*Apropos*")))
394
	   (print-help-return-message 'identity))))
395 396 397
    (or do-all (setq do-all apropos-do-all))
    (setq apropos-accumulator
	  (apropos-internal apropos-regexp
398 399
			    (or var-predicate
				(if do-all 'functionp 'commandp))))
400 401
    (let ((tem apropos-accumulator))
      (while tem
402 403
	(if (or (get (car tem) 'apropos-inhibit)
		(apropos-false-hit-symbol (car tem)))
404 405
	    (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
	(setq tem (cdr tem))))
406
    (let ((p apropos-accumulator)
407
	  doc symbol score)
408 409 410
      (while p
	(setcar p (list
		   (setq symbol (car p))
411
		   (setq score (apropos-score-symbol symbol))
412 413 414
		   (unless var-predicate
		     (if (functionp symbol)
			 (if (setq doc (documentation symbol t))
415 416 417
			     (progn
			       (setq score (+ score (apropos-score-doc doc))) 
			       (substring doc 0 (string-match "\n" doc)))
418 419 420 421 422
			   "(not documented)")))
		   (and var-predicate
			(funcall var-predicate symbol)
			(if (setq doc (documentation-property
				       symbol 'variable-documentation t))
423 424 425 426 427
			     (progn
			       (setq score (+ score (apropos-score-doc doc)))
			       (substring doc 0
					  (string-match "\n" doc)))))))
	(setcar (cdr (car p)) score)
428 429 430 431
	(setq p (cdr p))))
    (and (apropos-print t nil)
	 message
	 (message message))))
432 433 434


;;;###autoload
435 436 437 438 439 440 441 442
(defun apropos-documentation-property (symbol property raw)
  "Like (documentation-property SYMBOL PROPERTY RAW) but handle errors."
  (condition-case ()
      (let ((doc (documentation-property symbol property raw)))
	(if doc (substring doc 0 (string-match "\n" doc))
	  "(not documented)"))
    (error "(error retrieving documentation)")))

443 444

;;;###autoload
445
(defun apropos (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
446 447 448 449
  "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."
450 451
  (interactive "sApropos symbol (regexp or words): \nP")
  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
452 453 454 455 456 457 458
  (setq apropos-accumulator
	(apropos-internal apropos-regexp
			  (and (not do-all)
			       (not apropos-do-all)
			       (lambda (symbol)
				 (or (fboundp symbol)
				     (boundp symbol)
459
				     (facep symbol)
460
				     (symbol-plist symbol))))))
461 462 463 464 465
  (let ((tem apropos-accumulator))
    (while tem
      (if (get (car tem) 'apropos-inhibit)
	  (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
      (setq tem (cdr tem))))
466 467 468 469 470
  (let ((p apropos-accumulator)
	symbol doc properties)
    (while p
      (setcar p (list
		 (setq symbol (car p))
471
		 0
472 473 474 475
		 (when (fboundp symbol)
		   (if (setq doc (condition-case nil
				     (documentation symbol t)
				   (void-function
476 477
				    "(alias for undefined function)")
				   (error
478
				    "(error retrieving function documentation)")))
479 480 481
		       (substring doc 0 (string-match "\n" doc))
		     "(not documented)"))
		 (when (boundp symbol)
482 483
		   (apropos-documentation-property
		    symbol 'variable-documentation t))
484 485 486 487 488 489
		 (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)
490 491
		   (apropos-documentation-property
		    symbol 'widget-documentation t))
492
		 (when (facep symbol)
493 494
		   (apropos-documentation-property
		    symbol 'face-documentation t))
495
		 (when (get symbol 'custom-group)
496 497
		   (apropos-documentation-property
		    symbol 'group-documentation t))))
498
      (setq p (cdr p))))
499
  (apropos-print
500
   (or do-all apropos-do-all)
501 502 503
   nil))


Richard M. Stallman's avatar
Richard M. Stallman committed
504
;;;###autoload
505
(defun apropos-value (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
506 507
  "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
508
at the function and at the names and values of properties.
509
Returns list of symbols and values found."
510 511
  (interactive "sApropos value (regexp or words): \nP")
  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
512 513 514
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator ())
   (let (f v p)
515 516 517
     (mapatoms
      (lambda (symbol)
	(setq f nil v nil p nil)
518 519 520 521 522
	(or (memq symbol '(apropos-regexp
			   apropos-orig-regexp apropos-all-regexp
			   apropos-words apropos-all-words
			   do-all apropos-accumulator
			   symbol f v p))
523
	    (setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
524
	(if do-all
525 526
	    (setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
		  p (apropos-format-plist symbol "\n    " t)))
527 528 529 530 531 532
	(if (apropos-false-hit-str v)
	    (setq v nil))
	(if (apropos-false-hit-str f)
	    (setq f nil))
	(if (apropos-false-hit-str p)
	    (setq p nil))
533
	(if (or f v p)
534 535 536 537 538
	    (setq apropos-accumulator (cons (list symbol 
						  (+ (apropos-score-str f)
						     (apropos-score-str v)
						     (apropos-score-str p))
						  f v p)
539
					    apropos-accumulator))))))
540
  (apropos-print nil "\n----------------\n"))
541 542


543 544
;;;###autoload
(defun apropos-documentation (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
545 546
  "Show symbols whose documentation contain matches for APROPOS-REGEXP.
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also use
547 548 549
documentation that is not stored in the documentation file and show key
bindings.
Returns list of symbols and documentation found."
550 551
  (interactive "sApropos documentation (regexp or words): \nP")
  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
552 553 554
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator () apropos-files-scanned ())
  (let ((standard-input (get-buffer-create " apropos-temp"))
555
	f v sf sv)
556 557 558 559 560 561 562 563
    (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)
564 565 566 567
		       v (get symbol 'variable-documentation))
		 (if (integerp v) (setq v))
		 (setq f (apropos-documentation-internal f)
		       v (apropos-documentation-internal v))
568 569
		 (setq sf (apropos-score-doc f)
		       sv (apropos-score-doc v))
570 571 572 573 574
		 (if (or f v)
		     (if (setq apropos-item
			       (cdr (assq symbol apropos-accumulator)))
			 (progn
			   (if f
575 576 577
			       (progn
				 (setcar (nthcdr 1 apropos-item) f)
				 (setcar apropos-item (+ (car apropos-item) sf))))
578
			   (if v
579 580 581
			       (progn
				 (setcar (nthcdr 2 apropos-item) v)
				 (setcar apropos-item (+ (car apropos-item) sv)))))
582
		       (setq apropos-accumulator
583 584 585
			     (cons (list symbol 
					 (+ (apropos-score-symbol symbol 2) sf sv)
					 f v)
586
				   apropos-accumulator)))))))
587
	  (apropos-print nil "\n----------------\n"))
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
      (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
607
	 (string-match apropos-all-regexp doc)
608
	 (save-match-data (apropos-true-hit-doc doc))
609 610 611 612 613 614 615 616 617
	 (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)
618 619 620 621
  (setq pl (symbol-plist pl))
  (let (p p-out)
    (while pl
      (setq p (format "%s %S" (car pl) (nth 1 pl)))
622 623
      (if (or (not compare) (string-match apropos-regexp p))
	  (if apropos-property-face
624
	      (put-text-property 0 (length (symbol-name (car pl)))
625
				 'face apropos-property-face p))
626
	(setq p nil))
627 628 629 630 631 632 633
      (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))))
634 635 636
      (setq pl (nthcdr 2 pl)))
    p-out))

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

638
;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
639

640
(defun apropos-documentation-check-doc-file ()
641 642 643
  (let (type symbol (sepa 2) sepb beg end)
    (insert ?\^_)
    (backward-char)
644
    (insert-file-contents (concat doc-directory internal-doc-file-name))
645 646 647 648 649 650 651
    (forward-char)
    (while (save-excursion
	     (setq sepb (search-forward "\^_"))
	     (not (eobp)))
      (beginning-of-line 2)
      (if (save-restriction
	    (narrow-to-region (point) (1- sepb))
652
	    (re-search-forward apropos-all-regexp nil t))
653 654 655 656
	  (progn
	    (setq beg (match-beginning 0)
		  end (point))
	    (goto-char (1+ sepa))
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
	    (setq type (if (eq ?F (preceding-char))
			   2	; function documentation
			 3)		; variable documentation
		  symbol (read)
		  beg (- beg (point) 1)
		  end (- end (point) 1)
		  doc (buffer-substring (1+ (point)) (1- sepb)))
	    (when (apropos-true-hit-doc doc)
	      (or (and (setq apropos-item (assq symbol apropos-accumulator))
		       (setcar (cdr apropos-item)
			       (+ (cadr apropos-item) (apropos-score-doc doc))))
		  (setq apropos-item (list symbol 
					   (+ (apropos-score-symbol symbol 2)
					      (apropos-score-doc doc))
					   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))))
677
      (setq sepa (goto-char sepb)))))
678 679 680 681

(defun apropos-documentation-check-elc-file (file)
  (if (member file apropos-files-scanned)
      nil
682
    (let (symbol doc beg end this-is-a-variable)
683 684 685 686 687 688
      (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)
689 690 691 692 693 694
	      beg (1+ (point))
	      end (+ (point) end -1))
	(forward-char)
	(if (save-restriction
	      ;; match ^ and $ relative to doc string
	      (narrow-to-region beg end)
695
	      (re-search-forward apropos-all-regexp nil t))
696
	    (progn
697 698 699
	      (goto-char (+ end 2))
	      (setq doc (buffer-substring beg end)
		    end (- (match-end 0) beg)
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
		    beg (- (match-beginning 0) beg))
	      (when (apropos-true-hit-doc doc)
		(setq this-is-a-variable (looking-at "(def\\(var\\|const\\) ")
		      symbol (progn
			       (skip-chars-forward "(a-z")
			       (forward-char)
			       (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 (and (setq apropos-item (assq symbol apropos-accumulator))
			       (setcar (cdr apropos-item)
				       (+ (cadr apropos-item) (apropos-score-doc doc))))
			  (setq apropos-item (list symbol
						   (+ (apropos-score-symbol symbol 2)
						      (apropos-score-doc doc))
						   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 (if this-is-a-variable 3 2)
				      apropos-item)
			      doc))))))))))
729 730 731 732



(defun apropos-safe-documentation (function)
Dave Love's avatar
Dave Love committed
733
  "Like `documentation', except it avoids calling `get_doc_string'.
Richard M. Stallman's avatar
Richard M. Stallman committed
734
Will return nil instead."
735
  (while (and function (symbolp function))
Richard M. Stallman's avatar
Richard M. Stallman committed
736
    (setq function (if (fboundp function)
737
		       (symbol-function function))))
738 739
  (if (eq (car-safe function) 'macro)
      (setq function (cdr function)))
740
  (setq function (if (byte-code-function-p function)
741 742 743 744 745 746 747 748 749 750 751 752 753 754
		     (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))


755 756 757
(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.
758 759
Each element should have the format 
 (SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
760 761
The return value is the list that was in `apropos-accumulator', sorted
alphabetically by symbol name; but this function also sets
762 763 764 765
`apropos-accumulator' to nil before returning.

If SPACING is non-nil, it should be a string;
separate items with that string."
766
  (if (null apropos-accumulator)
767
      (message "No apropos matches for `%s'" apropos-orig-regexp)
768 769
    (setq apropos-accumulator
	  (sort apropos-accumulator (lambda (a b)
770 771 772
				      (or (> (cadr a) (cadr b))
					  (and (= (cadr a) (cadr b))
					       (string-lessp (car a) (car b)))))))
773
    (with-output-to-temp-buffer "*Apropos*"
774
      (let ((p apropos-accumulator)
775
	    (old-buffer (current-buffer))
776
	    symbol item)
777 778
	(set-buffer standard-output)
	(apropos-mode)
779
	(if (display-mouse-p)
780 781 782 783 784
	    (insert
	     "If moving the mouse over text changes the text's color, "
	     "you can click\n"
	     "mouse-2 (second button from right) on that text to "
	     "get more information.\n"))
785
	(insert "In this buffer, go to the name of the command, or function,"
786 787 788
		" or variable,\n"
		(substitute-command-keys
		 "and type \\[apropos-follow] to get full documentation.\n\n"))
789
	(while (consp p)
790 791
	  (when (and spacing (not (bobp)))
	    (princ spacing))
792 793
	  (setq apropos-item (car p)
		symbol (car apropos-item)
794 795 796 797 798 799 800
		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)
801 802
	  (if apropos-show-scores
	      (insert " (" (number-to-string (cadr apropos-item)) ") "))
803
	  ;; Calculate key-bindings if we want them.
804 805 806
	  (and do-keys
	       (commandp symbol)
	       (indent-to 30 1)
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
	       (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
829
		    (mapconcat
830
		     (lambda (key)
Dave Love's avatar
Dave Love committed
831
		       (setq key (condition-case ()
832 833
				     (key-description key)
				   (error)))
834
		       (if apropos-keybinding-face
835 836
			   (put-text-property 0 (length key)
					      'face apropos-keybinding-face
837 838 839
					      key))
		       key)
		     item ", "))
840 841 842 843 844 845 846
		 (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)))
847
	  (terpri)
848
	  (apropos-print-doc 2
849
			     (if (commandp symbol)
850
				 'apropos-command
851
			       (if (apropos-macrop symbol)
852 853
				   'apropos-macro
				 'apropos-function))
854
			     t)
855 856 857 858 859
	  (apropos-print-doc 3 'apropos-variable t)
	  (apropos-print-doc 7 'apropos-group t)
	  (apropos-print-doc 6 'apropos-face t)
	  (apropos-print-doc 5 'apropos-widget t)
	  (apropos-print-doc 4 'apropos-plist nil))
860
	(setq buffer-read-only t))))
861 862 863
  (prog1 apropos-accumulator
    (setq apropos-accumulator ())))	; permit gc

864

865 866 867 868 869 870 871 872 873
(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))))))
874

875

876
(defun apropos-print-doc (i type do-keys)
877
  (if (stringp (setq i (nth i apropos-item)))
878 879
      (progn
	(insert "  ")
880 881
	(insert-text-button (button-type-get type 'apropos-label)
			    'type type
882 883 884 885
			    ;; 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
886
			    'apropos-symbol (car apropos-item))
887
	(insert ": ")
888 889
	(insert (if do-keys (substitute-command-keys i) i))
	(or (bolp) (terpri)))))
890 891


892 893
(defun apropos-follow ()
  "Invokes any button at point, otherwise invokes the nearest label button."
894
  (interactive)
895 896 897
  (button-activate
   (or (apropos-next-label-button (line-beginning-position))
       (error "There is nothing to follow here"))))
898 899 900 901 902 903 904 905 906


(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 (")
907 908
    (if apropos-symbol-face
	(put-text-property 8 (- (point) 14) 'face apropos-symbol-face))
909
    (insert (apropos-format-plist symbol "\n  "))
910 911
    (princ ")")
    (print-help-return-message)))
Richard M. Stallman's avatar
Richard M. Stallman committed
912

913

Richard M. Stallman's avatar
Richard M. Stallman committed
914 915
(provide 'apropos)

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