lisp/apropos.el

   1 ;;; apropos.el --- apropos commands for users and programmers
   2
   3 ;; Copyright (C) 1989, 1994, 1995, 2001, 2002 Free Software Foundation, Inc.
   4
   5 ;; Author: Joe Wells <jbw@bigbird.bu.edu>
   6 ;; Rewritten: Daniel Pfeiffer <occitan@esperanto.org>
   7 ;; Keywords: help
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; The ideas for this package were derived from the C code in
  29 ;; src/keymap.c and elsewhere.  The functions in this file should
  30 ;; always be byte-compiled for speed.  Someone should rewrite this in
  31 ;; C (as part of src/keymap.c) for speed.
  32
  33 ;; The idea for super-apropos is based on the original implementation
  34 ;; by Lynn Slater <lrs@esl.com>.
  35
  36 ;; History:
  37 ;; Fixed bug, current-local-map can return nil.
  38 ;; Change, doesn't calculate key-bindings unless needed.
  39 ;; Added super-apropos capability, changed print functions.
  40 ;;; Made fast-apropos and super-apropos share code.
  41 ;;; Sped up fast-apropos again.
  42 ;; Added apropos-do-all option.
  43 ;;; Added fast-command-apropos.
  44 ;; Changed doc strings to comments for helping functions.
  45 ;;; Made doc file buffer read-only, buried it.
  46 ;; Only call substitute-command-keys if do-all set.
  47
  48 ;; Optionally use configurable faces to make the output more legible.
  49 ;; Differentiate between command, function and macro.
  50 ;; Apropos-command (ex command-apropos) does cmd and optionally user var.
  51 ;; Apropos shows all 3 aspects of symbols (fn, var and plist)
  52 ;; Apropos-documentation (ex super-apropos) now finds all it should.
  53 ;; New apropos-value snoops through all values and optionally plists.
  54 ;; Reading DOC file doesn't load nroff.
  55 ;; Added hypertext following of documentation, mouse-2 on variable gives value
  56 ;;   from buffer in active window.
  57
  58 ;;; Code:
  59
  60 (require 'button)
  61
  62 (defgroup apropos nil
  63   "Apropos commands for users and programmers"
  64   :group 'help
  65   :prefix "apropos")
  66
  67 ;; I see a degradation of maybe 10-20% only.
  68 (defcustom apropos-do-all nil
  69   "*Whether the apropos commands should do more.
  70
  71 Slows them down more or less.  Set this non-nil if you have a fast machine."
  72   :group 'apropos
  73   :type 'boolean)
  74
  75
  76 (defcustom apropos-symbol-face 'bold
  77   "*Face for symbol name in Apropos output, or nil for none."
  78   :group 'apropos
  79   :type 'face)
  80
  81 (defcustom apropos-keybinding-face 'underline
  82   "*Face for lists of keybinding in Apropos output, or nil for none."
  83   :group 'apropos
  84   :type 'face)
  85
  86 (defcustom apropos-label-face 'italic
  87   "*Face for label (`Command', `Variable' ...) in Apropos output.
  88 A value of nil means don't use any special font for them, and also
  89 turns off mouse highlighting."
  90   :group 'apropos
  91   :type 'face)
  92
  93 (defcustom apropos-property-face 'bold-italic
  94   "*Face for property name in apropos output, or nil for none."
  95   :group 'apropos
  96   :type 'face)
  97
  98 (defcustom apropos-match-face 'secondary-selection
  99   "*Face for matching text in Apropos documentation/value, or nil for none.
 100 This applies when you look for matches in the documentation or variable value
 101 for the regexp; the part that matches gets displayed in this font."
 102   :group 'apropos
 103   :type 'face)
 104
 105
 106 (defvar apropos-mode-map
 107   (let ((map (make-sparse-keymap)))
 108     (set-keymap-parent map button-buffer-map)
 109     ;; Use `apropos-follow' instead of just using the button
 110     ;; definition of RET, so that users can use it anywhere in an
 111     ;; apropos item, not just on top of a button.
 112     (define-key map "\C-m" 'apropos-follow)
 113     (define-key map " "    'scroll-up)
 114     (define-key map "\177" 'scroll-down)
 115     (define-key map "q"    'quit-window)
 116     map)
 117   "Keymap used in Apropos mode.")
 118
 119 (defvar apropos-mode-hook nil
 120   "*Hook run when mode is turned on.")
 121
 122 (defvar apropos-show-scores nil
 123   "*Show apropos scores if non-nil.")
 124
 125 (defvar apropos-regexp nil
 126   "Regexp used in current apropos run.")
 127
 128 (defvar apropos-orig-regexp nil
 129   "Regexp as entered by user.")
 130
 131 (defvar apropos-all-regexp nil
 132   "Regexp matching apropos-all-words.")
 133
 134 (defvar apropos-files-scanned ()
 135   "List of elc files already scanned in current run of `apropos-documentation'.")
 136
 137 (defvar apropos-accumulator ()
 138   "Alist of symbols already found in current apropos run.")
 139
 140 (defvar apropos-item ()
 141   "Current item in or for `apropos-accumulator'.")
 142
 143 (defvar apropos-synonyms '(
 144   ("find" "open" "edit")
 145   ("kill" "cut")
 146   ("yank" "paste"))
 147   "List of synonyms known by apropos.
 148 Each element is a list of words where the first word is the standard emacs
 149 term, and the rest of the words are alternative terms.")
 150
 151 (defvar apropos-words ()
 152   "Current list of words.")
 153
 154 (defvar apropos-all-words ()
 155   "Current list of words and synonyms.")
 156
 157 \f
 158 ;;; Button types used by apropos
 159
 160 (define-button-type 'apropos-symbol
 161   'face apropos-symbol-face
 162   'help-echo "mouse-2, RET: Display more help on this symbol"
 163   'action #'apropos-symbol-button-display-help
 164   'skip t)
 165
 166 (defun apropos-symbol-button-display-help (button)
 167   "Display further help for the `apropos-symbol' button BUTTON."
 168   (button-activate
 169    (or (apropos-next-label-button (button-start button))
 170        (error "There is nothing to follow for `%s'" (button-label button)))))
 171
 172 (define-button-type 'apropos-function
 173   'apropos-label "Function"
 174   'action (lambda (button)
 175             (describe-function (button-get button 'apropos-symbol)))
 176   'help-echo "mouse-2, RET: Display more help on this function")
 177 (define-button-type 'apropos-macro
 178   'apropos-label "Macro"
 179   'action (lambda (button)
 180             (describe-function (button-get button 'apropos-symbol)))
 181   'help-echo "mouse-2, RET: Display more help on this macro")
 182 (define-button-type 'apropos-command
 183   'apropos-label "Command"
 184   'action (lambda (button)
 185             (describe-function (button-get button 'apropos-symbol)))
 186   'help-echo "mouse-2, RET: Display more help on this command")
 187
 188 ;; We used to use `customize-variable-other-window' instead for a
 189 ;; customizable variable, but that is slow.  It is better to show an
 190 ;; ordinary help buffer and let the user click on the customization
 191 ;; button in that buffer, if he wants to.
 192 ;; Likewise for `customize-face-other-window'.
 193 (define-button-type 'apropos-variable
 194   'apropos-label "Variable"
 195   'help-echo "mouse-2, RET: Display more help on this variable"
 196   'action (lambda (button)
 197             (describe-variable (button-get button 'apropos-symbol))))
 198
 199 (define-button-type 'apropos-face
 200   'apropos-label "Face"
 201   'help-echo "mouse-2, RET: Display more help on this face"
 202   'action (lambda (button)
 203             (describe-face (button-get button 'apropos-symbol))))
 204
 205 (define-button-type 'apropos-group
 206   'apropos-label "Group"
 207   'help-echo "mouse-2, RET: Display more help on this group"
 208   'action (lambda (button)
 209             (customize-group-other-window
 210              (button-get button 'apropos-symbol))))
 211
 212 (define-button-type 'apropos-widget
 213   'apropos-label "Widget"
 214   'help-echo "mouse-2, RET: Display more help on this widget"
 215   'action (lambda (button)
 216             (widget-browse-other-window (button-get button 'apropos-symbol))))
 217
 218 (define-button-type 'apropos-plist
 219   'apropos-label "Plist"
 220   'help-echo "mouse-2, RET: Display more help on this plist"
 221   'action (lambda (button)
 222             (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 Will also return nil if more than one `apropos-symbol' button is encountered
 227 before finding a label."
 228   (let* ((button (next-button pos t))
 229          (already-hit-symbol nil)
 230          (label (and button (button-get button 'apropos-label)))
 231          (type (and button (button-get button 'type))))
 232     (while (and button
 233                 (not label)
 234                 (or (not (eq type 'apropos-symbol))
 235                     (not already-hit-symbol)))
 236       (when (eq type 'apropos-symbol)
 237         (setq already-hit-symbol t))
 238       (setq button (next-button (button-start button)))
 239       (when button
 240         (setq label (button-get button 'apropos-label))
 241         (setq type (button-get button 'type))))
 242     (and label button)))
 243
 244 \f
 245 (defun apropos-words-to-regexp (words wild)
 246   "Make regexp matching any two of the words in WORDS."
 247   (concat "\\("
 248           (mapconcat 'identity words "\\|")
 249           "\\)" wild
 250           (if (cdr words)
 251               (concat "\\("
 252                       (mapconcat 'identity words "\\|")
 253                       "\\)")
 254             "")))
 255
 256 (defun apropos-rewrite-regexp (regexp)
 257   "Rewrite a list of words to a regexp matching all permutations.
 258 If REGEXP is already a regexp, don't modify it."
 259   (setq apropos-orig-regexp regexp)
 260   (setq apropos-words () apropos-all-words ())
 261   (if (string-equal (regexp-quote regexp) regexp)
 262       ;; We don't actually make a regexp matching all permutations.
 263       ;; Instead, for e.g. "a b c", we make a regexp matching
 264       ;; any combination of two or more words like this:
 265       ;; (a|b|c).*(a|b|c) which may give some false matches,
 266       ;; but as long as it also gives the right ones, that's ok.
 267       (let ((words (split-string regexp "[ \t]+")))
 268         (dolist (word words)
 269           (let ((syn apropos-synonyms) (s word) (a word))
 270             (while syn
 271               (if (member word (car syn))
 272                   (progn
 273                     (setq a (mapconcat 'identity (car syn) "\\|"))
 274                     (if (member word (cdr (car syn)))
 275                         (setq s a))
 276                     (setq syn nil))
 277                 (setq syn (cdr syn))))
 278             (setq apropos-words (cons s apropos-words)
 279                   apropos-all-words (cons a apropos-all-words))))
 280         (setq apropos-all-regexp (apropos-words-to-regexp apropos-all-words ".+"))
 281         (apropos-words-to-regexp apropos-words ".*?"))
 282     (setq apropos-all-regexp regexp)))
 283
 284 (defun apropos-calc-scores (str words)
 285   "Return apropos scores for string STR matching WORDS.
 286 Value is a list of offsets of the words into the string."
 287   (let ((scores ())
 288         i)
 289     (if words
 290         (dolist (word words scores)
 291           (if (setq i (string-match word str))
 292               (setq scores (cons i scores))))
 293       ;; Return list of start and end position of regexp
 294       (string-match apropos-regexp str)
 295       (list (match-beginning 0) (match-end 0)))))
 296
 297 (defun apropos-score-str (str)
 298   "Return apropos score for string STR."
 299   (if str
 300       (let* (
 301              (l (length str))
 302              (score (- (/ l 10)))
 303             i)
 304         (dolist (s (apropos-calc-scores str apropos-all-words) score)
 305           (setq score (+ score 1000 (/ (* (- l s) 1000) l)))))
 306       0))
 307
 308 (defun apropos-score-doc (doc)
 309   "Return apropos score for documentation string DOC."
 310   (if doc
 311       (let ((score 0)
 312             (l (length doc))
 313             i)
 314         (dolist (s (apropos-calc-scores doc apropos-all-words) score)
 315           (setq score (+ score 50 (/ (* (- l s) 50) l)))))
 316       0))
 317
 318 (defun apropos-score-symbol (symbol &optional weight)
 319   "Return apropos score for SYMBOL."
 320   (setq symbol (symbol-name symbol))
 321   (let ((score 0)
 322         (l (length symbol))
 323         i)
 324     (dolist (s (apropos-calc-scores symbol apropos-words) (* score (or weight 3)))
 325       (setq score (+ score (- 60 l) (/ (* (- l s) 60) l))))))
 326
 327 (defun apropos-true-hit (str words)
 328   "Return t if STR is a genuine hit.
 329 This may fail if only one of the keywords is matched more than once.
 330 This requires that at least 2 keywords (unless only one was given)."
 331   (or (not str)
 332       (not words)
 333       (not (cdr words))
 334       (> (length (apropos-calc-scores str words)) 1)))
 335
 336 (defun apropos-false-hit-symbol (symbol)
 337   "Return t if SYMBOL is not really matched by the current keywords."
 338   (not (apropos-true-hit (symbol-name symbol) apropos-words)))
 339
 340 (defun apropos-false-hit-str (str)
 341   "Return t if STR is not really matched by the current keywords."
 342   (not (apropos-true-hit str apropos-words)))
 343
 344 (defun apropos-true-hit-doc (doc)
 345   "Return t if DOC is really matched by the current keywords."
 346   (apropos-true-hit doc apropos-all-words))
 347
 348 ;;;###autoload
 349 (define-derived-mode apropos-mode fundamental-mode "Apropos"
 350   "Major mode for following hyperlinks in output of apropos commands.
 351
 352 \\{apropos-mode-map}")
 353
 354 ;;;###autoload
 355 (defun apropos-variable (regexp &optional do-all)
 356   "Show user variables that match REGEXP.
 357 With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also show
 358 normal variables."
 359   (interactive (list (read-string
 360                       (concat "Apropos "
 361                               (if (or current-prefix-arg apropos-do-all)
 362                                   "variable"
 363                                 "user option")
 364                               " (regexp or words): "))
 365                      current-prefix-arg))
 366   (apropos-command regexp nil
 367                    (if (or do-all apropos-do-all)
 368                        #'(lambda (symbol)
 369                            (and (boundp symbol)
 370                                 (get symbol 'variable-documentation)))
 371                      'user-variable-p)))
 372
 373 ;; For auld lang syne:
 374 ;;;###autoload
 375 (defalias 'command-apropos 'apropos-command)
 376 ;;;###autoload
 377 (defun apropos-command (apropos-regexp &optional do-all var-predicate)
 378   "Show commands (interactively callable functions) that match APROPOS-REGEXP.
 379 With optional prefix DO-ALL, or if `apropos-do-all' is non-nil, also show
 380 noninteractive functions.
 381
 382 If VAR-PREDICATE is non-nil, show only variables, and only those that
 383 satisfy the predicate VAR-PREDICATE."
 384   (interactive (list (read-string (concat
 385                                    "Apropos command "
 386                                    (if (or current-prefix-arg
 387                                            apropos-do-all)
 388                                        "or function ")
 389                                    "(regexp or words): "))
 390                      current-prefix-arg))
 391   (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
 392   (let ((message
 393          (let ((standard-output (get-buffer-create "*Apropos*")))
 394            (print-help-return-message 'identity))))
 395     (or do-all (setq do-all apropos-do-all))
 396     (setq apropos-accumulator
 397           (apropos-internal apropos-regexp
 398                             (or var-predicate
 399                                 (if do-all 'functionp 'commandp))))
 400     (let ((tem apropos-accumulator))
 401       (while tem
 402         (if (or (get (car tem) 'apropos-inhibit)
 403                 (apropos-false-hit-symbol (car tem)))
 404             (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
 405         (setq tem (cdr tem))))
 406     (let ((p apropos-accumulator)
 407           doc symbol score)
 408       (while p
 409         (setcar p (list
 410                    (setq symbol (car p))
 411                    (setq score (apropos-score-symbol symbol))
 412                    (unless var-predicate
 413                      (if (functionp symbol)
 414                          (if (setq doc (documentation symbol t))
 415                              (progn
 416                                (setq score (+ score (apropos-score-doc doc)))
 417                                (substring doc 0 (string-match "\n" doc)))
 418                            "(not documented)")))
 419                    (and var-predicate
 420                         (funcall var-predicate symbol)
 421                         (if (setq doc (documentation-property
 422                                        symbol 'variable-documentation t))
 423                              (progn
 424                                (setq score (+ score (apropos-score-doc doc)))
 425                                (substring doc 0
 426                                           (string-match "\n" doc)))))))
 427         (setcar (cdr (car p)) score)
 428         (setq p (cdr p))))
 429     (and (apropos-print t nil)
 430          message
 431          (message message))))
 432
 433
 434 ;;;###autoload
 435 (defun apropos-documentation-property (symbol property raw)
 436   "Like (documentation-property SYMBOL PROPERTY RAW) but handle errors."
 437   (condition-case ()
 438       (let ((doc (documentation-property symbol property raw)))
 439         (if doc (substring doc 0 (string-match "\n" doc))
 440           "(not documented)"))
 441     (error "(error retrieving documentation)")))
 442
 443
 444 ;;;###autoload
 445 (defun apropos (apropos-regexp &optional do-all)
 446   "Show all bound symbols whose names match APROPOS-REGEXP.
 447 With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also
 448 show unbound symbols and key bindings, which is a little more
 449 time-consuming.  Returns list of symbols and documentation found."
 450   (interactive "sApropos symbol (regexp or words): \nP")
 451   (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
 452   (setq apropos-accumulator
 453         (apropos-internal apropos-regexp
 454                           (and (not do-all)
 455                                (not apropos-do-all)
 456                                (lambda (symbol)
 457                                  (or (fboundp symbol)
 458                                      (boundp symbol)
 459                                      (facep symbol)
 460                                      (symbol-plist symbol))))))
 461   (let ((tem apropos-accumulator))
 462     (while tem
 463       (if (get (car tem) 'apropos-inhibit)
 464           (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
 465       (setq tem (cdr tem))))
 466   (let ((p apropos-accumulator)
 467         symbol doc properties)
 468     (while p
 469       (setcar p (list
 470                  (setq symbol (car p))
 471                  0
 472                  (when (fboundp symbol)
 473                    (if (setq doc (condition-case nil
 474                                      (documentation symbol t)
 475                                    (void-function
 476                                     "(alias for undefined function)")
 477                                    (error
 478                                     "(error retrieving function documentation)")))
 479                        (substring doc 0 (string-match "\n" doc))
 480                      "(not documented)"))
 481                  (when (boundp symbol)
 482                    (apropos-documentation-property
 483                     symbol 'variable-documentation t))
 484                  (when (setq properties (symbol-plist symbol))
 485                    (setq doc (list (car properties)))
 486                    (while (setq properties (cdr (cdr properties)))
 487                      (setq doc (cons (car properties) doc)))
 488                    (mapconcat #'symbol-name (nreverse doc) " "))
 489                  (when (get symbol 'widget-type)
 490                    (apropos-documentation-property
 491                     symbol 'widget-documentation t))
 492                  (when (facep symbol)
 493                    (apropos-documentation-property
 494                     symbol 'face-documentation t))
 495                  (when (get symbol 'custom-group)
 496                    (apropos-documentation-property
 497                     symbol 'group-documentation t))))
 498       (setq p (cdr p))))
 499   (apropos-print
 500    (or do-all apropos-do-all)
 501    nil))
 502
 503
 504 ;;;###autoload
 505 (defun apropos-value (apropos-regexp &optional do-all)
 506   "Show all symbols whose value's printed image matches APROPOS-REGEXP.
 507 With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also looks
 508 at the function and at the names and values of properties.
 509 Returns list of symbols and values found."
 510   (interactive "sApropos value (regexp or words): \nP")
 511   (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
 512   (or do-all (setq do-all apropos-do-all))
 513   (setq apropos-accumulator ())
 514    (let (f v p)
 515      (mapatoms
 516       (lambda (symbol)
 517         (setq f nil v nil p nil)
 518         (or (memq symbol '(apropos-regexp
 519                            apropos-orig-regexp apropos-all-regexp
 520                            apropos-words apropos-all-words
 521                            do-all apropos-accumulator
 522                            symbol f v p))
 523             (setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
 524         (if do-all
 525             (setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
 526                   p (apropos-format-plist symbol "\n    " t)))
 527         (if (apropos-false-hit-str v)
 528             (setq v nil))
 529         (if (apropos-false-hit-str f)
 530             (setq f nil))
 531         (if (apropos-false-hit-str p)
 532             (setq p nil))
 533         (if (or f v p)
 534             (setq apropos-accumulator (cons (list symbol
 535                                                   (+ (apropos-score-str f)
 536                                                      (apropos-score-str v)
 537                                                      (apropos-score-str p))
 538                                                   f v p)
 539                                             apropos-accumulator))))))
 540   (apropos-print nil "\n----------------\n"))
 541
 542
 543 ;;;###autoload
 544 (defun apropos-documentation (apropos-regexp &optional do-all)
 545   "Show symbols whose documentation contain matches for APROPOS-REGEXP.
 546 With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also use
 547 documentation that is not stored in the documentation file and show key
 548 bindings.
 549 Returns list of symbols and documentation found."
 550   (interactive "sApropos documentation (regexp or words): \nP")
 551   (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
 552   (or do-all (setq do-all apropos-do-all))
 553   (setq apropos-accumulator () apropos-files-scanned ())
 554   (let ((standard-input (get-buffer-create " apropos-temp"))
 555         f v sf sv)
 556     (unwind-protect
 557         (save-excursion
 558           (set-buffer standard-input)
 559           (apropos-documentation-check-doc-file)
 560           (if do-all
 561               (mapatoms
 562                (lambda (symbol)
 563                  (setq f (apropos-safe-documentation symbol)
 564                        v (get symbol 'variable-documentation))
 565                  (if (integerp v) (setq v))
 566                  (setq f (apropos-documentation-internal f)
 567                        v (apropos-documentation-internal v))
 568                  (setq sf (apropos-score-doc f)
 569                        sv (apropos-score-doc v))
 570                  (if (or f v)
 571                      (if (setq apropos-item
 572                                (cdr (assq symbol apropos-accumulator)))
 573                          (progn
 574                            (if f
 575                                (progn
 576                                  (setcar (nthcdr 1 apropos-item) f)
 577                                  (setcar apropos-item (+ (car apropos-item) sf))))
 578                            (if v
 579                                (progn
 580                                  (setcar (nthcdr 2 apropos-item) v)
 581                                  (setcar apropos-item (+ (car apropos-item) sv)))))
 582                        (setq apropos-accumulator
 583                              (cons (list symbol
 584                                          (+ (apropos-score-symbol symbol 2) sf sv)
 585                                          f v)
 586                                    apropos-accumulator)))))))
 587           (apropos-print nil "\n----------------\n"))
 588       (kill-buffer standard-input))))
 589
 590 \f
 591 (defun apropos-value-internal (predicate symbol function)
 592   (if (funcall predicate symbol)
 593       (progn
 594         (setq symbol (prin1-to-string (funcall function symbol)))
 595         (if (string-match apropos-regexp symbol)
 596             (progn
 597               (if apropos-match-face
 598                   (put-text-property (match-beginning 0) (match-end 0)
 599                                      'face apropos-match-face
 600                                      symbol))
 601               symbol)))))
 602
 603 (defun apropos-documentation-internal (doc)
 604   (if (consp doc)
 605       (apropos-documentation-check-elc-file (car doc))
 606     (and doc
 607          (string-match apropos-all-regexp doc)
 608          (save-match-data (apropos-true-hit-doc doc))
 609          (progn
 610            (if apropos-match-face
 611                (put-text-property (match-beginning 0)
 612                                   (match-end 0)
 613                                   'face apropos-match-face
 614                                   (setq doc (copy-sequence doc))))
 615            doc))))
 616
 617 (defun apropos-format-plist (pl sep &optional compare)
 618   (setq pl (symbol-plist pl))
 619   (let (p p-out)
 620     (while pl
 621       (setq p (format "%s %S" (car pl) (nth 1 pl)))
 622       (if (or (not compare) (string-match apropos-regexp p))
 623           (if apropos-property-face
 624               (put-text-property 0 (length (symbol-name (car pl)))
 625                                  'face apropos-property-face p))
 626         (setq p nil))
 627       (if p
 628           (progn
 629             (and compare apropos-match-face
 630                  (put-text-property (match-beginning 0) (match-end 0)
 631                                     'face apropos-match-face
 632                                     p))
 633             (setq p-out (concat p-out (if p-out sep) p))))
 634       (setq pl (nthcdr 2 pl)))
 635     p-out))
 636
 637
 638 ;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
 639
 640 (defun apropos-documentation-check-doc-file ()
 641   (let (type symbol (sepa 2) sepb beg end)
 642     (insert ?\^_)
 643     (backward-char)
 644     (insert-file-contents (concat doc-directory internal-doc-file-name))
 645     (forward-char)
 646     (while (save-excursion
 647              (setq sepb (search-forward "\^_"))
 648              (not (eobp)))
 649       (beginning-of-line 2)
 650       (if (save-restriction
 651             (narrow-to-region (point) (1- sepb))
 652             (re-search-forward apropos-all-regexp nil t))
 653           (progn
 654             (setq beg (match-beginning 0)
 655                   end (point))
 656             (goto-char (1+ sepa))
 657             (setq type (if (eq ?F (preceding-char))
 658                            2    ; function documentation
 659                          3)             ; variable documentation
 660                   symbol (read)
 661                   beg (- beg (point) 1)
 662                   end (- end (point) 1)
 663                   doc (buffer-substring (1+ (point)) (1- sepb)))
 664             (when (apropos-true-hit-doc doc)
 665               (or (and (setq apropos-item (assq symbol apropos-accumulator))
 666                        (setcar (cdr apropos-item)
 667                                (+ (cadr apropos-item) (apropos-score-doc doc))))
 668                   (setq apropos-item (list symbol
 669                                            (+ (apropos-score-symbol symbol 2)
 670                                               (apropos-score-doc doc))
 671                                            nil nil)
 672                         apropos-accumulator (cons apropos-item
 673                                                   apropos-accumulator)))
 674               (if apropos-match-face
 675                   (put-text-property beg end 'face apropos-match-face doc))
 676               (setcar (nthcdr type apropos-item) doc))))
 677       (setq sepa (goto-char sepb)))))
 678
 679 (defun apropos-documentation-check-elc-file (file)
 680   (if (member file apropos-files-scanned)
 681       nil
 682     (let (symbol doc beg end this-is-a-variable)
 683       (setq apropos-files-scanned (cons file apropos-files-scanned))
 684       (erase-buffer)
 685       (insert-file-contents file)
 686       (while (search-forward "\n#@" nil t)
 687         ;; Read the comment length, and advance over it.
 688         (setq end (read)
 689               beg (1+ (point))
 690               end (+ (point) end -1))
 691         (forward-char)
 692         (if (save-restriction
 693               ;; match ^ and $ relative to doc string
 694               (narrow-to-region beg end)
 695               (re-search-forward apropos-all-regexp nil t))
 696             (progn
 697               (goto-char (+ end 2))
 698               (setq doc (buffer-substring beg end)
 699                     end (- (match-end 0) beg)
 700                     beg (- (match-beginning 0) beg))
 701               (when (apropos-true-hit-doc doc)
 702                 (setq this-is-a-variable (looking-at "(def\\(var\\|const\\) ")
 703                       symbol (progn
 704                                (skip-chars-forward "(a-z")
 705                                (forward-char)
 706                                (read))
 707                       symbol (if (consp symbol)
 708                                  (nth 1 symbol)
 709                                symbol))
 710                 (if (if this-is-a-variable
 711                         (get symbol 'variable-documentation)
 712                       (and (fboundp symbol) (apropos-safe-documentation symbol)))
 713                     (progn
 714                       (or (and (setq apropos-item (assq symbol apropos-accumulator))
 715                                (setcar (cdr apropos-item)
 716                                        (+ (cadr apropos-item) (apropos-score-doc doc))))
 717                           (setq apropos-item (list symbol
 718                                                    (+ (apropos-score-symbol symbol 2)
 719                                                       (apropos-score-doc doc))
 720                                                    nil nil)
 721                                 apropos-accumulator (cons apropos-item
 722                                                           apropos-accumulator)))
 723                       (if apropos-match-face
 724                           (put-text-property beg end 'face apropos-match-face
 725                                              doc))
 726                       (setcar (nthcdr (if this-is-a-variable 3 2)
 727                                       apropos-item)
 728                               doc))))))))))
 729
 730
 731
 732 (defun apropos-safe-documentation (function)
 733   "Like `documentation', except it avoids calling `get_doc_string'.
 734 Will return nil instead."
 735   (while (and function (symbolp function))
 736     (setq function (if (fboundp function)
 737                        (symbol-function function))))
 738   (if (eq (car-safe function) 'macro)
 739       (setq function (cdr function)))
 740   (setq function (if (byte-code-function-p function)
 741                      (if (> (length function) 4)
 742                          (aref function 4))
 743                    (if (eq (car-safe function) 'autoload)
 744                        (nth 2 function)
 745                      (if (eq (car-safe function) 'lambda)
 746                          (if (stringp (nth 2 function))
 747                              (nth 2 function)
 748                            (if (stringp (nth 3 function))
 749                                (nth 3 function)))))))
 750   (if (integerp function)
 751       nil
 752     function))
 753
 754
 755 (defun apropos-print (do-keys spacing)
 756   "Output result of apropos searching into buffer `*Apropos*'.
 757 The value of `apropos-accumulator' is the list of items to output.
 758 Each element should have the format
 759  (SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
 760 The return value is the list that was in `apropos-accumulator', sorted
 761 alphabetically by symbol name; but this function also sets
 762 `apropos-accumulator' to nil before returning.
 763
 764 If SPACING is non-nil, it should be a string;
 765 separate items with that string."
 766   (if (null apropos-accumulator)
 767       (message "No apropos matches for `%s'" apropos-orig-regexp)
 768     (setq apropos-accumulator
 769           (sort apropos-accumulator (lambda (a b)
 770                                       (or (> (cadr a) (cadr b))
 771                                           (and (= (cadr a) (cadr b))
 772                                                (string-lessp (car a) (car b)))))))
 773     (with-output-to-temp-buffer "*Apropos*"
 774       (let ((p apropos-accumulator)
 775             (old-buffer (current-buffer))
 776             symbol item)
 777         (set-buffer standard-output)
 778         (apropos-mode)
 779         (if (display-mouse-p)
 780             (insert
 781              "If moving the mouse over text changes the text's color, "
 782              "you can click\n"
 783              "mouse-2 (second button from right) on that text to "
 784              "get more information.\n"))
 785         (insert "In this buffer, go to the name of the command, or function,"
 786                 " or variable,\n"
 787                 (substitute-command-keys
 788                  "and type \\[apropos-follow] to get full documentation.\n\n"))
 789         (while (consp p)
 790           (when (and spacing (not (bobp)))
 791             (princ spacing))
 792           (setq apropos-item (car p)
 793                 symbol (car apropos-item)
 794                 p (cdr p))
 795           (insert-text-button (symbol-name symbol)
 796                               'type 'apropos-symbol
 797                               ;; Can't use default, since user may have
 798                               ;; changed the variable!
 799                               ;; Just say `no' to variables containing faces!
 800                               'face apropos-symbol-face)
 801           (if apropos-show-scores
 802               (insert " (" (number-to-string (cadr apropos-item)) ") "))
 803           ;; Calculate key-bindings if we want them.
 804           (and do-keys
 805                (commandp symbol)
 806                (indent-to 30 1)
 807                (if (let ((keys
 808                           (save-excursion
 809                             (set-buffer old-buffer)
 810                             (where-is-internal symbol)))
 811                          filtered)
 812                      ;; Copy over the list of key sequences,
 813                      ;; omitting any that contain a buffer or a frame.
 814                      (while keys
 815                        (let ((key (car keys))
 816                              (i 0)
 817                              loser)
 818                          (while (< i (length key))
 819                            (if (or (framep (aref key i))
 820                                    (bufferp (aref key i)))
 821                                (setq loser t))
 822                            (setq i (1+ i)))
 823                          (or loser
 824                              (setq filtered (cons key filtered))))
 825                        (setq keys (cdr keys)))
 826                      (setq item filtered))
 827                    ;; Convert the remaining keys to a string and insert.
 828                    (insert
 829                     (mapconcat
 830                      (lambda (key)
 831                        (setq key (condition-case ()
 832                                      (key-description key)
 833                                    (error)))
 834                        (if apropos-keybinding-face
 835                            (put-text-property 0 (length key)
 836                                               'face apropos-keybinding-face
 837                                               key))
 838                        key)
 839                      item ", "))
 840                  (insert "M-x")
 841                  (put-text-property (- (point) 3) (point)
 842                                     'face apropos-keybinding-face)
 843                  (insert " " (symbol-name symbol) " ")
 844                  (insert "RET")
 845                  (put-text-property (- (point) 3) (point)
 846                                     'face apropos-keybinding-face)))
 847           (terpri)
 848           (apropos-print-doc 2
 849                              (if (commandp symbol)
 850                                  'apropos-command
 851                                (if (apropos-macrop symbol)
 852                                    'apropos-macro
 853                                  'apropos-function))
 854                              t)
 855           (apropos-print-doc 3 'apropos-variable t)
 856           (apropos-print-doc 7 'apropos-group t)
 857           (apropos-print-doc 6 'apropos-face t)
 858           (apropos-print-doc 5 'apropos-widget t)
 859           (apropos-print-doc 4 'apropos-plist nil))
 860         (setq buffer-read-only t))))
 861   (prog1 apropos-accumulator
 862     (setq apropos-accumulator ())))     ; permit gc
 863
 864
 865 (defun apropos-macrop (symbol)
 866   "T if SYMBOL is a Lisp macro."
 867   (and (fboundp symbol)
 868        (consp (setq symbol
 869                     (symbol-function symbol)))
 870        (or (eq (car symbol) 'macro)
 871            (if (eq (car symbol) 'autoload)
 872                (memq (nth 4 symbol)
 873                      '(macro t))))))
 874
 875
 876 (defun apropos-print-doc (i type do-keys)
 877   (if (stringp (setq i (nth i apropos-item)))
 878       (progn
 879         (insert "  ")
 880         (insert-text-button (button-type-get type 'apropos-label)
 881                             'type type
 882                             ;; Can't use the default button face, since
 883                             ;; user may have changed the variable!
 884                             ;; Just say `no' to variables containing faces!
 885                             'face apropos-label-face
 886                             'apropos-symbol (car apropos-item))
 887         (insert ": ")
 888         (insert (if do-keys (substitute-command-keys i) i))
 889         (or (bolp) (terpri)))))
 890
 891
 892 (defun apropos-follow ()
 893   "Invokes any button at point, otherwise invokes the nearest label button."
 894   (interactive)
 895   (button-activate
 896    (or (apropos-next-label-button (line-beginning-position))
 897        (error "There is nothing to follow here"))))
 898
 899
 900 (defun apropos-describe-plist (symbol)
 901   "Display a pretty listing of SYMBOL's plist."
 902   (with-output-to-temp-buffer "*Help*"
 903     (set-buffer standard-output)
 904     (princ "Symbol ")
 905     (prin1 symbol)
 906     (princ "'s plist is\n (")
 907     (if apropos-symbol-face
 908         (put-text-property 8 (- (point) 14) 'face apropos-symbol-face))
 909     (insert (apropos-format-plist symbol "\n  "))
 910     (princ ")")
 911     (print-help-return-message)))
 912
 913
 914 (provide 'apropos)
 915
 916 ;;; apropos.el ends here