apropos.el 31.1 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,94,1995,2001,02,03,2004  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
(require 'button)
61
(eval-when-compile (require 'cl))
Miles Bader's avatar
Miles Bader committed
62

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

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

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


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

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

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

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

99 100 101 102
(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
103 104
  :group 'apropos
  :type 'face)
105

106 107 108
(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."
109 110
  :group 'apropos
  :type 'boolean)
Richard M. Stallman's avatar
Richard M. Stallman committed
111

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

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

128 129 130
(defvar apropos-regexp nil
  "Regexp used in current apropos run.")

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

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

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

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

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

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

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

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

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

175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
(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
190

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

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

247

248 249 250 251
(defun apropos-words-to-regexp (words wild)
  "Make regexp matching any two of the words in WORDS."
  (concat "\\("
	  (mapconcat 'identity words "\\|")
252
	  "\\)"
253
	  (if (cdr words)
254 255
	      (concat wild
		      "\\("
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 300 301 302 303
		      (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
304 305 306
      (let* (
	     (l (length str))
	     (score (- (/ l 10)))
307 308
	    i)
	(dolist (s (apropos-calc-scores str apropos-all-words) score)
309
	  (setq score (+ score 1000 (/ (* (- l s) 1000) l)))))
310 311 312 313 314 315 316 317 318 319 320
      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))
321

322 323 324 325 326 327 328 329 330
(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))))))

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
(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))

352
(define-derived-mode apropos-mode fundamental-mode "Apropos"
353 354
  "Major mode for following hyperlinks in output of apropos commands.

355
\\{apropos-mode-map}")
356

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

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

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


;;;###autoload
438 439 440 441 442 443 444 445
(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)")))

446 447

;;;###autoload
448
(defun apropos (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
449 450 451 452
  "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."
453 454
  (interactive "sApropos symbol (regexp or words): \nP")
  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
455 456
  (apropos-symbols-internal
   (apropos-internal apropos-regexp
457 458 459 460 461
			  (and (not do-all)
			       (not apropos-do-all)
			       (lambda (symbol)
				 (or (fboundp symbol)
				     (boundp symbol)
462
				     (facep symbol)
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
				     (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
491
		    symbol 'variable-documentation t))
492 493 494 495 496 497
		 (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)
498 499
		   (apropos-documentation-property
		    symbol 'widget-documentation t))
500 501 502 503
	       (when (facep symbol)
		 (apropos-documentation-property
		  symbol 'face-documentation t))
	       (when (get symbol 'custom-group)
504
		   (apropos-documentation-property
505 506 507
		    symbol 'group-documentation t)))))
	  symbols)))
    (apropos-print keys nil text)))
508 509


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


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

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

644
;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
645

646
(defun apropos-documentation-check-doc-file ()
647 648 649
  (let (type symbol (sepa 2) sepb beg end)
    (insert ?\^_)
    (backward-char)
650
    (insert-file-contents (concat doc-directory internal-doc-file-name))
651 652 653 654 655 656 657
    (forward-char)
    (while (save-excursion
	     (setq sepb (search-forward "\^_"))
	     (not (eobp)))
      (beginning-of-line 2)
      (if (save-restriction
	    (narrow-to-region (point) (1- sepb))
658
	    (re-search-forward apropos-all-regexp nil t))
659 660 661 662
	  (progn
	    (setq beg (match-beginning 0)
		  end (point))
	    (goto-char (1+ sepa))
663 664 665 666 667 668 669 670 671 672 673
	    (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))))
674
		  (setq apropos-item (list symbol
675 676 677 678 679 680 681 682
					   (+ (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))))
683
      (setq sepa (goto-char sepb)))))
684 685 686 687

(defun apropos-documentation-check-elc-file (file)
  (if (member file apropos-files-scanned)
      nil
688
    (let (symbol doc beg end this-is-a-variable)
689 690 691 692 693 694
      (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)
695 696 697 698 699 700
	      beg (1+ (point))
	      end (+ (point) end -1))
	(forward-char)
	(if (save-restriction
	      ;; match ^ and $ relative to doc string
	      (narrow-to-region beg end)
701
	      (re-search-forward apropos-all-regexp nil t))
702
	    (progn
703 704 705
	      (goto-char (+ end 2))
	      (setq doc (buffer-substring beg end)
		    end (- (match-end 0) beg)
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
		    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))))))))))
735 736 737 738



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


761
(defun apropos-print (do-keys spacing &optional text)
762 763
  "Output result of apropos searching into buffer `*Apropos*'.
The value of `apropos-accumulator' is the list of items to output.
764
Each element should have the format
765
 (SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
766 767
The return value is the list that was in `apropos-accumulator', sorted
alphabetically by symbol name; but this function also sets
768 769
`apropos-accumulator' to nil before returning.

770 771
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."
772
  (if (null apropos-accumulator)
773
      (message "No apropos matches for `%s'" apropos-orig-regexp)
774
    (setq apropos-accumulator
775 776 777 778
	  (sort apropos-accumulator
		(lambda (a b)
		  ;; Don't sort by score if user can't see the score.
		  ;; It would be confusing.  -- rms.
779
		  (if apropos-sort-by-scores
780 781 782 783
		      (or (> (cadr a) (cadr b))
			  (and (= (cadr a) (cadr b))
			       (string-lessp (car a) (car b))))
		    (string-lessp (car a) (car b))))))
784
    (with-output-to-temp-buffer "*Apropos*"
785
      (let ((p apropos-accumulator)
786
	    (old-buffer (current-buffer))
787
	    symbol item)
788 789
	(set-buffer standard-output)
	(apropos-mode)
790
	(if (display-mouse-p)
791 792 793 794 795
	    (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"))
796
	(insert "In this buffer, go to the name of the command, or function,"
797 798 799
		" or variable,\n"
		(substitute-command-keys
		 "and type \\[apropos-follow] to get full documentation.\n\n"))
800
	(if text (insert text "\n\n"))
801
	(while (consp p)
802 803
	  (when (and spacing (not (bobp)))
	    (princ spacing))
804 805
	  (setq apropos-item (car p)
		symbol (car apropos-item)
806 807 808 809 810 811 812
		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)
813
	  (if apropos-sort-by-scores
814
	      (insert " (" (number-to-string (cadr apropos-item)) ") "))
815
	  ;; Calculate key-bindings if we want them.
816 817 818
	  (and do-keys
	       (commandp symbol)
	       (indent-to 30 1)
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
	       (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
841
		    (mapconcat
842
		     (lambda (key)
Dave Love's avatar
Dave Love committed
843
		       (setq key (condition-case ()
844 845
				     (key-description key)
				   (error)))
846
		       (if apropos-keybinding-face
847 848
			   (put-text-property 0 (length key)
					      'face apropos-keybinding-face
849 850 851
					      key))
		       key)
		     item ", "))
852 853 854 855 856 857 858
		 (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)))
859
	  (terpri)
860
	  (apropos-print-doc 2
861
			     (if (commandp symbol)
862
				 'apropos-command
863
			       (if (apropos-macrop symbol)
864 865
				   'apropos-macro
				 'apropos-function))
866
			     t)
867 868 869 870 871
	  (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))
872
	(setq buffer-read-only t))))
873 874 875
  (prog1 apropos-accumulator
    (setq apropos-accumulator ())))	; permit gc

876

877
(defun apropos-macrop (symbol)
878
  "Return t if SYMBOL is a Lisp macro."
879 880 881 882 883 884 885
  (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))))))
886

887

888
(defun apropos-print-doc (i type do-keys)
889
  (if (stringp (setq i (nth i apropos-item)))
890 891
      (progn
	(insert "  ")
892 893
	(insert-text-button (button-type-get type 'apropos-label)
			    'type type
894 895 896 897
			    ;; 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
898
			    'apropos-symbol (car apropos-item))
899
	(insert ": ")
900 901
	(insert (if do-keys (substitute-command-keys i) i))
	(or (bolp) (terpri)))))
902 903


904 905
(defun apropos-follow ()
  "Invokes any button at point, otherwise invokes the nearest label button."
906
  (interactive)
907 908 909
  (button-activate
   (or (apropos-next-label-button (line-beginning-position))
       (error "There is nothing to follow here"))))
910 911 912 913


(defun apropos-describe-plist (symbol)
  "Display a pretty listing of SYMBOL's plist."
914 915
  (help-setup-xref (list 'apropos-describe-plist symbol) (interactive-p))
  (with-output-to-temp-buffer (help-buffer)
916 917 918 919
    (set-buffer standard-output)
    (princ "Symbol ")
    (prin1 symbol)
    (princ "'s plist is\n (")
920
    (if apropos-symbol-face
921 922
	(put-text-property (+ (point-min) 7) (- (point) 14)
			   'face apropos-symbol-face))
923
    (insert (apropos-format-plist symbol "\n  "))
924 925
    (princ ")")
    (print-help-return-message)))
Richard M. Stallman's avatar
Richard M. Stallman committed
926

927

Richard M. Stallman's avatar
Richard M. Stallman committed
928 929
(provide 'apropos)

Miles Bader's avatar
Miles Bader committed
930
;;; arch-tag: d56fa2ac-e56b-4ce3-84ff-852f9c0dc66e
Eric S. Raymond's avatar
Eric S. Raymond committed
931
;;; apropos.el ends here