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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
10 11 12 13
;; 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
14
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
15 16 17 18 19 20 21 22
;; 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
23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
26

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

;; 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.
41 42
;;; Made fast-apropos and super-apropos share code.
;;; Sped up fast-apropos again.
Richard M. Stallman's avatar
Richard M. Stallman committed
43
;; Added apropos-do-all option.
44
;;; Added fast-command-apropos.
Richard M. Stallman's avatar
Richard M. Stallman committed
45
;; Changed doc strings to comments for helping functions.
46
;;; Made doc file buffer read-only, buried it.
Richard M. Stallman's avatar
Richard M. Stallman committed
47 48
;; Only call substitute-command-keys if do-all set.

49 50
;; Optionally use configurable faces to make the output more legible.
;; Differentiate between command, function and macro.
51 52 53 54 55 56 57 58
;; 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
59 60
;;; Code:

Miles Bader's avatar
Miles Bader committed
61
(require 'button)
62
(eval-when-compile (require 'cl))
Miles Bader's avatar
Miles Bader committed
63

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

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

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


78 79
(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
80 81
  :group 'apropos
  :type 'face)
82

83 84
(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
85 86
  :group 'apropos
  :type 'face)
87

88 89 90 91
(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
92 93
  :group 'apropos
  :type 'face)
94

95 96
(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
97 98
  :group 'apropos
  :type 'face)
99

100
(defcustom apropos-match-face 'match
101 102 103
  "*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
104 105
  :group 'apropos
  :type 'face)
106

107 108 109
(defcustom apropos-sort-by-scores nil
  "*Non-nil means sort matches by scores; best match is shown first.
The computed score is shown for each match."
110 111
  :group 'apropos
  :type 'boolean)
Richard M. Stallman's avatar
Richard M. Stallman committed
112

113
(defvar apropos-mode-map
114
  (let ((map (make-sparse-keymap)))
115 116 117 118
    (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.
119
    (define-key map "\C-m" 'apropos-follow)
120 121 122
    (define-key map " "    'scroll-up)
    (define-key map "\177" 'scroll-down)
    (define-key map "q"    'quit-window)
123
    map)
124
  "Keymap used in Apropos mode.")
125

Gerd Moellmann's avatar
Gerd Moellmann committed
126 127
(defvar apropos-mode-hook nil
  "*Hook run when mode is turned on.")
128

129
(defvar apropos-pattern nil
130 131
  "Regexp used in current apropos run.")

132
(defvar apropos-orig-pattern nil
133 134 135 136 137
  "Regexp as entered by user.")

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

138
(defvar apropos-files-scanned ()
Karl Heuer's avatar
Karl Heuer committed
139
  "List of elc files already scanned in current run of `apropos-documentation'.")
140 141 142

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

144
(defvar apropos-item ()
Dave Love's avatar
Dave Love committed
145
  "Current item in or for `apropos-accumulator'.")
146

147 148 149 150 151 152 153 154 155 156 157 158 159 160
(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.")

161 162 163 164 165

;;; Button types used by apropos

(define-button-type 'apropos-symbol
  'face apropos-symbol-face
166
  'help-echo "mouse-2, RET: Display more help on this symbol"
167
  'follow-link t
168 169
  'action #'apropos-symbol-button-display-help
  'skip t)
170 171 172 173 174 175 176

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

177 178
(define-button-type 'apropos-function
  'apropos-label "Function"
179 180
  'help-echo "mouse-2, RET: Display more help on this function"
  'follow-link t
181
  'action (lambda (button)
182 183
	    (describe-function (button-get button 'apropos-symbol))))

184 185
(define-button-type 'apropos-macro
  'apropos-label "Macro"
186 187
  'help-echo "mouse-2, RET: Display more help on this macro"
  'follow-link t
188
  'action (lambda (button)
189 190
	    (describe-function (button-get button 'apropos-symbol))))

191 192
(define-button-type 'apropos-command
  'apropos-label "Command"
193 194
  'help-echo "mouse-2, RET: Display more help on this command"
  'follow-link t
195
  'action (lambda (button)
196
	    (describe-function (button-get button 'apropos-symbol))))
Pavel Janík's avatar
Pavel Janík committed
197

198 199 200 201 202 203 204 205
;; 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"
206
  'follow-link t
207 208 209 210 211 212
  '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"
213
  'follow-link t
214 215 216 217 218 219
  '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"
220
  'follow-link t
221
  'action (lambda (button)
222
	    (customize-group-other-window
223 224 225 226 227
	     (button-get button 'apropos-symbol))))

(define-button-type 'apropos-widget
  'apropos-label "Widget"
  'help-echo "mouse-2, RET: Display more help on this widget"
228
  'follow-link t
229 230 231 232 233 234
  '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"
235
  'follow-link t
236 237
  'action (lambda (button)
	    (apropos-describe-plist (button-get button 'apropos-symbol))))
238 239

(defun apropos-next-label-button (pos)
240
  "Return the next apropos label button after POS, or nil if there's none.
241 242
Will also return nil if more than one `apropos-symbol' button is encountered
before finding a label."
243
  (let* ((button (next-button pos t))
244
	 (already-hit-symbol nil)
245 246
	 (label (and button (button-get button 'apropos-label)))
	 (type (and button (button-get button 'type))))
247
    (while (and button
248 249
		(not label)
		(or (not (eq type 'apropos-symbol))
250
		    (not already-hit-symbol)))
251
      (when (eq type 'apropos-symbol)
252 253 254
	(setq already-hit-symbol t))
      (setq button (next-button (button-start button)))
      (when button
255 256 257
	(setq label (button-get button 'apropos-label))
	(setq type (button-get button 'type))))
    (and label button)))
258

259

260 261 262 263
(defun apropos-words-to-regexp (words wild)
  "Make regexp matching any two of the words in WORDS."
  (concat "\\("
	  (mapconcat 'identity words "\\|")
264
	  "\\)"
265
	  (if (cdr words)
266 267
	      (concat wild
		      "\\("
268 269 270 271 272
		      (mapconcat 'identity words "\\|")
		      "\\)")
	    "")))

(defun apropos-rewrite-regexp (regexp)
273 274 275 276
  "Rewrite a space-separated words list to a regexp matching all permutations.
If REGEXP contains any special regexp characters, that means it
is already a regexp, so return it unchanged."
  (setq apropos-orig-pattern regexp)
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
  (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
311
      (string-match apropos-pattern str)
312 313 314 315 316
      (list (match-beginning 0) (match-end 0)))))

(defun apropos-score-str (str)
  "Return apropos score for string STR."
  (if str
317 318 319
      (let* (
	     (l (length str))
	     (score (- (/ l 10)))
320 321
	    i)
	(dolist (s (apropos-calc-scores str apropos-all-words) score)
322
	  (setq score (+ score 1000 (/ (* (- l s) 1000) l)))))
323 324 325 326
      0))

(defun apropos-score-doc (doc)
  "Return apropos score for documentation string DOC."
327 328 329 330 331 332 333
  (let ((l (length doc)))
    (if (> l 0)
	(let ((score 0)
	      i)
	  (dolist (s (apropos-calc-scores doc apropos-all-words) score)
	    (setq score (+ score 50 (/ (* (- l s) 50) l)))))
      0)))
334

335 336 337 338 339 340 341 342 343
(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))))))

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
(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))

365
(define-derived-mode apropos-mode fundamental-mode "Apropos"
366 367
  "Major mode for following hyperlinks in output of apropos commands.

368
\\{apropos-mode-map}")
369

370
;;;###autoload
371 372
(defun apropos-variable (regexp &optional do-all)
  "Show user variables that match REGEXP.
Dave Love's avatar
Dave Love committed
373
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also show
374 375 376 377 378 379
normal variables."
  (interactive (list (read-string
                      (concat "Apropos "
                              (if (or current-prefix-arg apropos-do-all)
				  "variable"
				"user option")
380
                              " (word list or regexp): "))
381 382
                     current-prefix-arg))
  (apropos-command regexp nil
383
		   (if (or do-all apropos-do-all)
384 385 386 387
		       #'(lambda (symbol)
			   (and (boundp symbol)
				(get symbol 'variable-documentation)))
		     'user-variable-p)))
388

389 390
;; For auld lang syne:
;;;###autoload
391
(defalias 'command-apropos 'apropos-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
392
;;;###autoload
393 394 395 396 397 398 399
(defun apropos-command (apropos-pattern &optional do-all var-predicate)
  "Show commands (interactively callable functions) that match APROPOS-PATTERN.
APROPOS-PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters).  If it is a word,
search for matches for that word as a substring.  If it is a list of words,
search for matches for any two (or more) of those words.

Dave Love's avatar
Dave Love committed
400
With optional prefix DO-ALL, or if `apropos-do-all' is non-nil, also show
401
noninteractive functions.
402

403
If VAR-PREDICATE is non-nil, show only variables, and only those that
404
satisfy the predicate VAR-PREDICATE."
405 406 407 408
  (interactive (list (read-string (concat
				   "Apropos command "
				   (if (or current-prefix-arg
					   apropos-do-all)
409
				       "or function ")
410
				   "(word list or regexp): "))
411
		     current-prefix-arg))
412
  (setq apropos-pattern (apropos-rewrite-regexp apropos-pattern))
413
  (let ((message
414
	 (let ((standard-output (get-buffer-create "*Apropos*")))
415
	   (print-help-return-message 'identity))))
416 417
    (or do-all (setq do-all apropos-do-all))
    (setq apropos-accumulator
418
	  (apropos-internal apropos-pattern
419 420
			    (or var-predicate
				(if do-all 'functionp 'commandp))))
421 422
    (let ((tem apropos-accumulator))
      (while tem
423 424
	(if (or (get (car tem) 'apropos-inhibit)
		(apropos-false-hit-symbol (car tem)))
425 426
	    (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
	(setq tem (cdr tem))))
427
    (let ((p apropos-accumulator)
428
	  doc symbol score)
429 430 431
      (while p
	(setcar p (list
		   (setq symbol (car p))
432
		   (setq score (apropos-score-symbol symbol))
433 434 435
		   (unless var-predicate
		     (if (functionp symbol)
			 (if (setq doc (documentation symbol t))
436
			     (progn
437
			       (setq score (+ score (apropos-score-doc doc)))
438
			       (substring doc 0 (string-match "\n" doc)))
439 440 441 442 443
			   "(not documented)")))
		   (and var-predicate
			(funcall var-predicate symbol)
			(if (setq doc (documentation-property
				       symbol 'variable-documentation t))
444 445 446 447 448
			     (progn
			       (setq score (+ score (apropos-score-doc doc)))
			       (substring doc 0
					  (string-match "\n" doc)))))))
	(setcar (cdr (car p)) score)
449 450 451
	(setq p (cdr p))))
    (and (apropos-print t nil)
	 message
Deepak Goel's avatar
Deepak Goel committed
452
	 (message "%s" message))))
453 454 455


;;;###autoload
456 457 458 459 460 461 462 463
(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)")))

464 465

;;;###autoload
466 467 468 469 470 471 472
(defun apropos (apropos-pattern &optional do-all)
  "Show all bound symbols whose names match APROPOS-PATTERN.
APROPOS-PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters).  If it is a word,
search for matches for that word as a substring.  If it is a list of words,
search for matches for any two (or more) of those words.

Dave Love's avatar
Dave Love committed
473 474 475
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."
476 477
  (interactive "sApropos symbol (word list or regexp): \nP")
  (setq apropos-pattern (apropos-rewrite-regexp apropos-pattern))
478
  (apropos-symbols-internal
479
   (apropos-internal apropos-pattern
480 481 482 483 484
			  (and (not do-all)
			       (not apropos-do-all)
			       (lambda (symbol)
				 (or (fboundp symbol)
				     (boundp symbol)
485
				     (facep symbol)
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 511 512 513
				     (symbol-plist symbol)))))
   (or do-all apropos-do-all)))

(defun apropos-symbols-internal (symbols keys &optional text)
  ;; Filter out entries that are marked as apropos-inhibit.
  (let ((all nil))
    (dolist (symbol symbols)
      (unless (get symbol 'apropos-inhibit)
	(push symbol all)))
    (setq symbols all))
  (let ((apropos-accumulator
	 (mapcar
	  (lambda (symbol)
	    (let (doc properties)
	      (list
	       symbol
	       (apropos-score-symbol symbol)
	       (when (fboundp symbol)
		 (if (setq doc (condition-case nil
				   (documentation symbol t)
				 (void-function
				  "(alias for undefined function)")
				 (error
				  "(can't retrieve function documentation)")))
		     (substring doc 0 (string-match "\n" doc))
		   "(not documented)"))
	       (when (boundp symbol)
		 (apropos-documentation-property
514
		    symbol 'variable-documentation t))
515 516 517 518 519 520
		 (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)
521 522
		   (apropos-documentation-property
		    symbol 'widget-documentation t))
523 524 525 526
	       (when (facep symbol)
		 (apropos-documentation-property
		  symbol 'face-documentation t))
	       (when (get symbol 'custom-group)
527
		   (apropos-documentation-property
528 529 530
		    symbol 'group-documentation t)))))
	  symbols)))
    (apropos-print keys nil text)))
531 532


Richard M. Stallman's avatar
Richard M. Stallman committed
533
;;;###autoload
534 535 536 537 538 539 540
(defun apropos-value (apropos-pattern &optional do-all)
  "Show all symbols whose value's printed image matches APROPOS-PATTERN.
APROPOS-PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters).  If it is a word,
search for matches for that word as a substring.  If it is a list of words,
search for matches for any two (or more) of those words.

Dave Love's avatar
Dave Love committed
541
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also looks
542
at the function and at the names and values of properties.
543
Returns list of symbols and values found."
544 545
  (interactive "sApropos value (word list or regexp): \nP")
  (setq apropos-pattern (apropos-rewrite-regexp apropos-pattern))
546 547 548
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator ())
   (let (f v p)
549 550 551
     (mapatoms
      (lambda (symbol)
	(setq f nil v nil p nil)
552 553
	(or (memq symbol '(apropos-pattern
			   apropos-orig-pattern apropos-all-regexp
554 555 556
			   apropos-words apropos-all-words
			   do-all apropos-accumulator
			   symbol f v p))
557
	    (setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
558
	(if do-all
559 560
	    (setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
		  p (apropos-format-plist symbol "\n    " t)))
561 562 563 564 565 566
	(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))
567
	(if (or f v p)
568
	    (setq apropos-accumulator (cons (list symbol
569 570 571 572
						  (+ (apropos-score-str f)
						     (apropos-score-str v)
						     (apropos-score-str p))
						  f v p)
573
					    apropos-accumulator))))))
574
  (apropos-print nil "\n----------------\n"))
575 576


577
;;;###autoload
578 579 580 581 582 583 584
(defun apropos-documentation (apropos-pattern &optional do-all)
  "Show symbols whose documentation contain matches for APROPOS-PATTERN.
APROPOS-PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters).  If it is a word,
search for matches for that word as a substring.  If it is a list of words,
search for matches for any two (or more) of those words.

Dave Love's avatar
Dave Love committed
585
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also use
586 587 588
documentation that is not stored in the documentation file and show key
bindings.
Returns list of symbols and documentation found."
589 590
  (interactive "sApropos documentation (word list or regexp): \nP")
  (setq apropos-pattern (apropos-rewrite-regexp apropos-pattern))
591 592 593
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator () apropos-files-scanned ())
  (let ((standard-input (get-buffer-create " apropos-temp"))
594
	f v sf sv)
595 596 597 598 599 600 601 602
    (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)
603 604 605 606
		       v (get symbol 'variable-documentation))
		 (if (integerp v) (setq v))
		 (setq f (apropos-documentation-internal f)
		       v (apropos-documentation-internal v))
607 608
		 (setq sf (apropos-score-doc f)
		       sv (apropos-score-doc v))
609 610 611 612 613
		 (if (or f v)
		     (if (setq apropos-item
			       (cdr (assq symbol apropos-accumulator)))
			 (progn
			   (if f
614 615 616
			       (progn
				 (setcar (nthcdr 1 apropos-item) f)
				 (setcar apropos-item (+ (car apropos-item) sf))))
617
			   (if v
618 619 620
			       (progn
				 (setcar (nthcdr 2 apropos-item) v)
				 (setcar apropos-item (+ (car apropos-item) sv)))))
621
		       (setq apropos-accumulator
622
			     (cons (list symbol
623 624
					 (+ (apropos-score-symbol symbol 2) sf sv)
					 f v)
625
				   apropos-accumulator)))))))
626
	  (apropos-print nil "\n----------------\n"))
627 628 629 630 631 632 633
      (kill-buffer standard-input))))


(defun apropos-value-internal (predicate symbol function)
  (if (funcall predicate symbol)
      (progn
	(setq symbol (prin1-to-string (funcall function symbol)))
634
	(if (string-match apropos-pattern symbol)
635 636 637 638 639 640 641 642 643 644 645
	    (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
646
	 (string-match apropos-all-regexp doc)
647
	 (save-match-data (apropos-true-hit-doc doc))
648 649 650 651 652 653 654 655 656
	 (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)
657 658 659 660
  (setq pl (symbol-plist pl))
  (let (p p-out)
    (while pl
      (setq p (format "%s %S" (car pl) (nth 1 pl)))
661
      (if (or (not compare) (string-match apropos-pattern p))
662
	  (if apropos-property-face
663
	      (put-text-property 0 (length (symbol-name (car pl)))
664
				 'face apropos-property-face p))
665
	(setq p nil))
666 667 668 669 670 671 672
      (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))))
673 674 675
      (setq pl (nthcdr 2 pl)))
    p-out))

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

677
;; Finds all documentation related to APROPOS-PATTERN in internal-doc-file-name.
678

679
(defun apropos-documentation-check-doc-file ()
680 681 682
  (let (type symbol (sepa 2) sepb beg end)
    (insert ?\^_)
    (backward-char)
683
    (insert-file-contents (concat doc-directory internal-doc-file-name))
684 685 686 687 688 689 690
    (forward-char)
    (while (save-excursion
	     (setq sepb (search-forward "\^_"))
	     (not (eobp)))
      (beginning-of-line 2)
      (if (save-restriction
	    (narrow-to-region (point) (1- sepb))
691
	    (re-search-forward apropos-all-regexp nil t))
692 693 694 695
	  (progn
	    (setq beg (match-beginning 0)
		  end (point))
	    (goto-char (1+ sepa))
696 697 698 699 700 701 702 703 704 705 706
	    (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))))
707
		  (setq apropos-item (list symbol
708 709 710 711 712 713 714 715
					   (+ (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))))
716
      (setq sepa (goto-char sepb)))))
717 718 719 720

(defun apropos-documentation-check-elc-file (file)
  (if (member file apropos-files-scanned)
      nil
721
    (let (symbol doc beg end this-is-a-variable)
722 723 724 725 726 727
      (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)
728 729 730 731 732 733
	      beg (1+ (point))
	      end (+ (point) end -1))
	(forward-char)
	(if (save-restriction
	      ;; match ^ and $ relative to doc string
	      (narrow-to-region beg end)
734
	      (re-search-forward apropos-all-regexp nil t))
735
	    (progn
736 737 738
	      (goto-char (+ end 2))
	      (setq doc (buffer-substring beg end)
		    end (- (match-end 0) beg)
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
		    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))))))))))
768 769 770 771



(defun apropos-safe-documentation (function)
Dave Love's avatar
Dave Love committed
772
  "Like `documentation', except it avoids calling `get_doc_string'.
Richard M. Stallman's avatar
Richard M. Stallman committed
773
Will return nil instead."
774
  (while (and function (symbolp function))
Richard M. Stallman's avatar
Richard M. Stallman committed
775
    (setq function (if (fboundp function)
776
		       (symbol-function function))))
777 778
  (if (eq (car-safe function) 'macro)
      (setq function (cdr function)))
779
  (setq function (if (byte-code-function-p function)
780 781 782 783 784 785 786 787 788 789 790 791 792 793
		     (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))


794
(defun apropos-print (do-keys spacing &optional text)
795 796
  "Output result of apropos searching into buffer `*Apropos*'.
The value of `apropos-accumulator' is the list of items to output.
797
Each element should have the format
798
 (SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
799 800
The return value is the list that was in `apropos-accumulator', sorted
alphabetically by symbol name; but this function also sets
801 802
`apropos-accumulator' to nil before returning.

803 804
If SPACING is non-nil, it should be a string; separate items with that string.
If non-nil TEXT is a string that will be printed as a heading."
805
  (if (null apropos-accumulator)
806
      (message "No apropos matches for `%s'" apropos-orig-pattern)
807
    (setq apropos-accumulator
808 809 810 811
	  (sort apropos-accumulator
		(lambda (a b)
		  ;; Don't sort by score if user can't see the score.
		  ;; It would be confusing.  -- rms.
812
		  (if apropos-sort-by-scores
813 814 815 816
		      (or (> (cadr a) (cadr b))
			  (and (= (cadr a) (cadr b))
			       (string-lessp (car a) (car b))))
		    (string-lessp (car a) (car b))))))
817
    (with-output-to-temp-buffer "*Apropos*"
818
      (let ((p apropos-accumulator)
819
	    (old-buffer (current-buffer))
820
	    symbol item)
821 822
	(set-buffer standard-output)
	(apropos-mode)
823
	(if (display-mouse-p)
824 825 826 827 828
	    (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"))
829
	(insert "In this buffer, go to the name of the command, or function,"
830 831 832
		" or variable,\n"
		(substitute-command-keys
		 "and type \\[apropos-follow] to get full documentation.\n\n"))
833
	(if text (insert text "\n\n"))
834
	(while (consp p)
835 836
	  (when (and spacing (not (bobp)))
	    (princ spacing))
837 838
	  (setq apropos-item (car p)
		symbol (car apropos-item)
839 840 841 842 843 844 845
		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)
846
	  (if apropos-sort-by-scores
847
	      (insert " (" (number-to-string (cadr apropos-item)) ") "))
848
	  ;; Calculate key-bindings if we want them.
849 850 851
	  (and do-keys
	       (commandp symbol)
	       (indent-to 30 1)
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
	       (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
874
		    (mapconcat
875
		     (lambda (key)
Dave Love's avatar
Dave Love committed
876
		       (setq key (condition-case ()
877 878
				     (key-description key)
				   (error)))
879
		       (if apropos-keybinding-face
880 881
			   (put-text-property 0 (length key)
					      'face apropos-keybinding-face
882 883 884
					      key))
		       key)
		     item ", "))
885 886 887 888 889 890
		 (insert "M-x ... RET")
		 (when apropos-keybinding-face
		   (put-text-property (- (point) 11) (- (point) 8)
				      'face apropos-keybinding-face)
		   (put-text-property (- (point) 3) (point)
				      'face apropos-keybinding-face))))
891
	  (terpri)
892
	  (apropos-print-doc 2
893
			     (if (commandp symbol)
894
				 'apropos-command
895
			       (if (apropos-macrop symbol)
896 897
				   'apropos-macro
				 'apropos-function))
898
			     t)
899 900 901 902 903
	  (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))
904
	(setq buffer-read-only t))))
905 906 907
  (prog1 apropos-accumulator
    (setq apropos-accumulator ())))	; permit gc

908

909
(defun apropos-macrop (symbol)
910
  "Return t if SYMBOL is a Lisp macro."
911 912 913 914 915 916 917
  (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))))))
918

919

920
(defun apropos-print-doc (i type do-keys)
921
  (if (stringp (setq i (nth i apropos-item)))
922 923
      (progn
	(insert "  ")
924 925
	(insert-text-button (button-type-get type 'apropos-label)
			    'type type
926 927 928 929
			    ;; 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
930
			    'apropos-symbol (car apropos-item))
931
	(insert ": ")
932 933
	(insert (if do-keys (substitute-command-keys i) i))
	(or (bolp) (terpri)))))
934 935


936 937
(defun apropos-follow ()
  "Invokes any button at point, otherwise invokes the nearest label button."
938
  (interactive)
939 940 941
  (button-activate
   (or (apropos-next-label-button (line-beginning-position))
       (error "There is nothing to follow here"))))
942 943 944 945


(defun apropos-describe-plist (symbol)
  "Display a pretty listing of SYMBOL's plist."
946 947
  (help-setup-xref (list 'apropos-describe-plist symbol) (interactive-p))
  (with-output-to-temp-buffer (help-buffer)
948 949 950 951
    (set-buffer standard-output)
    (princ "Symbol ")
    (prin1 symbol)
    (princ "'s plist is\n (")
952
    (if apropos-symbol-face
953 954
	(put-text-property (+ (point-min) 7) (- (point) 14)
			   'face apropos-symbol-face))
955
    (insert (apropos-format-plist symbol "\n  "))
956 957
    (princ ")")
    (print-help-return-message)))
Richard M. Stallman's avatar