apropos.el 34.7 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
  "*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
Kim F. Storm's avatar
Kim F. Storm committed
103
for the pattern; 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
(defcustom apropos-sort-by-scores nil
  "*Non-nil means sort matches by scores; best match is shown first.
Kim F. Storm's avatar
Kim F. Storm committed
109 110
This applies to all `apropos' commands except `apropos-documentation'.
If value is `verbose', the computed score is shown for each match."
111
  :group 'apropos
Kim F. Storm's avatar
Kim F. Storm committed
112 113 114 115 116 117 118 119 120 121 122 123
  :type '(choice (const :tag "off" nil)
		 (const :tag "on" t)
		 (const :tag "show scores" verbose)))

(defcustom apropos-documentation-sort-by-scores t
  "*Non-nil means sort matches by scores; best match is shown first.
This applies to `apropos-documentation' only.
If value is `verbose', the computed score is shown for each match."
  :group 'apropos
  :type '(choice (const :tag "off" nil)
		 (const :tag "on" t)
		 (const :tag "show scores" verbose)))
Richard M. Stallman's avatar
Richard M. Stallman committed
124

125
(defvar apropos-mode-map
126
  (let ((map (make-sparse-keymap)))
127 128 129 130
    (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.
131
    (define-key map "\C-m" 'apropos-follow)
132 133 134
    (define-key map " "    'scroll-up)
    (define-key map "\177" 'scroll-down)
    (define-key map "q"    'quit-window)
135
    map)
136
  "Keymap used in Apropos mode.")
137

Gerd Moellmann's avatar
Gerd Moellmann committed
138 139
(defvar apropos-mode-hook nil
  "*Hook run when mode is turned on.")
140

141
(defvar apropos-pattern nil
Kim F. Storm's avatar
Kim F. Storm committed
142 143 144 145 146 147 148
  "Apropos pattern as entered by user.")

(defvar apropos-pattern-quoted nil
  "Apropos pattern passed through `regexp-quoute'.")

(defvar apropos-words ()
  "Current list of apropos words extracted from `apropos-pattern'.")
149

Kim F. Storm's avatar
Kim F. Storm committed
150 151
(defvar apropos-all-words ()
  "Current list of words and synonyms.")
152

Kim F. Storm's avatar
Kim F. Storm committed
153 154 155 156
(defvar apropos-regexp nil
  "Regexp used in current apropos run.")

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

159
(defvar apropos-files-scanned ()
Karl Heuer's avatar
Karl Heuer committed
160
  "List of elc files already scanned in current run of `apropos-documentation'.")
161 162 163

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

165
(defvar apropos-item ()
Dave Love's avatar
Dave Love committed
166
  "Current item in or for `apropos-accumulator'.")
167

168 169 170 171 172 173 174 175
(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.")

176 177 178 179 180

;;; Button types used by apropos

(define-button-type 'apropos-symbol
  'face apropos-symbol-face
181
  'help-echo "mouse-2, RET: Display more help on this symbol"
182
  'follow-link t
183 184
  'action #'apropos-symbol-button-display-help
  'skip t)
185 186 187 188 189 190 191

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

192 193
(define-button-type 'apropos-function
  'apropos-label "Function"
194 195
  'help-echo "mouse-2, RET: Display more help on this function"
  'follow-link t
196
  'action (lambda (button)
197 198
	    (describe-function (button-get button 'apropos-symbol))))

199 200
(define-button-type 'apropos-macro
  'apropos-label "Macro"
201 202
  'help-echo "mouse-2, RET: Display more help on this macro"
  'follow-link t
203
  'action (lambda (button)
204 205
	    (describe-function (button-get button 'apropos-symbol))))

206 207
(define-button-type 'apropos-command
  'apropos-label "Command"
208 209
  'help-echo "mouse-2, RET: Display more help on this command"
  'follow-link t
210
  'action (lambda (button)
211
	    (describe-function (button-get button 'apropos-symbol))))
Pavel Janík's avatar
Pavel Janík committed
212

213 214 215 216 217 218 219 220
;; 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"
221
  'follow-link t
222 223 224 225 226 227
  '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"
228
  'follow-link t
229 230 231 232 233 234
  '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"
235
  'follow-link t
236
  'action (lambda (button)
237
	    (customize-group-other-window
238 239 240 241 242
	     (button-get button 'apropos-symbol))))

(define-button-type 'apropos-widget
  'apropos-label "Widget"
  'help-echo "mouse-2, RET: Display more help on this widget"
243
  'follow-link t
244 245 246 247 248 249
  '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"
250
  'follow-link t
251 252
  'action (lambda (button)
	    (apropos-describe-plist (button-get button 'apropos-symbol))))
253 254

(defun apropos-next-label-button (pos)
255
  "Return the next apropos label button after POS, or nil if there's none.
256 257
Will also return nil if more than one `apropos-symbol' button is encountered
before finding a label."
258
  (let* ((button (next-button pos t))
259
	 (already-hit-symbol nil)
260 261
	 (label (and button (button-get button 'apropos-label)))
	 (type (and button (button-get button 'type))))
262
    (while (and button
263 264
		(not label)
		(or (not (eq type 'apropos-symbol))
265
		    (not already-hit-symbol)))
266
      (when (eq type 'apropos-symbol)
267 268 269
	(setq already-hit-symbol t))
      (setq button (next-button (button-start button)))
      (when button
270 271 272
	(setq label (button-get button 'apropos-label))
	(setq type (button-get button 'type))))
    (and label button)))
273

274

275 276 277 278
(defun apropos-words-to-regexp (words wild)
  "Make regexp matching any two of the words in WORDS."
  (concat "\\("
	  (mapconcat 'identity words "\\|")
279
	  "\\)"
280
	  (if (cdr words)
281 282
	      (concat wild
		      "\\("
283 284 285 286
		      (mapconcat 'identity words "\\|")
		      "\\)")
	    "")))

Kim F. Storm's avatar
Kim F. Storm committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
;;;###autoload
(defun apropos-read-pattern (subject)
  "Read an apropos pattern, either a word list or a regexp.
Returns the user pattern, either a list of words which are matched
literally, or a string which is used as a regexp to search for.

SUBJECT is a string that is included in the prompt to identify what
kind of objects to search."
  (let ((pattern
	 (read-string (concat "Apropos " subject " (word list or regexp): "))))
    (if (string-equal (regexp-quote pattern) pattern)
	;; Split into words
	(split-string pattern "[ \t]+")
      pattern)))

(defun apropos-parse-pattern (pattern)
  "Rewrite a list of words to a regexp matching all permutations.
If PATTERN is a string, that means it is already a regexp."
  (setq apropos-words nil
	apropos-all-words nil)
  (if (consp pattern)
308 309 310 311 312
      ;; 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.
Kim F. Storm's avatar
Kim F. Storm committed
313 314 315
      (let ((words pattern))
	(setq apropos-pattern (mapconcat 'identity pattern " ")
	      apropos-pattern-quoted (regexp-quote apropos-pattern))
316 317 318 319 320 321 322 323 324 325 326 327
	(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))))
Kim F. Storm's avatar
Kim F. Storm committed
328
	(setq apropos-all-words-regexp (apropos-words-to-regexp apropos-all-words ".+"))
329
	(apropos-words-to-regexp apropos-words ".*?"))
Kim F. Storm's avatar
Kim F. Storm committed
330 331 332 333
    (setq apropos-pattern-quoted (regexp-quote pattern)
	  apropos-all-words-regexp pattern
	  apropos-pattern pattern)))

334 335 336 337

(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."
Kim F. Storm's avatar
Kim F. Storm committed
338
  (let (scores i)
339 340 341 342 343
    (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
344
      (and (string-match apropos-pattern str)
Kim F. Storm's avatar
Kim F. Storm committed
345
	   (list (match-beginning 0) (match-end 0))))))
346 347 348 349

(defun apropos-score-str (str)
  "Return apropos score for string STR."
  (if str
Kim F. Storm's avatar
Kim F. Storm committed
350 351
      (let* ((l (length str))
	     (score (- (/ l 10))))
352
	(dolist (s (apropos-calc-scores str apropos-all-words) score)
353
	  (setq score (+ score 1000 (/ (* (- l s) 1000) l)))))
354 355 356 357
      0))

(defun apropos-score-doc (doc)
  "Return apropos score for documentation string DOC."
358 359
  (let ((l (length doc)))
    (if (> l 0)
Kim F. Storm's avatar
Kim F. Storm committed
360 361 362
	(let ((score 0) i)
	  (when (setq i (string-match apropos-pattern-quoted doc))
	    (setq score 10000))
363 364 365
	  (dolist (s (apropos-calc-scores doc apropos-all-words) score)
	    (setq score (+ score 50 (/ (* (- l s) 50) l)))))
      0)))
366

367 368 369 370
(defun apropos-score-symbol (symbol &optional weight)
  "Return apropos score for SYMBOL."
  (setq symbol (symbol-name symbol))
  (let ((score 0)
Kim F. Storm's avatar
Kim F. Storm committed
371
	(l (length symbol)))
372 373 374
    (dolist (s (apropos-calc-scores symbol apropos-words) (* score (or weight 3)))
      (setq score (+ score (- 60 l) (/ (* (- l s) 60) l))))))

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
(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))

396
(define-derived-mode apropos-mode fundamental-mode "Apropos"
397 398
  "Major mode for following hyperlinks in output of apropos commands.

399
\\{apropos-mode-map}")
400

401
;;;###autoload
Kim F. Storm's avatar
Kim F. Storm committed
402 403 404 405 406 407 408 409
(defun apropos-variable (pattern &optional do-all)
  "Show user variables that match PATTERN.
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.

With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also show
410
normal variables."
Kim F. Storm's avatar
Kim F. Storm committed
411 412 413
  (interactive (list (apropos-read-pattern
		      (if (or current-prefix-arg apropos-do-all)
			  "variable" "user option"))
414
                     current-prefix-arg))
Kim F. Storm's avatar
Kim F. Storm committed
415
  (apropos-command pattern nil
416
		   (if (or do-all apropos-do-all)
417 418 419 420
		       #'(lambda (symbol)
			   (and (boundp symbol)
				(get symbol 'variable-documentation)))
		     'user-variable-p)))
421

422 423
;; For auld lang syne:
;;;###autoload
424
(defalias 'command-apropos 'apropos-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
425
;;;###autoload
Kim F. Storm's avatar
Kim F. Storm committed
426 427 428
(defun apropos-command (pattern &optional do-all var-predicate)
  "Show commands (interactively callable functions) that match PATTERN.
PATTERN can be a word, a list of words (separated by spaces),
429 430 431 432
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.

Kim F. Storm's avatar
Kim F. Storm committed
433
With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also show
434
noninteractive functions.
435

436
If VAR-PREDICATE is non-nil, show only variables, and only those that
Kim F. Storm's avatar
Kim F. Storm committed
437 438 439 440 441 442 443
satisfy the predicate VAR-PREDICATE.

When called from a Lisp program, a string PATTERN is used as a regexp,
while a list of strings is used as a word list."
  (interactive (list (apropos-read-pattern
		      (if (or current-prefix-arg apropos-do-all)
			  "command or function" "command"))
444
		     current-prefix-arg))
Kim F. Storm's avatar
Kim F. Storm committed
445
  (setq apropos-regexp (apropos-parse-pattern pattern))
446
  (let ((message
447
	 (let ((standard-output (get-buffer-create "*Apropos*")))
448
	   (print-help-return-message 'identity))))
449 450
    (or do-all (setq do-all apropos-do-all))
    (setq apropos-accumulator
Kim F. Storm's avatar
Kim F. Storm committed
451
	  (apropos-internal apropos-regexp
452 453
			    (or var-predicate
				(if do-all 'functionp 'commandp))))
454 455
    (let ((tem apropos-accumulator))
      (while tem
456 457
	(if (or (get (car tem) 'apropos-inhibit)
		(apropos-false-hit-symbol (car tem)))
458 459
	    (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
	(setq tem (cdr tem))))
460
    (let ((p apropos-accumulator)
461
	  doc symbol score)
462 463 464
      (while p
	(setcar p (list
		   (setq symbol (car p))
465
		   (setq score (apropos-score-symbol symbol))
466 467 468
		   (unless var-predicate
		     (if (functionp symbol)
			 (if (setq doc (documentation symbol t))
469
			     (progn
470
			       (setq score (+ score (apropos-score-doc doc)))
471
			       (substring doc 0 (string-match "\n" doc)))
472 473 474 475 476
			   "(not documented)")))
		   (and var-predicate
			(funcall var-predicate symbol)
			(if (setq doc (documentation-property
				       symbol 'variable-documentation t))
477 478 479 480 481
			     (progn
			       (setq score (+ score (apropos-score-doc doc)))
			       (substring doc 0
					  (string-match "\n" doc)))))))
	(setcar (cdr (car p)) score)
482
	(setq p (cdr p))))
Kim F. Storm's avatar
Kim F. Storm committed
483
    (and (apropos-print t nil nil t)
484
	 message
Deepak Goel's avatar
Deepak Goel committed
485
	 (message "%s" message))))
486 487 488


;;;###autoload
489 490 491 492 493 494 495 496
(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)")))

497 498

;;;###autoload
Kim F. Storm's avatar
Kim F. Storm committed
499 500 501
(defun apropos (pattern &optional do-all)
  "Show all bound symbols whose names match PATTERN.
PATTERN can be a word, a list of words (separated by spaces),
502 503 504 505
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.

Kim F. Storm's avatar
Kim F. Storm committed
506
With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also
Dave Love's avatar
Dave Love committed
507 508
show unbound symbols and key bindings, which is a little more
time-consuming.  Returns list of symbols and documentation found."
Kim F. Storm's avatar
Kim F. Storm committed
509 510 511
  (interactive (list (apropos-read-pattern "symbol")
		     current-prefix-arg))
  (setq apropos-regexp (apropos-parse-pattern pattern))
512
  (apropos-symbols-internal
Kim F. Storm's avatar
Kim F. Storm committed
513
   (apropos-internal apropos-regexp
514 515 516 517 518
			  (and (not do-all)
			       (not apropos-do-all)
			       (lambda (symbol)
				 (or (fboundp symbol)
				     (boundp symbol)
519
				     (facep symbol)
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
				     (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
548
		    symbol 'variable-documentation t))
549 550 551 552 553 554
		 (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)
555 556
		   (apropos-documentation-property
		    symbol 'widget-documentation t))
557 558 559 560
	       (when (facep symbol)
		 (apropos-documentation-property
		  symbol 'face-documentation t))
	       (when (get symbol 'custom-group)
561
		   (apropos-documentation-property
562 563 564
		    symbol 'group-documentation t)))))
	  symbols)))
    (apropos-print keys nil text)))
565 566


Richard M. Stallman's avatar
Richard M. Stallman committed
567
;;;###autoload
Kim F. Storm's avatar
Kim F. Storm committed
568 569 570
(defun apropos-value (pattern &optional do-all)
  "Show all symbols whose value's printed image matches PATTERN.
PATTERN can be a word, a list of words (separated by spaces),
571 572 573 574
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.

Kim F. Storm's avatar
Kim F. Storm committed
575
With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also looks
576
at the function and at the names and values of properties.
577
Returns list of symbols and values found."
Kim F. Storm's avatar
Kim F. Storm committed
578 579 580
  (interactive (list (apropos-read-pattern "value")
		     current-prefix-arg))
  (setq apropos-regexp (apropos-parse-pattern pattern))
581 582 583
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator ())
   (let (f v p)
584 585 586
     (mapatoms
      (lambda (symbol)
	(setq f nil v nil p nil)
Kim F. Storm's avatar
Kim F. Storm committed
587 588
	(or (memq symbol '(apropos-regexp
			   apropos-pattern apropos-all-words-regexp
589 590 591
			   apropos-words apropos-all-words
			   do-all apropos-accumulator
			   symbol f v p))
592
	    (setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
593
	(if do-all
594 595
	    (setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
		  p (apropos-format-plist symbol "\n    " t)))
596 597 598 599 600 601
	(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))
602
	(if (or f v p)
603
	    (setq apropos-accumulator (cons (list symbol
604 605 606 607
						  (+ (apropos-score-str f)
						     (apropos-score-str v)
						     (apropos-score-str p))
						  f v p)
608
					    apropos-accumulator))))))
609
  (apropos-print nil "\n----------------\n"))
610 611


612
;;;###autoload
Kim F. Storm's avatar
Kim F. Storm committed
613 614 615
(defun apropos-documentation (pattern &optional do-all)
  "Show symbols whose documentation contain matches for PATTERN.
PATTERN can be a word, a list of words (separated by spaces),
616 617 618 619
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.

Kim F. Storm's avatar
Kim F. Storm committed
620
With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also use
621 622 623
documentation that is not stored in the documentation file and show key
bindings.
Returns list of symbols and documentation found."
Kim F. Storm's avatar
Kim F. Storm committed
624 625 626
  (interactive (list (apropos-read-pattern "documentation")
		     current-prefix-arg))
  (setq apropos-regexp (apropos-parse-pattern pattern))
627 628 629
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator () apropos-files-scanned ())
  (let ((standard-input (get-buffer-create " apropos-temp"))
Kim F. Storm's avatar
Kim F. Storm committed
630
	(apropos-sort-by-scores apropos-documentation-sort-by-scores)
631
	f v sf sv)
632 633 634 635 636 637 638 639
    (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)
640 641 642 643
		       v (get symbol 'variable-documentation))
		 (if (integerp v) (setq v))
		 (setq f (apropos-documentation-internal f)
		       v (apropos-documentation-internal v))
644 645
		 (setq sf (apropos-score-doc f)
		       sv (apropos-score-doc v))
646 647 648 649 650
		 (if (or f v)
		     (if (setq apropos-item
			       (cdr (assq symbol apropos-accumulator)))
			 (progn
			   (if f
651 652 653
			       (progn
				 (setcar (nthcdr 1 apropos-item) f)
				 (setcar apropos-item (+ (car apropos-item) sf))))
654
			   (if v
655 656 657
			       (progn
				 (setcar (nthcdr 2 apropos-item) v)
				 (setcar apropos-item (+ (car apropos-item) sv)))))
658
		       (setq apropos-accumulator
659
			     (cons (list symbol
660 661
					 (+ (apropos-score-symbol symbol 2) sf sv)
					 f v)
662
				   apropos-accumulator)))))))
Kim F. Storm's avatar
Kim F. Storm committed
663
	  (apropos-print nil "\n----------------\n" nil t))
664 665 666 667 668 669 670
      (kill-buffer standard-input))))


(defun apropos-value-internal (predicate symbol function)
  (if (funcall predicate symbol)
      (progn
	(setq symbol (prin1-to-string (funcall function symbol)))
Kim F. Storm's avatar
Kim F. Storm committed
671
	(if (string-match apropos-regexp symbol)
672 673 674 675 676 677 678 679 680 681
	    (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))
Kim F. Storm's avatar
Kim F. Storm committed
682 683 684 685 686 687 688 689 690 691 692
    (if (and doc
	     (string-match apropos-all-words-regexp doc)
	     (apropos-true-hit-doc doc))
	(when apropos-match-face
	  (setq doc (substitute-command-keys (copy-sequence doc)))
	  (if (or (string-match apropos-pattern-quoted doc)
		  (string-match apropos-all-words-regexp doc))
	      (put-text-property (match-beginning 0)
				 (match-end 0)
				 'face apropos-match-face doc))
	  doc))))
693 694

(defun apropos-format-plist (pl sep &optional compare)
695 696 697 698
  (setq pl (symbol-plist pl))
  (let (p p-out)
    (while pl
      (setq p (format "%s %S" (car pl) (nth 1 pl)))
Kim F. Storm's avatar
Kim F. Storm committed
699
      (if (or (not compare) (string-match apropos-regexp p))
700
	  (if apropos-property-face
701
	      (put-text-property 0 (length (symbol-name (car pl)))
702
				 'face apropos-property-face p))
703
	(setq p nil))
704 705 706 707 708 709 710
      (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))))
711 712 713
      (setq pl (nthcdr 2 pl)))
    p-out))

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

Kim F. Storm's avatar
Kim F. Storm committed
715
;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
716

717
(defun apropos-documentation-check-doc-file ()
Kim F. Storm's avatar
Kim F. Storm committed
718
  (let (type symbol (sepa 2) sepb)
719 720
    (insert ?\^_)
    (backward-char)
721
    (insert-file-contents (concat doc-directory internal-doc-file-name))
722 723 724 725 726 727 728
    (forward-char)
    (while (save-excursion
	     (setq sepb (search-forward "\^_"))
	     (not (eobp)))
      (beginning-of-line 2)
      (if (save-restriction
	    (narrow-to-region (point) (1- sepb))
Kim F. Storm's avatar
Kim F. Storm committed
729
	    (re-search-forward apropos-all-words-regexp nil t))
730 731
	  (progn
	    (goto-char (1+ sepa))
732 733 734 735 736 737 738 739
	    (setq type (if (eq ?F (preceding-char))
			   2	; function documentation
			 3)		; variable documentation
		  symbol (read)
		  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)
Kim F. Storm's avatar
Kim F. Storm committed
740
			       (apropos-score-doc doc)))
741
		  (setq apropos-item (list symbol
742 743 744 745 746
					   (+ (apropos-score-symbol symbol 2)
					      (apropos-score-doc doc))
					   nil nil)
			apropos-accumulator (cons apropos-item
						  apropos-accumulator)))
Kim F. Storm's avatar
Kim F. Storm committed
747 748 749 750 751 752 753
	      (when apropos-match-face
		(setq doc (substitute-command-keys doc))
		(if (or (string-match apropos-pattern-quoted doc)
			(string-match apropos-all-words-regexp doc))
		    (put-text-property (match-beginning 0)
				       (match-end 0)
				       'face apropos-match-face doc)))
754
	      (setcar (nthcdr type apropos-item) doc))))
755
      (setq sepa (goto-char sepb)))))
756 757 758 759

(defun apropos-documentation-check-elc-file (file)
  (if (member file apropos-files-scanned)
      nil
760
    (let (symbol doc beg end this-is-a-variable)
761 762 763 764 765 766
      (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)
767 768 769 770 771 772
	      beg (1+ (point))
	      end (+ (point) end -1))
	(forward-char)
	(if (save-restriction
	      ;; match ^ and $ relative to doc string
	      (narrow-to-region beg end)
Kim F. Storm's avatar
Kim F. Storm committed
773
	      (re-search-forward apropos-all-words-regexp nil t))
774
	    (progn
775 776 777
	      (goto-char (+ end 2))
	      (setq doc (buffer-substring beg end)
		    end (- (match-end 0) beg)
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
		    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)))
Kim F. Storm's avatar
Kim F. Storm committed
801 802 803 804 805 806 807
		      (when apropos-match-face
			(setq doc (substitute-command-keys doc))
			(if (or (string-match apropos-pattern-quoted doc)
				(string-match apropos-all-words-regexp doc))
			    (put-text-property (match-beginning 0)
					       (match-end 0)
					       'face apropos-match-face doc)))
808 809 810
		      (setcar (nthcdr (if this-is-a-variable 3 2)
				      apropos-item)
			      doc))))))))))
811 812 813 814



(defun apropos-safe-documentation (function)
Dave Love's avatar
Dave Love committed
815
  "Like `documentation', except it avoids calling `get_doc_string'.
Richard M. Stallman's avatar
Richard M. Stallman committed
816
Will return nil instead."
817
  (while (and function (symbolp function))
Richard M. Stallman's avatar
Richard M. Stallman committed
818
    (setq function (if (fboundp function)
819
		       (symbol-function function))))
820 821
  (if (eq (car-safe function) 'macro)
      (setq function (cdr function)))
822
  (setq function (if (byte-code-function-p function)
823 824 825 826 827 828 829 830 831 832 833 834 835 836
		     (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))


Kim F. Storm's avatar
Kim F. Storm committed
837
(defun apropos-print (do-keys spacing &optional text nosubst)
838 839
  "Output result of apropos searching into buffer `*Apropos*'.
The value of `apropos-accumulator' is the list of items to output.
840
Each element should have the format
841
 (SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
842 843
The return value is the list that was in `apropos-accumulator', sorted
alphabetically by symbol name; but this function also sets
844 845
`apropos-accumulator' to nil before returning.

846 847
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."
848
  (if (null apropos-accumulator)
Kim F. Storm's avatar
Kim F. Storm committed
849
      (message "No apropos matches for `%s'" apropos-pattern)
850
    (setq apropos-accumulator
851 852 853 854
	  (sort apropos-accumulator
		(lambda (a b)
		  ;; Don't sort by score if user can't see the score.
		  ;; It would be confusing.  -- rms.
855
		  (if apropos-sort-by-scores
856 857 858 859
		      (or (> (cadr a) (cadr b))
			  (and (= (cadr a) (cadr b))
			       (string-lessp (car a) (car b))))
		    (string-lessp (car a) (car b))))))
860
    (with-output-to-temp-buffer "*Apropos*"
861
      (let ((p apropos-accumulator)
862
	    (old-buffer (current-buffer))
863
	    symbol item)
864 865
	(set-buffer standard-output)
	(apropos-mode)
866
	(if (display-mouse-p)
867 868 869 870 871
	    (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"))
872
	(insert "In this buffer, go to the name of the command, or function,"
873 874 875
		" or variable,\n"
		(substitute-command-keys
		 "and type \\[apropos-follow] to get full documentation.\n\n"))
876
	(if text (insert text "\n\n"))
877
	(while (consp p)
878 879
	  (when (and spacing (not (bobp)))
	    (princ spacing))
880 881
	  (setq apropos-item (car p)
		symbol (car apropos-item)
882
		p (cdr p))
Kim F. Storm's avatar
Kim F. Storm committed
883 884 885 886 887 888
	  ;; Insert dummy score element for backwards compatibility with 21.x
	  ;; apropos-item format.
	  (if (not (numberp (cadr apropos-item)))
	      (setq apropos-item
		    (cons (car apropos-item)
			  (cons nil (cdr apropos-item)))))
889 890 891 892 893 894
	  (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)
Kim F. Storm's avatar
Kim F. Storm committed
895 896
	  (if (and (eq apropos-sort-by-scores 'verbose)
		   (cadr apropos-item))
897
	      (insert " (" (number-to-string (cadr apropos-item)) ") "))
898
	  ;; Calculate key-bindings if we want them.
899 900 901
	  (and do-keys
	       (commandp symbol)
	       (indent-to 30 1)
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
	       (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
924
		    (mapconcat
925
		     (lambda (key)
Dave Love's avatar
Dave Love committed
926
		       (setq key (condition-case ()
927 928
				     (key-description key)
				   (error)))
929
		       (if apropos-keybinding-face
930 931
			   (put-text-property 0 (length key)
					      'face apropos-keybinding-face
932 933 934
					      key))
		       key)
		     item ", "))
935 936 937 938 939 940
		 (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))))
941
	  (terpri)
942
	  (apropos-print-doc 2
943
			     (if (commandp symbol)
944
				 'apropos-command
945
			       (if (apropos-macrop symbol)
946 947
				   'apropos-macro
				 'apropos-function))
Kim F. Storm's avatar
Kim F. Storm committed
948 949
			     (not nosubst))
	  (apropos-print-doc 3 'apropos-variable (not nosubst))