1 ;;; apropos.el --- apropos commands for users and programmers
3 ;; Copyright (C) 1989, 1994, 1995, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Joe Wells <jbw@bigbird.bu.edu>
7 ;; Rewritten: Daniel Pfeiffer <occitan@esperanto.org>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; The ideas for this package were derived from the C code in
28 ;; src/keymap.c and elsewhere. The functions in this file should
29 ;; always be byte-compiled for speed. Someone should rewrite this in
30 ;; C (as part of src/keymap.c) for speed.
32 ;; The idea for super-apropos is based on the original implementation
33 ;; by Lynn Slater <lrs@esl.com>.
36 ;; Fixed bug, current-local-map can return nil.
37 ;; Change, doesn't calculate key-bindings unless needed.
38 ;; Added super-apropos capability, changed print functions.
39 ;;; Made fast-apropos and super-apropos share code.
40 ;;; Sped up fast-apropos again.
41 ;; Added apropos-do-all option.
42 ;;; Added fast-command-apropos.
43 ;; Changed doc strings to comments for helping functions.
44 ;;; Made doc file buffer read-only, buried it.
45 ;; Only call substitute-command-keys if do-all set.
47 ;; Optionally use configurable faces to make the output more legible.
48 ;; Differentiate between command, function and macro.
49 ;; Apropos-command (ex command-apropos) does cmd and optionally user var.
50 ;; Apropos shows all 3 aspects of symbols (fn, var and plist)
51 ;; Apropos-documentation (ex super-apropos) now finds all it should.
52 ;; New apropos-value snoops through all values and optionally plists.
53 ;; Reading DOC file doesn't load nroff.
54 ;; Added hypertext following of documentation, mouse-2 on variable gives value
55 ;; from buffer in active window.
60 (eval-when-compile (require 'cl
))
63 "Apropos commands for users and programmers."
67 ;; I see a degradation of maybe 10-20% only.
68 (defcustom apropos-do-all nil
69 "Whether the apropos commands should do more.
71 Slows them down more or less. Set this non-nil if you have a fast machine."
76 (defcustom apropos-symbol-face
'bold
77 "Face for symbol name in Apropos output, or nil for none."
81 (defcustom apropos-keybinding-face
'underline
82 "Face for lists of keybinding in Apropos output, or nil for none."
86 (defcustom apropos-label-face
'(italic variable-pitch
)
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."
93 (defcustom apropos-property-face
'bold-italic
94 "Face for property name in apropos output, or nil for none."
98 (defcustom apropos-match-face
'match
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 pattern; the part that matches gets displayed in this font."
105 (defcustom apropos-sort-by-scores nil
106 "Non-nil means sort matches by scores; best match is shown first.
107 This applies to all `apropos' commands except `apropos-documentation'.
108 If value is `verbose', the computed score is shown for each match."
110 :type
'(choice (const :tag
"off" nil
)
112 (const :tag
"show scores" verbose
)))
114 (defcustom apropos-documentation-sort-by-scores t
115 "*Non-nil means sort matches by scores; best match is shown first.
116 This applies to `apropos-documentation' only.
117 If value is `verbose', the computed score is shown for each match."
119 :type
'(choice (const :tag
"off" nil
)
121 (const :tag
"show scores" verbose
)))
123 (defvar apropos-mode-map
124 (let ((map (make-sparse-keymap)))
125 (set-keymap-parent map button-buffer-map
)
126 ;; Use `apropos-follow' instead of just using the button
127 ;; definition of RET, so that users can use it anywhere in an
128 ;; apropos item, not just on top of a button.
129 (define-key map
"\C-m" 'apropos-follow
)
130 (define-key map
" " 'scroll-up
)
131 (define-key map
"\177" 'scroll-down
)
132 (define-key map
"q" 'quit-window
)
134 "Keymap used in Apropos mode.")
136 (defvar apropos-mode-hook nil
137 "Hook run when mode is turned on.")
139 (defvar apropos-pattern nil
140 "Apropos pattern as entered by user.")
142 (defvar apropos-pattern-quoted nil
143 "Apropos pattern passed through `regexp-quote'.")
145 (defvar apropos-words
()
146 "Current list of apropos words extracted from `apropos-pattern'.")
148 (defvar apropos-all-words
()
149 "Current list of words and synonyms.")
151 (defvar apropos-regexp nil
152 "Regexp used in current apropos run.")
154 (defvar apropos-all-words-regexp nil
155 "Regexp matching apropos-all-words.")
157 (defvar apropos-files-scanned
()
158 "List of elc files already scanned in current run of `apropos-documentation'.")
160 (defvar apropos-accumulator
()
161 "Alist of symbols already found in current apropos run.")
163 (defvar apropos-item
()
164 "Current item in or for `apropos-accumulator'.")
166 (defvar apropos-synonyms
'(
167 ("find" "open" "edit")
170 ("region" "selection"))
171 "List of synonyms known by apropos.
172 Each element is a list of words where the first word is the standard Emacs
173 term, and the rest of the words are alternative terms.")
176 ;;; Button types used by apropos
178 (define-button-type 'apropos-symbol
179 'face apropos-symbol-face
180 'help-echo
"mouse-2, RET: Display more help on this symbol"
182 'action
#'apropos-symbol-button-display-help
185 (defun apropos-symbol-button-display-help (button)
186 "Display further help for the `apropos-symbol' button BUTTON."
188 (or (apropos-next-label-button (button-start button
))
189 (error "There is nothing to follow for `%s'" (button-label button
)))))
191 (define-button-type 'apropos-function
192 'apropos-label
"Function"
193 'apropos-short-label
"f"
194 'help-echo
"mouse-2, RET: Display more help on this function"
196 'action
(lambda (button)
197 (describe-function (button-get button
'apropos-symbol
))))
199 (define-button-type 'apropos-macro
200 'apropos-label
"Macro"
201 'apropos-short-label
"m"
202 'help-echo
"mouse-2, RET: Display more help on this macro"
204 'action
(lambda (button)
205 (describe-function (button-get button
'apropos-symbol
))))
207 (define-button-type 'apropos-command
208 'apropos-label
"Command"
209 'apropos-short-label
"c"
210 'help-echo
"mouse-2, RET: Display more help on this command"
212 'action
(lambda (button)
213 (describe-function (button-get button
'apropos-symbol
))))
215 ;; We used to use `customize-variable-other-window' instead for a
216 ;; customizable variable, but that is slow. It is better to show an
217 ;; ordinary help buffer and let the user click on the customization
218 ;; button in that buffer, if he wants to.
219 ;; Likewise for `customize-face-other-window'.
220 (define-button-type 'apropos-variable
221 'apropos-label
"Variable"
222 'apropos-short-label
"v"
223 'help-echo
"mouse-2, RET: Display more help on this variable"
225 'action
(lambda (button)
226 (describe-variable (button-get button
'apropos-symbol
))))
228 (define-button-type 'apropos-face
229 'apropos-label
"Face"
230 'apropos-short-label
"F"
231 'help-echo
"mouse-2, RET: Display more help on this face"
233 'action
(lambda (button)
234 (describe-face (button-get button
'apropos-symbol
))))
236 (define-button-type 'apropos-group
237 'apropos-label
"Group"
238 'apropos-short-label
"g"
239 'help-echo
"mouse-2, RET: Display more help on this group"
241 'action
(lambda (button)
242 (customize-group-other-window
243 (button-get button
'apropos-symbol
))))
245 (define-button-type 'apropos-widget
246 'apropos-label
"Widget"
247 'apropos-short-label
"w"
248 'help-echo
"mouse-2, RET: Display more help on this widget"
250 'action
(lambda (button)
251 (widget-browse-other-window (button-get button
'apropos-symbol
))))
253 (define-button-type 'apropos-plist
254 'apropos-label
"Plist"
255 'apropos-short-label
"p"
256 'help-echo
"mouse-2, RET: Display more help on this plist"
258 'action
(lambda (button)
259 (apropos-describe-plist (button-get button
'apropos-symbol
))))
261 (define-button-type 'apropos-library
262 'help-echo
"mouse-2, RET: Display more help on this library"
264 'action
(lambda (button)
265 (apropos-library (button-get button
'apropos-symbol
))))
267 (defun apropos-next-label-button (pos)
268 "Return the next apropos label button after POS, or nil if there's none.
269 Will also return nil if more than one `apropos-symbol' button is encountered
270 before finding a label."
271 (let* ((button (next-button pos t
))
272 (already-hit-symbol nil
)
273 (label (and button
(button-get button
'apropos-label
)))
274 (type (and button
(button-get button
'type
))))
277 (or (not (eq type
'apropos-symbol
))
278 (not already-hit-symbol
)))
279 (when (eq type
'apropos-symbol
)
280 (setq already-hit-symbol t
))
281 (setq button
(next-button (button-start button
)))
283 (setq label
(button-get button
'apropos-label
))
284 (setq type
(button-get button
'type
))))
288 (defun apropos-words-to-regexp (words wild
)
289 "Make regexp matching any two of the words in WORDS."
291 (mapconcat 'identity words
"\\|")
296 (mapconcat 'identity words
"\\|")
301 (defun apropos-read-pattern (subject)
302 "Read an apropos pattern, either a word list or a regexp.
303 Returns the user pattern, either a list of words which are matched
304 literally, or a string which is used as a regexp to search for.
306 SUBJECT is a string that is included in the prompt to identify what
307 kind of objects to search."
309 (read-string (concat "Apropos " subject
" (word list or regexp): "))))
310 (if (string-equal (regexp-quote pattern
) pattern
)
312 (split-string pattern
"[ \t]+")
315 (defun apropos-parse-pattern (pattern)
316 "Rewrite a list of words to a regexp matching all permutations.
317 If PATTERN is a string, that means it is already a regexp.
318 This updates variables `apropos-pattern', `apropos-pattern-quoted',
319 `apropos-regexp', `apropos-words', and `apropos-all-words-regexp'."
320 (setq apropos-words nil
321 apropos-all-words nil
)
323 ;; We don't actually make a regexp matching all permutations.
324 ;; Instead, for e.g. "a b c", we make a regexp matching
325 ;; any combination of two or more words like this:
326 ;; (a|b|c).*(a|b|c) which may give some false matches,
327 ;; but as long as it also gives the right ones, that's ok.
328 (let ((words pattern
))
329 (setq apropos-pattern
(mapconcat 'identity pattern
" ")
330 apropos-pattern-quoted
(regexp-quote apropos-pattern
))
332 (let ((syn apropos-synonyms
) (s word
) (a word
))
334 (if (member word
(car syn
))
336 (setq a
(mapconcat 'identity
(car syn
) "\\|"))
337 (if (member word
(cdr (car syn
)))
340 (setq syn
(cdr syn
))))
341 (setq apropos-words
(cons s apropos-words
)
342 apropos-all-words
(cons a apropos-all-words
))))
343 (setq apropos-all-words-regexp
344 (apropos-words-to-regexp apropos-all-words
".+"))
346 (apropos-words-to-regexp apropos-words
".*?")))
347 (setq apropos-pattern-quoted
(regexp-quote pattern
)
348 apropos-all-words-regexp pattern
349 apropos-pattern pattern
350 apropos-regexp pattern
)))
353 (defun apropos-calc-scores (str words
)
354 "Return apropos scores for string STR matching WORDS.
355 Value is a list of offsets of the words into the string."
358 (dolist (word words scores
)
359 (if (setq i
(string-match word str
))
360 (setq scores
(cons i scores
))))
361 ;; Return list of start and end position of regexp
362 (and (string-match apropos-pattern str
)
363 (list (match-beginning 0) (match-end 0))))))
365 (defun apropos-score-str (str)
366 "Return apropos score for string STR."
368 (let* ((l (length str
))
369 (score (- (/ l
10))))
370 (dolist (s (apropos-calc-scores str apropos-all-words
) score
)
371 (setq score
(+ score
1000 (/ (* (- l s
) 1000) l
)))))
374 (defun apropos-score-doc (doc)
375 "Return apropos score for documentation string DOC."
376 (let ((l (length doc
)))
379 (when (setq i
(string-match apropos-pattern-quoted doc
))
381 (dolist (s (apropos-calc-scores doc apropos-all-words
) score
)
382 (setq score
(+ score
50 (/ (* (- l s
) 50) l
)))))
385 (defun apropos-score-symbol (symbol &optional weight
)
386 "Return apropos score for SYMBOL."
387 (setq symbol
(symbol-name symbol
))
390 (dolist (s (apropos-calc-scores symbol apropos-words
) (* score
(or weight
3)))
391 (setq score
(+ score
(- 60 l
) (/ (* (- l s
) 60) l
))))))
393 (defun apropos-true-hit (str words
)
394 "Return t if STR is a genuine hit.
395 This may fail if only one of the keywords is matched more than once.
396 This requires that at least 2 keywords (unless only one was given)."
400 (> (length (apropos-calc-scores str words
)) 1)))
402 (defun apropos-false-hit-symbol (symbol)
403 "Return t if SYMBOL is not really matched by the current keywords."
404 (not (apropos-true-hit (symbol-name symbol
) apropos-words
)))
406 (defun apropos-false-hit-str (str)
407 "Return t if STR is not really matched by the current keywords."
408 (not (apropos-true-hit str apropos-words
)))
410 (defun apropos-true-hit-doc (doc)
411 "Return t if DOC is really matched by the current keywords."
412 (apropos-true-hit doc apropos-all-words
))
414 (define-derived-mode apropos-mode fundamental-mode
"Apropos"
415 "Major mode for following hyperlinks in output of apropos commands.
417 \\{apropos-mode-map}")
419 (defvar apropos-multi-type t
420 "If non-nil, this apropos query concerns multiple types.
421 This is used to decide whether to print the result's type or not.")
424 (defun apropos-variable (pattern &optional do-all
)
425 "Show user variables that match PATTERN.
426 PATTERN can be a word, a list of words (separated by spaces),
427 or a regexp (using some regexp special characters). If it is a word,
428 search for matches for that word as a substring. If it is a list of words,
429 search for matches for any two (or more) of those words.
431 With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also show
433 (interactive (list (apropos-read-pattern
434 (if (or current-prefix-arg apropos-do-all
)
435 "variable" "user option"))
437 (apropos-command pattern nil
438 (if (or do-all apropos-do-all
)
441 (get symbol
'variable-documentation
)))
444 ;; For auld lang syne:
446 (defalias 'command-apropos
'apropos-command
)
448 (defun apropos-command (pattern &optional do-all var-predicate
)
449 "Show commands (interactively callable functions) that match PATTERN.
450 PATTERN can be a word, a list of words (separated by spaces),
451 or a regexp (using some regexp special characters). If it is a word,
452 search for matches for that word as a substring. If it is a list of words,
453 search for matches for any two (or more) of those words.
455 With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also show
456 noninteractive functions.
458 If VAR-PREDICATE is non-nil, show only variables, and only those that
459 satisfy the predicate VAR-PREDICATE.
461 When called from a Lisp program, a string PATTERN is used as a regexp,
462 while a list of strings is used as a word list."
463 (interactive (list (apropos-read-pattern
464 (if (or current-prefix-arg apropos-do-all
)
465 "command or function" "command"))
467 (apropos-parse-pattern pattern
)
469 (let ((standard-output (get-buffer-create "*Apropos*")))
470 (print-help-return-message 'identity
))))
471 (or do-all
(setq do-all apropos-do-all
))
472 (setq apropos-accumulator
473 (apropos-internal apropos-regexp
475 ;; We used to use `functionp' here, but this
476 ;; rules out macros. `fboundp' rules in
477 ;; keymaps, but it seems harmless.
478 (if do-all
'fboundp
'commandp
))))
479 (let ((tem apropos-accumulator
))
481 (if (or (get (car tem
) 'apropos-inhibit
)
482 (apropos-false-hit-symbol (car tem
)))
483 (setq apropos-accumulator
(delq (car tem
) apropos-accumulator
)))
484 (setq tem
(cdr tem
))))
485 (let ((p apropos-accumulator
)
489 (setq symbol
(car p
))
490 (setq score
(apropos-score-symbol symbol
))
491 (unless var-predicate
493 (if (setq doc
(documentation symbol t
))
495 (setq score
(+ score
(apropos-score-doc doc
)))
496 (substring doc
0 (string-match "\n" doc
)))
497 "(not documented)")))
499 (funcall var-predicate symbol
)
500 (if (setq doc
(documentation-property
501 symbol
'variable-documentation t
))
503 (setq score
(+ score
(apropos-score-doc doc
)))
505 (string-match "\n" doc
)))))))
506 (setcar (cdr (car p
)) score
)
508 (and (let ((apropos-multi-type do-all
))
509 (apropos-print t nil nil t
))
511 (message "%s" message
))))
515 (defun apropos-documentation-property (symbol property raw
)
516 "Like (documentation-property SYMBOL PROPERTY RAW) but handle errors."
518 (let ((doc (documentation-property symbol property raw
)))
519 (if doc
(substring doc
0 (string-match "\n" doc
))
521 (error "(error retrieving documentation)")))
525 (defun apropos (pattern &optional do-all
)
526 "Show all meaningful Lisp symbols whose names match PATTERN.
527 Symbols are shown if they are defined as functions, variables, or
528 faces, or if they have nonempty property lists.
530 PATTERN can be a word, a list of words (separated by spaces),
531 or a regexp (using some regexp special characters). If it is a word,
532 search for matches for that word as a substring. If it is a list of words,
533 search for matches for any two (or more) of those words.
535 With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil,
536 consider all symbols (if they match PATTERN).
538 Returns list of symbols and documentation found."
539 (interactive (list (apropos-read-pattern "symbol")
541 (apropos-parse-pattern pattern
)
542 (apropos-symbols-internal
543 (apropos-internal apropos-regexp
550 (symbol-plist symbol
)))))
551 (or do-all apropos-do-all
)))
553 (defun apropos-library-button (sym)
556 (let ((name (copy-sequence (symbol-name sym
))))
557 (make-text-button name nil
558 'type
'apropos-library
559 'face apropos-symbol-face
560 'apropos-symbol name
)
564 (defun apropos-library (file)
565 "List the variables and functions defined by library FILE.
566 FILE should be one of the libraries currently loaded and should
567 thus be found in `load-history'."
573 (setq l
(file-name-nondirectory l
))
575 (not (equal (setq l
(file-name-sans-extension l
))
578 (mapcar 'car load-history
)))
579 (mapcar 'car load-history
))))
580 (list (completing-read "Describe library: " libs nil t
))))
585 (lh-entry (assoc file load-history
)))
587 ;; `file' may be the "shortname".
588 (let ((lh load-history
)
589 (re (concat "\\(?:\\`\\|[\\/]\\)" (regexp-quote file
)
591 (while (and lh
(null lh-entry
))
592 (if (string-match re
(caar lh
))
593 (setq lh-entry
(car lh
))
594 (setq lh
(cdr lh
)))))
595 (unless lh-entry
(error "Unknown library `%s'" file
)))
596 (dolist (x (cdr lh-entry
))
598 ;; (autoload (push (cdr x) autoloads))
599 (require (push (cdr x
) requires
))
600 (provide (push (cdr x
) provides
))
601 (t (push (or (cdr-safe x
) x
) symbols
))))
602 (let ((apropos-pattern "")) ;Dummy binding for apropos-symbols-internal.
603 (apropos-symbols-internal
604 symbols apropos-do-all
606 (format "Library `%s' provides: %s\nand requires: %s"
608 (mapconcat 'apropos-library-button
609 (or provides
'(nil)) " and ")
610 (mapconcat 'apropos-library-button
611 (or requires
'(nil)) " and ")))))))
613 (defun apropos-symbols-internal (symbols keys
&optional text
)
614 ;; Filter out entries that are marked as apropos-inhibit.
616 (dolist (symbol symbols
)
617 (unless (get symbol
'apropos-inhibit
)
620 (let ((apropos-accumulator
623 (let (doc properties
)
626 (apropos-score-symbol symbol
)
627 (when (fboundp symbol
)
628 (if (setq doc
(condition-case nil
629 (documentation symbol t
)
631 "(alias for undefined function)")
633 "(can't retrieve function documentation)")))
634 (substring doc
0 (string-match "\n" doc
))
636 (when (boundp symbol
)
637 (apropos-documentation-property
638 symbol
'variable-documentation t
))
639 (when (setq properties
(symbol-plist symbol
))
640 (setq doc
(list (car properties
)))
641 (while (setq properties
(cdr (cdr properties
)))
642 (setq doc
(cons (car properties
) doc
)))
643 (mapconcat #'symbol-name
(nreverse doc
) " "))
644 (when (get symbol
'widget-type
)
645 (apropos-documentation-property
646 symbol
'widget-documentation t
))
648 (apropos-documentation-property
649 symbol
'face-documentation t
))
650 (when (get symbol
'custom-group
)
651 (apropos-documentation-property
652 symbol
'group-documentation t
)))))
654 (apropos-print keys nil text
)))
658 (defun apropos-value (pattern &optional do-all
)
659 "Show all symbols whose value's printed representation matches PATTERN.
660 PATTERN can be a word, a list of words (separated by spaces),
661 or a regexp (using some regexp special characters). If it is a word,
662 search for matches for that word as a substring. If it is a list of words,
663 search for matches for any two (or more) of those words.
665 With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also looks
666 at the function and at the names and values of properties.
667 Returns list of symbols and values found."
668 (interactive (list (apropos-read-pattern "value")
670 (apropos-parse-pattern pattern
)
671 (or do-all
(setq do-all apropos-do-all
))
672 (setq apropos-accumulator
())
676 (setq f nil v nil p nil
)
677 (or (memq symbol
'(apropos-regexp
678 apropos-pattern apropos-all-words-regexp
679 apropos-words apropos-all-words
680 do-all apropos-accumulator
682 (setq v
(apropos-value-internal 'boundp symbol
'symbol-value
)))
684 (setq f
(apropos-value-internal 'fboundp symbol
'symbol-function
)
685 p
(apropos-format-plist symbol
"\n " t
)))
686 (if (apropos-false-hit-str v
)
688 (if (apropos-false-hit-str f
)
690 (if (apropos-false-hit-str p
)
693 (setq apropos-accumulator
(cons (list symbol
694 (+ (apropos-score-str f
)
695 (apropos-score-str v
)
696 (apropos-score-str p
))
698 apropos-accumulator
))))))
699 (let ((apropos-multi-type do-all
))
700 (apropos-print nil
"\n----------------\n")))
704 (defun apropos-documentation (pattern &optional do-all
)
705 "Show symbols whose documentation contains matches for PATTERN.
706 PATTERN can be a word, a list of words (separated by spaces),
707 or a regexp (using some regexp special characters). If it is a word,
708 search for matches for that word as a substring. If it is a list of words,
709 search for matches for any two (or more) of those words.
711 With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also use
712 documentation that is not stored in the documentation file and show key
714 Returns list of symbols and documentation found."
715 (interactive (list (apropos-read-pattern "documentation")
717 (apropos-parse-pattern pattern
)
718 (or do-all
(setq do-all apropos-do-all
))
719 (setq apropos-accumulator
() apropos-files-scanned
())
720 (let ((standard-input (get-buffer-create " apropos-temp"))
721 (apropos-sort-by-scores apropos-documentation-sort-by-scores
)
725 (set-buffer standard-input
)
726 (apropos-documentation-check-doc-file)
730 (setq f
(apropos-safe-documentation symbol
)
731 v
(get symbol
'variable-documentation
))
732 (if (integerp v
) (setq v
))
733 (setq f
(apropos-documentation-internal f
)
734 v
(apropos-documentation-internal v
))
735 (setq sf
(apropos-score-doc f
)
736 sv
(apropos-score-doc v
))
738 (if (setq apropos-item
739 (cdr (assq symbol apropos-accumulator
)))
743 (setcar (nthcdr 1 apropos-item
) f
)
744 (setcar apropos-item
(+ (car apropos-item
) sf
))))
747 (setcar (nthcdr 2 apropos-item
) v
)
748 (setcar apropos-item
(+ (car apropos-item
) sv
)))))
749 (setq apropos-accumulator
751 (+ (apropos-score-symbol symbol
2) sf sv
)
753 apropos-accumulator
)))))))
754 (apropos-print nil
"\n----------------\n" nil t
))
755 (kill-buffer standard-input
))))
758 (defun apropos-value-internal (predicate symbol function
)
759 (if (funcall predicate symbol
)
761 (setq symbol
(prin1-to-string (funcall function symbol
)))
762 (if (string-match apropos-regexp symbol
)
764 (if apropos-match-face
765 (put-text-property (match-beginning 0) (match-end 0)
766 'face apropos-match-face
770 (defun apropos-documentation-internal (doc)
772 (apropos-documentation-check-elc-file (car doc
))
774 (string-match apropos-all-words-regexp doc
)
775 (apropos-true-hit-doc doc
))
776 (when apropos-match-face
777 (setq doc
(substitute-command-keys (copy-sequence doc
)))
778 (if (or (string-match apropos-pattern-quoted doc
)
779 (string-match apropos-all-words-regexp doc
))
780 (put-text-property (match-beginning 0)
782 'face apropos-match-face doc
))
785 (defun apropos-format-plist (pl sep
&optional compare
)
786 (setq pl
(symbol-plist pl
))
789 (setq p
(format "%s %S" (car pl
) (nth 1 pl
)))
790 (if (or (not compare
) (string-match apropos-regexp p
))
791 (if apropos-property-face
792 (put-text-property 0 (length (symbol-name (car pl
)))
793 'face apropos-property-face p
))
797 (and compare apropos-match-face
798 (put-text-property (match-beginning 0) (match-end 0)
799 'face apropos-match-face
801 (setq p-out
(concat p-out
(if p-out sep
) p
))))
802 (setq pl
(nthcdr 2 pl
)))
806 ;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
808 (defun apropos-documentation-check-doc-file ()
809 (let (type symbol
(sepa 2) sepb
)
812 (insert-file-contents (concat doc-directory internal-doc-file-name
))
814 (while (save-excursion
815 (setq sepb
(search-forward "\^_"))
817 (beginning-of-line 2)
818 (if (save-restriction
819 (narrow-to-region (point) (1- sepb
))
820 (re-search-forward apropos-all-words-regexp nil t
))
822 (goto-char (1+ sepa
))
823 (setq type
(if (eq ?F
(preceding-char))
824 2 ; function documentation
825 3) ; variable documentation
827 doc
(buffer-substring (1+ (point)) (1- sepb
)))
828 (when (apropos-true-hit-doc doc
)
829 (or (and (setq apropos-item
(assq symbol apropos-accumulator
))
830 (setcar (cdr apropos-item
)
831 (apropos-score-doc doc
)))
832 (setq apropos-item
(list symbol
833 (+ (apropos-score-symbol symbol
2)
834 (apropos-score-doc doc
))
836 apropos-accumulator
(cons apropos-item
837 apropos-accumulator
)))
838 (when apropos-match-face
839 (setq doc
(substitute-command-keys doc
))
840 (if (or (string-match apropos-pattern-quoted doc
)
841 (string-match apropos-all-words-regexp doc
))
842 (put-text-property (match-beginning 0)
844 'face apropos-match-face doc
)))
845 (setcar (nthcdr type apropos-item
) doc
))))
846 (setq sepa
(goto-char sepb
)))))
848 (defun apropos-documentation-check-elc-file (file)
849 (if (member file apropos-files-scanned
)
851 (let (symbol doc beg end this-is-a-variable
)
852 (setq apropos-files-scanned
(cons file apropos-files-scanned
))
854 (insert-file-contents file
)
855 (while (search-forward "\n#@" nil t
)
856 ;; Read the comment length, and advance over it.
859 end
(+ (point) end -
1))
861 (if (save-restriction
862 ;; match ^ and $ relative to doc string
863 (narrow-to-region beg end
)
864 (re-search-forward apropos-all-words-regexp nil t
))
866 (goto-char (+ end
2))
867 (setq doc
(buffer-substring beg end
)
868 end
(- (match-end 0) beg
)
869 beg
(- (match-beginning 0) beg
))
870 (when (apropos-true-hit-doc doc
)
871 (setq this-is-a-variable
(looking-at "(def\\(var\\|const\\) ")
873 (skip-chars-forward "(a-z")
876 symbol
(if (consp symbol
)
879 (if (if this-is-a-variable
880 (get symbol
'variable-documentation
)
881 (and (fboundp symbol
) (apropos-safe-documentation symbol
)))
883 (or (and (setq apropos-item
(assq symbol apropos-accumulator
))
884 (setcar (cdr apropos-item
)
885 (+ (cadr apropos-item
) (apropos-score-doc doc
))))
886 (setq apropos-item
(list symbol
887 (+ (apropos-score-symbol symbol
2)
888 (apropos-score-doc doc
))
890 apropos-accumulator
(cons apropos-item
891 apropos-accumulator
)))
892 (when apropos-match-face
893 (setq doc
(substitute-command-keys doc
))
894 (if (or (string-match apropos-pattern-quoted doc
)
895 (string-match apropos-all-words-regexp doc
))
896 (put-text-property (match-beginning 0)
898 'face apropos-match-face doc
)))
899 (setcar (nthcdr (if this-is-a-variable
3 2)
905 (defun apropos-safe-documentation (function)
906 "Like `documentation', except it avoids calling `get_doc_string'.
907 Will return nil instead."
908 (while (and function
(symbolp function
))
909 (setq function
(if (fboundp function
)
910 (symbol-function function
))))
911 (if (eq (car-safe function
) 'macro
)
912 (setq function
(cdr function
)))
913 (setq function
(if (byte-code-function-p function
)
914 (if (> (length function
) 4)
916 (if (eq (car-safe function
) 'autoload
)
918 (if (eq (car-safe function
) 'lambda
)
919 (if (stringp (nth 2 function
))
921 (if (stringp (nth 3 function
))
922 (nth 3 function
)))))))
923 (if (integerp function
)
927 (defcustom apropos-compact-layout nil
928 "If non-nil, use a single line per binding."
931 (defun apropos-print (do-keys spacing
&optional text nosubst
)
932 "Output result of apropos searching into buffer `*Apropos*'.
933 The value of `apropos-accumulator' is the list of items to output.
934 Each element should have the format
935 (SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
936 The return value is the list that was in `apropos-accumulator', sorted
937 alphabetically by symbol name; but this function also sets
938 `apropos-accumulator' to nil before returning.
940 If SPACING is non-nil, it should be a string; separate items with that string.
941 If non-nil TEXT is a string that will be printed as a heading."
942 (if (null apropos-accumulator
)
943 (message "No apropos matches for `%s'" apropos-pattern
)
944 (setq apropos-accumulator
945 (sort apropos-accumulator
947 ;; Don't sort by score if user can't see the score.
948 ;; It would be confusing. -- rms.
949 (if apropos-sort-by-scores
950 (or (> (cadr a
) (cadr b
))
951 (and (= (cadr a
) (cadr b
))
952 (string-lessp (car a
) (car b
))))
953 (string-lessp (car a
) (car b
))))))
954 (with-output-to-temp-buffer "*Apropos*"
955 (let ((p apropos-accumulator
)
956 (old-buffer (current-buffer))
958 (set-buffer standard-output
)
960 (if (display-mouse-p)
962 "If moving the mouse over text changes the text's color, "
964 "mouse-2 (second button from right) on that text to "
965 "get more information.\n"))
966 (insert "In this buffer, go to the name of the command, or function,"
968 (substitute-command-keys
969 "and type \\[apropos-follow] to get full documentation.\n\n"))
970 (if text
(insert text
"\n\n"))
971 (dolist (apropos-item p
)
972 (when (and spacing
(not (bobp)))
974 (setq symbol
(car apropos-item
))
975 ;; Insert dummy score element for backwards compatibility with 21.x
976 ;; apropos-item format.
977 (if (not (numberp (cadr apropos-item
)))
979 (cons (car apropos-item
)
980 (cons nil
(cdr apropos-item
)))))
981 (insert-text-button (symbol-name symbol
)
982 'type
'apropos-symbol
983 ;; Can't use default, since user may have
984 ;; changed the variable!
985 ;; Just say `no' to variables containing faces!
986 'face apropos-symbol-face
)
987 (if (and (eq apropos-sort-by-scores
'verbose
)
989 (insert " (" (number-to-string (cadr apropos-item
)) ") "))
990 ;; Calculate key-bindings if we want them.
991 (unless apropos-compact-layout
994 (not (eq symbol
'self-insert-command
))
997 (with-current-buffer old-buffer
998 (where-is-internal symbol
)))
1000 ;; Copy over the list of key sequences,
1001 ;; omitting any that contain a buffer or a frame.
1002 ;; FIXME: Why omit keys that contain buffers and
1003 ;; frames? This looks like a bad workaround rather
1004 ;; than a proper fix. Does anybod know what problem
1005 ;; this is trying to address? --Stef
1009 (while (< i
(length key
))
1010 (if (or (framep (aref key i
))
1011 (bufferp (aref key i
)))
1015 (push key filtered
))))
1016 (setq item filtered
))
1017 ;; Convert the remaining keys to a string and insert.
1021 (setq key
(condition-case ()
1022 (key-description key
)
1024 (if apropos-keybinding-face
1025 (put-text-property 0 (length key
)
1026 'face apropos-keybinding-face
1030 (insert "M-x ... RET")
1031 (when apropos-keybinding-face
1032 (put-text-property (- (point) 11) (- (point) 8)
1033 'face apropos-keybinding-face
)
1034 (put-text-property (- (point) 3) (point)
1035 'face apropos-keybinding-face
))))
1037 (apropos-print-doc 2
1038 (if (commandp symbol
)
1040 (if (apropos-macrop symbol
)
1044 (apropos-print-doc 3 'apropos-variable
(not nosubst
))
1045 (apropos-print-doc 7 'apropos-group t
)
1046 (apropos-print-doc 6 'apropos-face t
)
1047 (apropos-print-doc 5 'apropos-widget t
)
1048 (apropos-print-doc 4 'apropos-plist nil
))
1049 (set (make-local-variable 'truncate-partial-width-windows
) t
)
1050 (set (make-local-variable 'truncate-lines
) t
)
1051 (setq buffer-read-only t
))))
1052 (prog1 apropos-accumulator
1053 (setq apropos-accumulator
()))) ; permit gc
1055 (defun apropos-macrop (symbol)
1056 "Return t if SYMBOL is a Lisp macro."
1057 (and (fboundp symbol
)
1059 (symbol-function symbol
)))
1060 (or (eq (car symbol
) 'macro
)
1061 (if (eq (car symbol
) 'autoload
)
1062 (memq (nth 4 symbol
)
1066 (defun apropos-print-doc (i type do-keys
)
1067 (when (stringp (setq i
(nth i apropos-item
)))
1068 (if apropos-compact-layout
1069 (insert (propertize "\t" 'display
'(space :align-to
32)) " ")
1071 ;; If the query is only for a single type, there's
1072 ;; no point writing it over and over again.
1073 (when apropos-multi-type
1075 (if apropos-compact-layout
1076 (button-type-get type
'apropos-label
)
1077 (format "<%s>" (button-type-get type
'apropos-short-label
)))
1079 ;; Can't use the default button face, since user may have changed the
1080 ;; variable! Just say `no' to variables containing faces!
1081 'face apropos-label-face
1082 'apropos-symbol
(car apropos-item
))
1083 (insert (if apropos-compact-layout
" " ": ")))
1084 (insert (if do-keys
(substitute-command-keys i
) i
))
1085 (or (bolp) (terpri))))
1087 (defun apropos-follow ()
1088 "Invokes any button at point, otherwise invokes the nearest label button."
1091 (or (apropos-next-label-button (line-beginning-position))
1092 (error "There is nothing to follow here"))))
1095 (defun apropos-describe-plist (symbol)
1096 "Display a pretty listing of SYMBOL's plist."
1097 (help-setup-xref (list 'apropos-describe-plist symbol
) (interactive-p))
1098 (with-help-window (help-buffer)
1099 (set-buffer standard-output
)
1102 (princ "'s plist is\n (")
1103 (if apropos-symbol-face
1104 (put-text-property (+ (point-min) 7) (- (point) 14)
1105 'face apropos-symbol-face
))
1106 (insert (apropos-format-plist symbol
"\n "))
1112 ;; arch-tag: d56fa2ac-e56b-4ce3-84ff-852f9c0dc66e
1113 ;;; apropos.el ends here