;;; apropos.el --- apropos commands for users and programmers
-;; Copyright (C) 1989, 1994, 1995, 2001, 2002 Free Software Foundation, Inc.
+;; Copyright (C) 1989,94,1995,2001,02,03,2004 Free Software Foundation, Inc.
;; Author: Joe Wells <jbw@bigbird.bu.edu>
;; Rewritten: Daniel Pfeiffer <occitan@esperanto.org>
;;; Code:
(require 'button)
+(eval-when-compile (require 'cl))
(defgroup apropos nil
"Apropos commands for users and programmers"
:group 'apropos
:type 'face)
+(defcustom apropos-sort-by-scores nil
+ "*Non-nil means sort matches by scores; best match is shown first.
+The computed score is shown for each match."
+ :group 'apropos
+ :type 'boolean)
(defvar apropos-mode-map
(let ((map (make-sparse-keymap)))
(defvar apropos-mode-hook nil
"*Hook run when mode is turned on.")
-(defvar apropos-show-scores nil
- "*Show apropos scores if non-nil.")
-
(defvar apropos-regexp nil
"Regexp used in current apropos run.")
"Make regexp matching any two of the words in WORDS."
(concat "\\("
(mapconcat 'identity words "\\|")
- "\\)" wild
- (if (cdr words)
- (concat "\\("
+ "\\)"
+ (if (cdr words)
+ (concat wild
+ "\\("
(mapconcat 'identity words "\\|")
"\\)")
"")))
(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))
"Return t if DOC is really matched by the current keywords."
(apropos-true-hit doc apropos-all-words))
-;;;###autoload
(define-derived-mode apropos-mode fundamental-mode "Apropos"
"Major mode for following hyperlinks in output of apropos commands.
(if (functionp symbol)
(if (setq doc (documentation symbol t))
(progn
- (setq score (+ score (apropos-score-doc doc)))
+ (setq score (+ score (apropos-score-doc doc)))
(substring doc 0 (string-match "\n" doc)))
"(not documented)")))
(and var-predicate
"(not documented)"))
(error "(error retrieving documentation)")))
+
+;;;###autoload
(defun apropos (apropos-regexp &optional do-all)
"Show all bound symbols whose names match APROPOS-REGEXP.
With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also
time-consuming. Returns list of symbols and documentation found."
(interactive "sApropos symbol (regexp or words): \nP")
(setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
- (setq apropos-accumulator
- (apropos-internal apropos-regexp
+ (apropos-symbols-internal
+ (apropos-internal apropos-regexp
(and (not do-all)
(not apropos-do-all)
(lambda (symbol)
(or (fboundp symbol)
(boundp symbol)
(facep symbol)
- (symbol-plist symbol))))))
- (let ((tem apropos-accumulator))
- (while tem
- (if (get (car tem) 'apropos-inhibit)
- (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
- (setq tem (cdr tem))))
- (let ((p apropos-accumulator)
- symbol doc properties)
- (while p
- (setcar p (list
- (setq symbol (car p))
- 0
- (when (fboundp symbol)
- (if (setq doc (condition-case nil
- (documentation symbol t)
- (void-function
- "(alias for undefined function)")
- (error
- "(error retrieving function documentation")))
- (substring doc 0 (string-match "\n" doc))
- "(not documented)"))
- (when (boundp symbol)
- (apropos-documentation-property
+ (symbol-plist symbol)))))
+ (or do-all apropos-do-all)))
+
+(defun apropos-symbols-internal (symbols keys &optional text)
+ ;; Filter out entries that are marked as apropos-inhibit.
+ (let ((all nil))
+ (dolist (symbol symbols)
+ (unless (get symbol 'apropos-inhibit)
+ (push symbol all)))
+ (setq symbols all))
+ (let ((apropos-accumulator
+ (mapcar
+ (lambda (symbol)
+ (let (doc properties)
+ (list
+ symbol
+ (apropos-score-symbol symbol)
+ (when (fboundp symbol)
+ (if (setq doc (condition-case nil
+ (documentation symbol t)
+ (void-function
+ "(alias for undefined function)")
+ (error
+ "(can't retrieve function documentation)")))
+ (substring doc 0 (string-match "\n" doc))
+ "(not documented)"))
+ (when (boundp symbol)
+ (apropos-documentation-property
symbol 'variable-documentation t))
(when (setq properties (symbol-plist symbol))
(setq doc (list (car properties)))
(when (get symbol 'widget-type)
(apropos-documentation-property
symbol 'widget-documentation t))
- (when (facep symbol)
- (apropos-documentation-property
- symbol 'face-documentation t))
- (when (get symbol 'custom-group)
+ (when (facep symbol)
+ (apropos-documentation-property
+ symbol 'face-documentation t))
+ (when (get symbol 'custom-group)
(apropos-documentation-property
- symbol 'group-documentation t))))
- (setq p (cdr p))))
- (apropos-print
- (or do-all apropos-do-all)
- nil))
+ symbol 'group-documentation t)))))
+ symbols)))
+ (apropos-print keys nil text)))
;;;###autoload
(if (apropos-false-hit-str p)
(setq p nil))
(if (or f v p)
- (setq apropos-accumulator (cons (list symbol
+ (setq apropos-accumulator (cons (list symbol
(+ (apropos-score-str f)
(apropos-score-str v)
(apropos-score-str p))
(setcar (nthcdr 2 apropos-item) v)
(setcar apropos-item (+ (car apropos-item) sv)))))
(setq apropos-accumulator
- (cons (list symbol
+ (cons (list symbol
(+ (apropos-score-symbol symbol 2) sf sv)
f v)
apropos-accumulator)))))))
(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
+ (setq apropos-item (list symbol
(+ (apropos-score-symbol symbol 2)
(apropos-score-doc doc))
nil nil)
function))
-(defun apropos-print (do-keys spacing)
+(defun apropos-print (do-keys spacing &optional text)
"Output result of apropos searching into buffer `*Apropos*'.
The value of `apropos-accumulator' is the list of items to output.
-Each element should have the format
+Each element should have the format
(SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
The return value is the list that was in `apropos-accumulator', sorted
alphabetically by symbol name; but this function also sets
`apropos-accumulator' to nil before returning.
-If SPACING is non-nil, it should be a string;
-separate items with that string."
+If SPACING is non-nil, it should be a string; separate items with that string.
+If non-nil TEXT is a string that will be printed as a heading."
(if (null apropos-accumulator)
(message "No apropos matches for `%s'" apropos-orig-regexp)
(setq apropos-accumulator
- (sort apropos-accumulator (lambda (a b)
- (or (> (cadr a) (cadr b))
- (and (= (cadr a) (cadr b))
- (string-lessp (car a) (car b)))))))
+ (sort apropos-accumulator
+ (lambda (a b)
+ ;; Don't sort by score if user can't see the score.
+ ;; It would be confusing. -- rms.
+ (if apropos-sort-by-scores
+ (or (> (cadr a) (cadr b))
+ (and (= (cadr a) (cadr b))
+ (string-lessp (car a) (car b))))
+ (string-lessp (car a) (car b))))))
(with-output-to-temp-buffer "*Apropos*"
(let ((p apropos-accumulator)
(old-buffer (current-buffer))
" or variable,\n"
(substitute-command-keys
"and type \\[apropos-follow] to get full documentation.\n\n"))
+ (if text (insert text "\n\n"))
(while (consp p)
(when (and spacing (not (bobp)))
(princ spacing))
;; changed the variable!
;; Just say `no' to variables containing faces!
'face apropos-symbol-face)
- (if apropos-show-scores
+ (if apropos-sort-by-scores
(insert " (" (number-to-string (cadr apropos-item)) ") "))
;; Calculate key-bindings if we want them.
(and do-keys
(defun apropos-macrop (symbol)
- "T if SYMBOL is a Lisp macro."
+ "Return t if SYMBOL is a Lisp macro."
(and (fboundp symbol)
(consp (setq symbol
(symbol-function symbol)))
(defun apropos-describe-plist (symbol)
"Display a pretty listing of SYMBOL's plist."
- (with-output-to-temp-buffer "*Help*"
+ (help-setup-xref (list 'apropos-describe-plist symbol) (interactive-p))
+ (with-output-to-temp-buffer (help-buffer)
(set-buffer standard-output)
(princ "Symbol ")
(prin1 symbol)
(princ "'s plist is\n (")
(if apropos-symbol-face
- (put-text-property 8 (- (point) 14) 'face apropos-symbol-face))
+ (put-text-property (+ (point-min) 7) (- (point) 14)
+ 'face apropos-symbol-face))
(insert (apropos-format-plist symbol "\n "))
(princ ")")
(print-help-return-message)))
(provide 'apropos)
+;;; arch-tag: d56fa2ac-e56b-4ce3-84ff-852f9c0dc66e
;;; apropos.el ends here
HCoop / bpt / emacs.git / blobdiff