apropos.el 29.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, 1994, 1995, 2001, 2002 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11 12
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
13
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
14 15 16 17 18 19 20 21
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
25

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

;; The ideas for this package were derived from the C code in
;; src/keymap.c and elsewhere.  The functions in this file should
;; always be byte-compiled for speed.  Someone should rewrite this in
;; C (as part of src/keymap.c) for speed.

;; The idea for super-apropos is based on the original implementation
;; by Lynn Slater <lrs@esl.com>.

;; History:
;; Fixed bug, current-local-map can return nil.
;; Change, doesn't calculate key-bindings unless needed.
;; Added super-apropos capability, changed print functions.
40 41
;;; Made fast-apropos and super-apropos share code.
;;; Sped up fast-apropos again.
Richard M. Stallman's avatar
Richard M. Stallman committed
42
;; Added apropos-do-all option.
43
;;; Added fast-command-apropos.
Richard M. Stallman's avatar
Richard M. Stallman committed
44
;; Changed doc strings to comments for helping functions.
45
;;; Made doc file buffer read-only, buried it.
Richard M. Stallman's avatar
Richard M. Stallman committed
46 47
;; Only call substitute-command-keys if do-all set.

48 49
;; Optionally use configurable faces to make the output more legible.
;; Differentiate between command, function and macro.
50 51 52 53 54 55 56 57
;; Apropos-command (ex command-apropos) does cmd and optionally user var.
;; Apropos shows all 3 aspects of symbols (fn, var and plist)
;; Apropos-documentation (ex super-apropos) now finds all it should.
;; New apropos-value snoops through all values and optionally plists.
;; Reading DOC file doesn't load nroff.
;; Added hypertext following of documentation, mouse-2 on variable gives value
;;   from buffer in active window.

Eric S. Raymond's avatar
Eric S. Raymond committed
58 59
;;; Code:

Miles Bader's avatar
Miles Bader committed
60 61
(require 'button)

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

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

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


76 77
(defcustom apropos-symbol-face 'bold
  "*Face for symbol name in Apropos output, or nil for none."
Richard M. Stallman's avatar
Richard M. Stallman committed
78 79
  :group 'apropos
  :type 'face)
80

81 82
(defcustom apropos-keybinding-face 'underline
  "*Face for lists of keybinding in Apropos output, or nil for none."
Richard M. Stallman's avatar
Richard M. Stallman committed
83 84
  :group 'apropos
  :type 'face)
85

86 87 88 89
(defcustom apropos-label-face 'italic
  "*Face for label (`Command', `Variable' ...) in Apropos output.
A value of nil means don't use any special font for them, and also
turns off mouse highlighting."
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91
  :group 'apropos
  :type 'face)
92

93 94
(defcustom apropos-property-face 'bold-italic
  "*Face for property name in apropos output, or nil for none."
Richard M. Stallman's avatar
Richard M. Stallman committed
95 96
  :group 'apropos
  :type 'face)
97

98 99 100 101
(defcustom apropos-match-face 'secondary-selection
  "*Face for matching text in Apropos documentation/value, or nil for none.
This applies when you look for matches in the documentation or variable value
for the regexp; the part that matches gets displayed in this font."
Richard M. Stallman's avatar
Richard M. Stallman committed
102 103
  :group 'apropos
  :type 'face)
104

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

106
(defvar apropos-mode-map
107
  (let ((map (make-sparse-keymap)))
108 109 110 111
    (set-keymap-parent map button-buffer-map)
    ;; Use `apropos-follow' instead of just using the button
    ;; definition of RET, so that users can use it anywhere in an
    ;; apropos item, not just on top of a button.
112
    (define-key map "\C-m" 'apropos-follow)
113 114 115
    (define-key map " "    'scroll-up)
    (define-key map "\177" 'scroll-down)
    (define-key map "q"    'quit-window)
116
    map)
117
  "Keymap used in Apropos mode.")
118

Gerd Moellmann's avatar
Gerd Moellmann committed
119 120
(defvar apropos-mode-hook nil
  "*Hook run when mode is turned on.")
121

122 123 124
(defvar apropos-show-scores nil
  "*Show apropos scores if non-nil.")

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

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

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

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

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

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

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

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

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

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

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

(defun apropos-symbol-button-display-help (button)
  "Display further help for the `apropos-symbol' button BUTTON."
  (button-activate
   (or (apropos-next-label-button (button-start button))
       (error "There is nothing to follow for `%s'" (button-label button)))))

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
(define-button-type 'apropos-function
  'apropos-label "Function"
  'action (lambda (button)
	    (describe-function (button-get button 'apropos-symbol)))
  'help-echo "mouse-2, RET: Display more help on this function")
(define-button-type 'apropos-macro
  'apropos-label "Macro"
  'action (lambda (button)
	    (describe-function (button-get button 'apropos-symbol)))
  'help-echo "mouse-2, RET: Display more help on this macro")
(define-button-type 'apropos-command
  'apropos-label "Command"
  'action (lambda (button)
	    (describe-function (button-get button 'apropos-symbol)))
  'help-echo "mouse-2, RET: Display more help on this command")
Pavel Janík's avatar
Pavel Janík committed
187

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

(define-button-type 'apropos-widget
  'apropos-label "Widget"
  'help-echo "mouse-2, RET: Display more help on this widget"
  'action (lambda (button)
	    (widget-browse-other-window (button-get button 'apropos-symbol))))

(define-button-type 'apropos-plist
  'apropos-label "Plist"
  'help-echo "mouse-2, RET: Display more help on this plist"
  'action (lambda (button)
	    (apropos-describe-plist (button-get button 'apropos-symbol))))
223 224

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

244

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
(defun apropos-words-to-regexp (words wild)
  "Make regexp matching any two of the words in WORDS."
  (concat "\\("
	  (mapconcat 'identity words "\\|")
	  "\\)" wild
	  (if (cdr words) 
	      (concat "\\("
		      (mapconcat 'identity words "\\|")
		      "\\)")
	    "")))

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

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

(defun apropos-score-str (str)
  "Return apropos score for string STR."
  (if str
      (let ((score 0)
	    (l (length str))
	    i)
	(dolist (s (apropos-calc-scores str apropos-all-words) score)
	  (setq score (+ score 1000 (- (/ l 10)) (/ (* (- l s) 1000) l)))))
      0))

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

326
;;;###autoload
327
(define-derived-mode apropos-mode fundamental-mode "Apropos"
328 329
  "Major mode for following hyperlinks in output of apropos commands.

330
\\{apropos-mode-map}")
331

332
;;;###autoload
333 334
(defun apropos-variable (regexp &optional do-all)
  "Show user variables that match REGEXP.
Dave Love's avatar
Dave Love committed
335
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also show
336 337 338 339 340 341
normal variables."
  (interactive (list (read-string
                      (concat "Apropos "
                              (if (or current-prefix-arg apropos-do-all)
				  "variable"
				"user option")
342
                              " (regexp or words): "))
343 344
                     current-prefix-arg))
  (apropos-command regexp nil
345
		   (if (or do-all apropos-do-all)
346 347 348 349
		       #'(lambda (symbol)
			   (and (boundp symbol)
				(get symbol 'variable-documentation)))
		     'user-variable-p)))
350

351 352 353
;; For auld lang syne:
;;;###autoload
(fset 'command-apropos 'apropos-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
354
;;;###autoload
355
(defun apropos-command (apropos-regexp &optional do-all var-predicate)
Dave Love's avatar
Dave Love committed
356 357
  "Show commands (interactively callable functions) that match APROPOS-REGEXP.
With optional prefix DO-ALL, or if `apropos-do-all' is non-nil, also show
358
noninteractive functions.
359

360
If VAR-PREDICATE is non-nil, show only variables, and only those that
361
satisfy the predicate VAR-PREDICATE."
362 363 364 365
  (interactive (list (read-string (concat
				   "Apropos command "
				   (if (or current-prefix-arg
					   apropos-do-all)
366
				       "or function ")
367
				   "(regexp or words): "))
368
		     current-prefix-arg))
369
  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
370
  (let ((message
371
	 (let ((standard-output (get-buffer-create "*Apropos*")))
372
	   (print-help-return-message 'identity))))
373 374 375
    (or do-all (setq do-all apropos-do-all))
    (setq apropos-accumulator
	  (apropos-internal apropos-regexp
376 377
			    (or var-predicate
				(if do-all 'functionp 'commandp))))
378 379 380 381 382
    (let ((tem apropos-accumulator))
      (while tem
	(if (get (car tem) 'apropos-inhibit)
	    (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
	(setq tem (cdr tem))))
383
    (let ((p apropos-accumulator)
384
	  doc symbol score)
385 386 387
      (while p
	(setcar p (list
		   (setq symbol (car p))
388
		   (setq score (apropos-score-symbol symbol))
389 390 391
		   (unless var-predicate
		     (if (functionp symbol)
			 (if (setq doc (documentation symbol t))
392 393 394
			     (progn
			       (setq score (+ score (apropos-score-doc doc))) 
			       (substring doc 0 (string-match "\n" doc)))
395 396 397 398 399
			   "(not documented)")))
		   (and var-predicate
			(funcall var-predicate symbol)
			(if (setq doc (documentation-property
				       symbol 'variable-documentation t))
400 401 402 403 404
			     (progn
			       (setq score (+ score (apropos-score-doc doc)))
			       (substring doc 0
					  (string-match "\n" doc)))))))
	(setcar (cdr (car p)) score)
405 406 407 408
	(setq p (cdr p))))
    (and (apropos-print t nil)
	 message
	 (message message))))
409 410 411


;;;###autoload
412
(defun apropos (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
413 414 415 416
  "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."
417 418
  (interactive "sApropos symbol (regexp or words): \nP")
  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
419 420 421 422 423 424 425
  (setq apropos-accumulator
	(apropos-internal apropos-regexp
			  (and (not do-all)
			       (not apropos-do-all)
			       (lambda (symbol)
				 (or (fboundp symbol)
				     (boundp symbol)
426
				     (facep symbol)
427
				     (symbol-plist symbol))))))
428 429 430 431 432
  (let ((tem apropos-accumulator))
    (while tem
      (if (get (car tem) 'apropos-inhibit)
	  (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
      (setq tem (cdr tem))))
433 434 435 436 437
  (let ((p apropos-accumulator)
	symbol doc properties)
    (while p
      (setcar p (list
		 (setq symbol (car p))
438
		 0
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
		 (when (fboundp symbol)
		   (if (setq doc (condition-case nil
				     (documentation symbol t)
				   (void-function
				    "(alias for undefined function)")))
		       (substring doc 0 (string-match "\n" doc))
		     "(not documented)"))
		 (when (boundp symbol)
		   (if (setq doc (documentation-property
				  symbol 'variable-documentation t))
		       (substring doc 0 (string-match "\n" doc))
		     "(not documented)"))
		 (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)
		   (if (setq doc (documentation-property
				  symbol 'widget-documentation t))
		       (substring doc 0
				  (string-match "\n" doc))
		     "(not documented)"))
		 (when (facep symbol)
		   (if (setq doc (documentation-property
				  symbol 'face-documentation t))
		       (substring doc 0
				  (string-match "\n" doc))
		     "(not documented)"))
		 (when (get symbol 'custom-group)
		   (if (setq doc (documentation-property
				  symbol 'group-documentation t))
		       (substring doc 0
				  (string-match "\n" doc))
		     "(not documented)"))))
      (setq p (cdr p))))
475
  (apropos-print
476
   (or do-all apropos-do-all)
477 478 479
   nil))


Richard M. Stallman's avatar
Richard M. Stallman committed
480
;;;###autoload
481
(defun apropos-value (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
482 483
  "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
484
at the function and at the names and values of properties.
485
Returns list of symbols and values found."
486 487
  (interactive "sApropos value (regexp or words): \nP")
  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
488 489 490
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator ())
   (let (f v p)
491 492 493
     (mapatoms
      (lambda (symbol)
	(setq f nil v nil p nil)
494 495 496 497 498
	(or (memq symbol '(apropos-regexp
			   apropos-orig-regexp apropos-all-regexp
			   apropos-words apropos-all-words
			   do-all apropos-accumulator
			   symbol f v p))
499
	    (setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
500
	(if do-all
501 502
	    (setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
		  p (apropos-format-plist symbol "\n    " t)))
503
	(if (or f v p)
504 505 506 507 508
	    (setq apropos-accumulator (cons (list symbol 
						  (+ (apropos-score-str f)
						     (apropos-score-str v)
						     (apropos-score-str p))
						  f v p)
509
					    apropos-accumulator))))))
510
  (apropos-print nil "\n----------------\n"))
511 512


513 514
;;;###autoload
(defun apropos-documentation (apropos-regexp &optional do-all)
Dave Love's avatar
Dave Love committed
515 516
  "Show symbols whose documentation contain matches for APROPOS-REGEXP.
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also use
517 518 519
documentation that is not stored in the documentation file and show key
bindings.
Returns list of symbols and documentation found."
520 521
  (interactive "sApropos documentation (regexp or words): \nP")
  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
522 523 524
  (or do-all (setq do-all apropos-do-all))
  (setq apropos-accumulator () apropos-files-scanned ())
  (let ((standard-input (get-buffer-create " apropos-temp"))
525
	f v sf sv)
526 527 528 529 530 531 532 533
    (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)
534 535 536 537
		       v (get symbol 'variable-documentation))
		 (if (integerp v) (setq v))
		 (setq f (apropos-documentation-internal f)
		       v (apropos-documentation-internal v))
538 539
		 (setq sf (apropos-score-doc f)
		       sv (apropos-score-doc v))
540 541 542 543 544
		 (if (or f v)
		     (if (setq apropos-item
			       (cdr (assq symbol apropos-accumulator)))
			 (progn
			   (if f
545 546 547
			       (progn
				 (setcar (nthcdr 1 apropos-item) f)
				 (setcar apropos-item (+ (car apropos-item) sf))))
548
			   (if v
549 550 551
			       (progn
				 (setcar (nthcdr 2 apropos-item) v)
				 (setcar apropos-item (+ (car apropos-item) sv)))))
552
		       (setq apropos-accumulator
553 554 555
			     (cons (list symbol 
					 (+ (apropos-score-symbol symbol 2) sf sv)
					 f v)
556
				   apropos-accumulator)))))))
557
	  (apropos-print nil "\n----------------\n"))
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
      (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
577
	 (string-match apropos-all-regexp doc)
578 579 580 581 582 583 584 585 586
	 (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)
587 588 589 590
  (setq pl (symbol-plist pl))
  (let (p p-out)
    (while pl
      (setq p (format "%s %S" (car pl) (nth 1 pl)))
591 592
      (if (or (not compare) (string-match apropos-regexp p))
	  (if apropos-property-face
593
	      (put-text-property 0 (length (symbol-name (car pl)))
594
				 'face apropos-property-face p))
595
	(setq p nil))
596 597 598 599 600 601 602
      (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))))
603 604 605
      (setq pl (nthcdr 2 pl)))
    p-out))

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

607
;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
608

609
(defun apropos-documentation-check-doc-file ()
610 611 612
  (let (type symbol (sepa 2) sepb beg end)
    (insert ?\^_)
    (backward-char)
613
    (insert-file-contents (concat doc-directory internal-doc-file-name))
614 615 616 617 618 619 620
    (forward-char)
    (while (save-excursion
	     (setq sepb (search-forward "\^_"))
	     (not (eobp)))
      (beginning-of-line 2)
      (if (save-restriction
	    (narrow-to-region (point) (1- sepb))
621
	    (re-search-forward apropos-all-regexp nil t))
622 623 624 625
	  (progn
	    (setq beg (match-beginning 0)
		  end (point))
	    (goto-char (1+ sepa))
626 627 628 629 630 631 632 633 634 635 636 637 638 639
	    (or (and (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))
			   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)
640 641 642 643 644 645
		      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)))
      (setq sepa (goto-char sepb)))))
646 647 648 649

(defun apropos-documentation-check-elc-file (file)
  (if (member file apropos-files-scanned)
      nil
650
    (let (symbol doc beg end this-is-a-variable)
651 652 653 654 655 656
      (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)
657 658 659 660 661 662
	      beg (1+ (point))
	      end (+ (point) end -1))
	(forward-char)
	(if (save-restriction
	      ;; match ^ and $ relative to doc string
	      (narrow-to-region beg end)
663
	      (re-search-forward apropos-all-regexp nil t))
664
	    (progn
665 666 667 668 669
	      (goto-char (+ end 2))
	      (setq doc (buffer-substring beg end)
		    end (- (match-end 0) beg)
		    beg (- (match-beginning 0) beg)
		    this-is-a-variable (looking-at "(def\\(var\\|const\\) ")
670 671
		    symbol (progn
			     (skip-chars-forward "(a-z")
672
			     (forward-char)
673 674 675 676 677 678 679 680
			     (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
681 682 683 684 685 686 687
		    (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)
688 689 690
			      apropos-accumulator (cons apropos-item
							apropos-accumulator)))
		    (if apropos-match-face
691
			(put-text-property beg end 'face apropos-match-face
692
					   doc))
693
		    (setcar (nthcdr (if this-is-a-variable 3 2)
694
				    apropos-item)
695
			    doc)))))))))
696 697 698 699



(defun apropos-safe-documentation (function)
Dave Love's avatar
Dave Love committed
700
  "Like `documentation', except it avoids calling `get_doc_string'.
Richard M. Stallman's avatar
Richard M. Stallman committed
701
Will return nil instead."
702
  (while (and function (symbolp function))
Richard M. Stallman's avatar
Richard M. Stallman committed
703
    (setq function (if (fboundp function)
704
		       (symbol-function function))))
705 706
  (if (eq (car-safe function) 'macro)
      (setq function (cdr function)))
707
  (setq function (if (byte-code-function-p function)
708 709 710 711 712 713 714 715 716 717 718 719 720 721
		     (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))


722 723 724
(defun apropos-print (do-keys spacing)
  "Output result of apropos searching into buffer `*Apropos*'.
The value of `apropos-accumulator' is the list of items to output.
725 726
Each element should have the format 
 (SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
727 728
The return value is the list that was in `apropos-accumulator', sorted
alphabetically by symbol name; but this function also sets
729 730 731 732
`apropos-accumulator' to nil before returning.

If SPACING is non-nil, it should be a string;
separate items with that string."
733
  (if (null apropos-accumulator)
734
      (message "No apropos matches for `%s'" apropos-orig-regexp)
735 736
    (setq apropos-accumulator
	  (sort apropos-accumulator (lambda (a b)
737 738 739
				      (or (> (cadr a) (cadr b))
					  (and (= (cadr a) (cadr b))
					       (string-lessp (car a) (car b)))))))
740
    (with-output-to-temp-buffer "*Apropos*"
741
      (let ((p apropos-accumulator)
742
	    (old-buffer (current-buffer))
743
	    symbol item)
744 745
	(set-buffer standard-output)
	(apropos-mode)
746
	(if (display-mouse-p)
747 748 749 750 751
	    (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"))
752
	(insert "In this buffer, go to the name of the command, or function,"
753 754 755
		" or variable,\n"
		(substitute-command-keys
		 "and type \\[apropos-follow] to get full documentation.\n\n"))
756
	(while (consp p)
757 758
	  (when (and spacing (not (bobp)))
	    (princ spacing))
759 760
	  (setq apropos-item (car p)
		symbol (car apropos-item)
761 762 763 764 765 766 767
		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)
768 769
	  (if apropos-show-scores
	      (insert " (" (number-to-string (cadr apropos-item)) ") "))
770
	  ;; Calculate key-bindings if we want them.
771 772 773
	  (and do-keys
	       (commandp symbol)
	       (indent-to 30 1)
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
	       (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
796
		    (mapconcat
797
		     (lambda (key)
Dave Love's avatar
Dave Love committed
798
		       (setq key (condition-case ()
799 800
				     (key-description key)
				   (error)))
801
		       (if apropos-keybinding-face
802 803
			   (put-text-property 0 (length key)
					      'face apropos-keybinding-face
804 805 806
					      key))
		       key)
		     item ", "))
807 808 809 810 811 812 813
		 (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)))
814
	  (terpri)
815
	  (apropos-print-doc 2
816
			     (if (commandp symbol)
817
				 'apropos-command
818
			       (if (apropos-macrop symbol)
819 820
				   'apropos-macro
				 'apropos-function))
821
			     t)
822 823 824 825 826
	  (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))
827
	(setq buffer-read-only t))))
828 829 830
  (prog1 apropos-accumulator
    (setq apropos-accumulator ())))	; permit gc

831

832 833 834 835 836 837 838 839 840
(defun apropos-macrop (symbol)
  "T if SYMBOL is a Lisp macro."
  (and (fboundp symbol)
       (consp (setq symbol
		    (symbol-function symbol)))
       (or (eq (car symbol) 'macro)
	   (if (eq (car symbol) 'autoload)
	       (memq (nth 4 symbol)
		     '(macro t))))))
841

842

843
(defun apropos-print-doc (i type do-keys)
844
  (if (stringp (setq i (nth i apropos-item)))
845 846
      (progn
	(insert "  ")
847 848
	(insert-text-button (button-type-get type 'apropos-label)
			    'type type
849 850 851 852
			    ;; 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
853
			    'apropos-symbol (car apropos-item))
854
	(insert ": ")
855 856
	(insert (if do-keys (substitute-command-keys i) i))
	(or (bolp) (terpri)))))
857 858


859 860
(defun apropos-follow ()
  "Invokes any button at point, otherwise invokes the nearest label button."
861
  (interactive)
862 863 864
  (button-activate
   (or (apropos-next-label-button (line-beginning-position))
       (error "There is nothing to follow here"))))
865 866 867 868 869 870 871 872 873


(defun apropos-describe-plist (symbol)
  "Display a pretty listing of SYMBOL's plist."
  (with-output-to-temp-buffer "*Help*"
    (set-buffer standard-output)
    (princ "Symbol ")
    (prin1 symbol)
    (princ "'s plist is\n (")
874 875
    (if apropos-symbol-face
	(put-text-property 8 (- (point) 14) 'face apropos-symbol-face))
876
    (insert (apropos-format-plist symbol "\n  "))
877 878
    (princ ")")
    (print-help-return-message)))
Richard M. Stallman's avatar
Richard M. Stallman committed
879

880

Richard M. Stallman's avatar
Richard M. Stallman committed
881 882
(provide 'apropos)

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