;;; apropos.el --- apropos commands for users and programmers
-;; Copyright (C) 1989, 1994, 1995, 2001, 2002 Free Software Foundation, Inc.
+;; Copyright (C) 1989, 1994, 1995, 2001, 2002, 2003, 2004,
+;; 2005 Free Software Foundation, Inc.
;; Author: Joe Wells <jbw@bigbird.bu.edu>
;; Rewritten: Daniel Pfeiffer <occitan@esperanto.org>
;; You should have received a copy of the GNU General Public License
;; 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;;; Code:
(require 'button)
+(eval-when-compile (require 'cl))
(defgroup apropos nil
- "Apropos commands for users and programmers"
+ "Apropos commands for users and programmers."
:group 'help
:prefix "apropos")
:group 'apropos
:type 'face)
-(defcustom apropos-match-face 'secondary-selection
+(defcustom apropos-match-face 'match
"*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."
: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.")
(define-button-type 'apropos-symbol
'face apropos-symbol-face
'help-echo "mouse-2, RET: Display more help on this symbol"
+ 'follow-link t
'action #'apropos-symbol-button-display-help
'skip t)
(define-button-type 'apropos-function
'apropos-label "Function"
+ 'help-echo "mouse-2, RET: Display more help on this function"
+ 'follow-link t
'action (lambda (button)
- (describe-function (button-get button 'apropos-symbol)))
- 'help-echo "mouse-2, RET: Display more help on this function")
+ (describe-function (button-get button 'apropos-symbol))))
+
(define-button-type 'apropos-macro
'apropos-label "Macro"
+ 'help-echo "mouse-2, RET: Display more help on this macro"
+ 'follow-link t
'action (lambda (button)
- (describe-function (button-get button 'apropos-symbol)))
- 'help-echo "mouse-2, RET: Display more help on this macro")
+ (describe-function (button-get button 'apropos-symbol))))
+
(define-button-type 'apropos-command
'apropos-label "Command"
+ 'help-echo "mouse-2, RET: Display more help on this command"
+ 'follow-link t
'action (lambda (button)
- (describe-function (button-get button 'apropos-symbol)))
- 'help-echo "mouse-2, RET: Display more help on this command")
+ (describe-function (button-get button 'apropos-symbol))))
;; We used to use `customize-variable-other-window' instead for a
;; customizable variable, but that is slow. It is better to show an
(define-button-type 'apropos-variable
'apropos-label "Variable"
'help-echo "mouse-2, RET: Display more help on this variable"
+ 'follow-link t
'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"
+ 'follow-link t
'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"
+ 'follow-link t
'action (lambda (button)
- (customize-variable-other-window
+ (customize-group-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"
+ 'follow-link t
'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"
+ 'follow-link t
'action (lambda (button)
(apropos-describe-plist (button-get button 'apropos-symbol))))
"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 "\\|")
"\\)")
"")))
(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))
-
+ (let ((l (length doc)))
+ (if (> l 0)
+ (let ((score 0)
+ i)
+ (dolist (s (apropos-calc-scores doc apropos-all-words) score)
+ (setq score (+ score 50 (/ (* (- l s) 50) l)))))
+ 0)))
+
(defun apropos-score-symbol (symbol &optional weight)
"Return apropos score for SYMBOL."
(setq symbol (symbol-name symbol))
(dolist (s (apropos-calc-scores symbol apropos-words) (* score (or weight 3)))
(setq score (+ score (- 60 l) (/ (* (- l s) 60) l))))))
-;;;###autoload
+(defun apropos-true-hit (str words)
+ "Return t if STR is a genuine hit.
+This may fail if only one of the keywords is matched more than once.
+This requires that at least 2 keywords (unless only one was given)."
+ (or (not str)
+ (not words)
+ (not (cdr words))
+ (> (length (apropos-calc-scores str words)) 1)))
+
+(defun apropos-false-hit-symbol (symbol)
+ "Return t if SYMBOL is not really matched by the current keywords."
+ (not (apropos-true-hit (symbol-name symbol) apropos-words)))
+
+(defun apropos-false-hit-str (str)
+ "Return t if STR is not really matched by the current keywords."
+ (not (apropos-true-hit str apropos-words)))
+
+(defun apropos-true-hit-doc (doc)
+ "Return t if DOC is really matched by the current keywords."
+ (apropos-true-hit doc apropos-all-words))
+
(define-derived-mode apropos-mode fundamental-mode "Apropos"
"Major mode for following hyperlinks in output of apropos commands.
;; For auld lang syne:
;;;###autoload
-(fset 'command-apropos 'apropos-command)
+(defalias 'command-apropos 'apropos-command)
;;;###autoload
(defun apropos-command (apropos-regexp &optional do-all var-predicate)
"Show commands (interactively callable functions) that match APROPOS-REGEXP.
(if do-all 'functionp 'commandp))))
(let ((tem apropos-accumulator))
(while tem
- (if (get (car tem) 'apropos-inhibit)
+ (if (or (get (car tem) 'apropos-inhibit)
+ (apropos-false-hit-symbol (car tem)))
(setq apropos-accumulator (delq (car tem) apropos-accumulator)))
(setq tem (cdr tem))))
(let ((p apropos-accumulator)
(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
(message message))))
+;;;###autoload
+(defun apropos-documentation-property (symbol property raw)
+ "Like (documentation-property SYMBOL PROPERTY RAW) but handle errors."
+ (condition-case ()
+ (let ((doc (documentation-property symbol property raw)))
+ (if doc (substring doc 0 (string-match "\n" doc))
+ "(not documented)"))
+ (error "(error retrieving documentation)")))
+
+
;;;###autoload
(defun apropos (apropos-regexp &optional do-all)
"Show all bound symbols whose names match APROPOS-REGEXP.
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)")))
- (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)"))
+ (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)))
(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))))
- (apropos-print
- (or do-all apropos-do-all)
- nil))
+ (apropos-documentation-property
+ symbol 'widget-documentation t))
+ (when (facep symbol)
+ (apropos-documentation-property
+ symbol 'face-documentation t))
+ (when (get symbol 'custom-group)
+ (apropos-documentation-property
+ symbol 'group-documentation t)))))
+ symbols)))
+ (apropos-print keys nil text)))
;;;###autoload
(if do-all
(setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
p (apropos-format-plist symbol "\n " t)))
+ (if (apropos-false-hit-str v)
+ (setq v nil))
+ (if (apropos-false-hit-str f)
+ (setq f nil))
+ (if (apropos-false-hit-str p)
+ (setq p nil))
(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)))))))
(apropos-documentation-check-elc-file (car doc))
(and doc
(string-match apropos-all-regexp doc)
+ (save-match-data (apropos-true-hit-doc doc))
(progn
(if apropos-match-face
(put-text-property (match-beginning 0)
(setq beg (match-beginning 0)
end (point))
(goto-char (1+ sepa))
- (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)
- 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 type (if (eq ?F (preceding-char))
+ 2 ; function documentation
+ 3) ; variable documentation
+ symbol (read)
+ beg (- beg (point) 1)
+ end (- end (point) 1)
+ doc (buffer-substring (1+ (point)) (1- sepb)))
+ (when (apropos-true-hit-doc doc)
+ (or (and (setq apropos-item (assq symbol apropos-accumulator))
+ (setcar (cdr apropos-item)
+ (+ (cadr apropos-item) (apropos-score-doc doc))))
+ (setq apropos-item (list symbol
+ (+ (apropos-score-symbol symbol 2)
+ (apropos-score-doc doc))
+ nil nil)
+ apropos-accumulator (cons apropos-item
+ apropos-accumulator)))
+ (if apropos-match-face
+ (put-text-property beg end 'face apropos-match-face doc))
+ (setcar (nthcdr type apropos-item) doc))))
(setq sepa (goto-char sepb)))))
(defun apropos-documentation-check-elc-file (file)
(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\\) ")
- symbol (progn
- (skip-chars-forward "(a-z")
- (forward-char)
- (read))
- symbol (if (consp symbol)
- (nth 1 symbol)
- symbol))
- (if (if this-is-a-variable
- (get symbol 'variable-documentation)
- (and (fboundp symbol) (apropos-safe-documentation symbol)))
- (progn
- (or (and (setq apropos-item (assq symbol apropos-accumulator))
- (setcar (cdr apropos-item)
- (+ (cadr apropos-item) (apropos-score-doc doc))))
- (setq apropos-item (list symbol
- (+ (apropos-score-symbol symbol 2)
- (apropos-score-doc doc))
- nil nil)
- apropos-accumulator (cons apropos-item
- apropos-accumulator)))
- (if apropos-match-face
- (put-text-property beg end 'face apropos-match-face
- doc))
- (setcar (nthcdr (if this-is-a-variable 3 2)
- apropos-item)
- doc)))))))))
+ beg (- (match-beginning 0) beg))
+ (when (apropos-true-hit-doc doc)
+ (setq this-is-a-variable (looking-at "(def\\(var\\|const\\) ")
+ symbol (progn
+ (skip-chars-forward "(a-z")
+ (forward-char)
+ (read))
+ symbol (if (consp symbol)
+ (nth 1 symbol)
+ symbol))
+ (if (if this-is-a-variable
+ (get symbol 'variable-documentation)
+ (and (fboundp symbol) (apropos-safe-documentation symbol)))
+ (progn
+ (or (and (setq apropos-item (assq symbol apropos-accumulator))
+ (setcar (cdr apropos-item)
+ (+ (cadr apropos-item) (apropos-score-doc doc))))
+ (setq apropos-item (list symbol
+ (+ (apropos-score-symbol symbol 2)
+ (apropos-score-doc doc))
+ nil nil)
+ apropos-accumulator (cons apropos-item
+ apropos-accumulator)))
+ (if apropos-match-face
+ (put-text-property beg end 'face apropos-match-face
+ doc))
+ (setcar (nthcdr (if this-is-a-variable 3 2)
+ apropos-item)
+ doc))))))))))
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
key))
key)
item ", "))
- (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)))
+ (insert "M-x ... RET")
+ (when apropos-keybinding-face
+ (put-text-property (- (point) 11) (- (point) 8)
+ 'face apropos-keybinding-face)
+ (put-text-property (- (point) 3) (point)
+ 'face apropos-keybinding-face))))
(terpri)
(apropos-print-doc 2
(if (commandp symbol)
(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