apropos.el 31.3 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,04,2005  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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, 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
(defgroup apropos nil
64
  "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
(defcustom apropos-match-face 'match
100 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
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
  'help-echo "mouse-2, RET: Display more help on this symbol"
166
  'follow-link t
167 168
  'action #'apropos-symbol-button-display-help
  'skip t)
169 170 171 172 173 174 175

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

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

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

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

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

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

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

258

259 260 261 262
(defun apropos-words-to-regexp (words wild)
  "Make regexp matching any two of the words in WORDS."
  (concat "\\("
	  (mapconcat 'identity words "\\|")
263
	  "\\)"
264
	  (if (cdr words)
265 266
	      (concat wild
		      "\\("
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 304 305 306 307 308 309 310 311 312 313 314
		      (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
315 316 317
      (let* (
	     (l (length str))
	     (score (- (/ l 10)))
318 319
	    i)
	(dolist (s (apropos-calc-scores str apropos-all-words) score)
320
	  (setq score (+ score 1000 (/ (* (- l s) 1000) l)))))
321 322 323 324
      0))

(defun apropos-score-doc (doc)
  "Return apropos score for documentation string DOC."
325 326 327 328 329 330 331
  (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)))
332

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

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

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

366
\\{apropos-mode-map}")
367

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

387 388
;; For auld lang syne:
;;;###autoload
389
(defalias 'command-apropos 'apropos-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
390
;;;###autoload
391
(defun apropos-command (apropos-regexp &optional do-all var-predicate)
Dave Love's avatar
Dave Love committed
392 393
  "Show commands (interactively callable functions) that match APROPOS-REGEXP.
With optional prefix DO-ALL, or if `apropos-do-all' is non-nil, also show
394
noninteractive functions.
395

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


;;;###autoload
449 450 451 452 453 454 455 456
(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)")))

457 458

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


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


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

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

655
;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
656

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

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



(defun apropos-safe-documentation (function)
Dave Love's avatar
Dave Love committed
750
  "Like `documentation', except it avoids calling `get_doc_string'.
Richard M. Stallman's avatar
Richard M. Stallman committed
751
Will return nil instead."
752
  (while (and function (symbolp function))
Richard M. Stallman's avatar
Richard M. Stallman committed
753
    (setq function (if (fboundp function)
754
		       (symbol-function function))))
755 756
  (if (eq (car-safe function) 'macro)
      (setq function (cdr function)))
757
  (setq function (if (byte-code-function-p function)
758 759 760 761 762 763 764 765 766 767 768 769 770 771
		     (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))


772
(defun apropos-print (do-keys spacing &optional text)
773 774
  "Output result of apropos searching into buffer `*Apropos*'.
The value of `apropos-accumulator' is the list of items to output.
775
Each element should have the format
776
 (SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
777 778
The return value is the list that was in `apropos-accumulator', sorted
alphabetically by symbol name; but this function also sets
779 780
`apropos-accumulator' to nil before returning.

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

886

887
(defun apropos-macrop (symbol)
888
  "Return t if SYMBOL is a Lisp macro."
889 890 891 892 893 894 895
  (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))))))
896

897

898
(defun apropos-print-doc (i type do-keys)
899
  (if (stringp (setq i (nth i apropos-item)))
900 901
      (progn
	(insert "  ")
902 903
	(insert-text-button (button-type-get type 'apropos-label)
			    'type type
904 905 906 907
			    ;; 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
908
			    'apropos-symbol (car apropos-item))
909
	(insert ": ")
910 911
	(insert (if do-keys (substitute-command-keys i) i))
	(or (bolp) (terpri)))))
912 913


914 915
(defun apropos-follow ()
  "Invokes any button at point, otherwise invokes the nearest label button."
916
  (interactive)
917 918 919
  (button-activate
   (or (apropos-next-label-button (line-beginning-position))
       (error "There is nothing to follow here"))))
920 921 922 923


(defun apropos-describe-plist (symbol)
  "Display a pretty listing of SYMBOL's plist."
924 925
  (help-setup-xref (list 'apropos-describe-plist symbol) (interactive-p))
  (with-output-to-temp-buffer (help-buffer)
926 927 928 929
    (set-buffer standard-output)
    (princ "Symbol ")
    (prin1 symbol)
    (princ "'s plist is\n (")
930
    (if apropos-symbol-face
931 932
	(put-text-property (+ (point-min) 7) (- (point) 14)
			   'face apropos-symbol-face))
933
    (insert (apropos-format-plist symbol "\n  "))
934 935
    (princ ")")
    (print-help-return-message)))
Richard M. Stallman's avatar
Richard M. Stallman committed
936

937

Richard M. Stallman's avatar
Richard M. Stallman committed
938 939
(provide 'apropos)

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