X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/82e736c18b6d39c331b6cfe3ee233b9f2ea606f0..09fd8197ffbbd7e7fe6339f86a3477531d20ab27:/lisp/apropos.el

diff --git a/lisp/apropos.el b/lisp/apropos.el
index c91e4da82a..3889655ff9 100644
--- a/lisp/apropos.el
+++ b/lisp/apropos.el
@@ -1,6 +1,7 @@
 ;;; 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, 2006 Free Software Foundation, Inc.
 
 ;; Author: Joe Wells <jbw@bigbird.bu.edu>
 ;; Rewritten: Daniel Pfeiffer <occitan@esperanto.org>
@@ -20,8 +21,8 @@
 
 ;; 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:
 
@@ -58,9 +59,10 @@
 ;;; 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")
 
@@ -95,13 +97,30 @@ turns off mouse highlighting."
   :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."
+for the pattern; 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.
+This applies to all `apropos' commands except `apropos-documentation'.
+If value is `verbose', the computed score is shown for each match."
+  :group 'apropos
+  :type '(choice (const :tag "off" nil)
+		 (const :tag "on" t)
+		 (const :tag "show scores" verbose)))
+
+(defcustom apropos-documentation-sort-by-scores t
+  "*Non-nil means sort matches by scores; best match is shown first.
+This applies to `apropos-documentation' only.
+If value is `verbose', the computed score is shown for each match."
+  :group 'apropos
+  :type '(choice (const :tag "off" nil)
+		 (const :tag "on" t)
+		 (const :tag "show scores" verbose)))
 
 (defvar apropos-mode-map
   (let ((map (make-sparse-keymap)))
@@ -119,16 +138,22 @@ for the regexp; the part that matches gets displayed in this font."
 (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-pattern nil
+  "Apropos pattern as entered by user.")
+
+(defvar apropos-pattern-quoted nil
+  "Apropos pattern passed through `regexp-quoute'.")
+
+(defvar apropos-words ()
+  "Current list of apropos words extracted from `apropos-pattern'.")
+
+(defvar apropos-all-words ()
+  "Current list of words and synonyms.")
 
 (defvar apropos-regexp nil
   "Regexp used in current apropos run.")
 
-(defvar apropos-orig-regexp nil
-  "Regexp as entered by user.")
-
-(defvar apropos-all-regexp nil
+(defvar apropos-all-words-regexp nil
   "Regexp matching apropos-all-words.")
 
 (defvar apropos-files-scanned ()
@@ -143,23 +168,19 @@ for the regexp; the part that matches gets displayed in this font."
 (defvar apropos-synonyms '(
   ("find" "open" "edit")
   ("kill" "cut")
-  ("yank" "paste"))
+  ("yank" "paste")
+  ("region" "selection"))
   "List of synonyms known by apropos.
 Each element is a list of words where the first word is the standard emacs
 term, and the rest of the words are alternative terms.")
 
-(defvar apropos-words ()
-  "Current list of words.")
-
-(defvar apropos-all-words ()
-  "Current list of words and synonyms.")
-
 
 ;;; Button types used by apropos
 
 (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)
 
@@ -171,19 +192,24 @@ term, and the rest of the words are alternative terms.")
 
 (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
@@ -193,31 +219,36 @@ term, and the rest of the words are alternative terms.")
 (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))))
 
@@ -246,25 +277,45 @@ before finding a label."
   "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-rewrite-regexp (regexp)
+;;;###autoload
+(defun apropos-read-pattern (subject)
+  "Read an apropos pattern, either a word list or a regexp.
+Returns the user pattern, either a list of words which are matched
+literally, or a string which is used as a regexp to search for.
+
+SUBJECT is a string that is included in the prompt to identify what
+kind of objects to search."
+  (let ((pattern
+	 (read-string (concat "Apropos " subject " (word list or regexp): "))))
+    (if (string-equal (regexp-quote pattern) pattern)
+	;; Split into words
+	(split-string pattern "[ \t]+")
+      pattern)))
+
+(defun apropos-parse-pattern (pattern)
   "Rewrite a list of words to a regexp matching all permutations.
-If REGEXP is already a regexp, don't modify it."
-  (setq apropos-orig-regexp regexp)
-  (setq apropos-words () apropos-all-words ())
-  (if (string-equal (regexp-quote regexp) regexp)
+If PATTERN is a string, that means it is already a regexp.
+This updates variables `apropos-pattern', `apropos-pattern-quoted',
+`apropos-regexp', `apropos-words', and `apropos-all-words-regexp'."
+  (setq apropos-words nil
+	apropos-all-words nil)
+  (if (consp pattern)
       ;; We don't actually make a regexp matching all permutations.
       ;; Instead, for e.g. "a b c", we make a regexp matching
       ;; any combination of two or more words like this:
       ;; (a|b|c).*(a|b|c) which may give some false matches,
       ;; but as long as it also gives the right ones, that's ok.
-      (let ((words (split-string regexp "[ \t]+")))
+      (let ((words pattern))
+	(setq apropos-pattern (mapconcat 'identity pattern " ")
+	      apropos-pattern-quoted (regexp-quote apropos-pattern))
 	(dolist (word words)
 	  (let ((syn apropos-synonyms) (s word) (a word))
 	    (while syn
@@ -277,50 +328,53 @@ If REGEXP is already a regexp, don't modify it."
 		(setq syn (cdr syn))))
 	    (setq apropos-words (cons s apropos-words)
 		  apropos-all-words (cons a apropos-all-words))))
-	(setq apropos-all-regexp (apropos-words-to-regexp apropos-all-words ".+"))
-	(apropos-words-to-regexp apropos-words ".*?"))
-    (setq apropos-all-regexp regexp)))
+	(setq apropos-all-words-regexp
+	      (apropos-words-to-regexp apropos-all-words ".+"))
+	(setq apropos-regexp
+	      (apropos-words-to-regexp apropos-words ".*?")))
+    (setq apropos-pattern-quoted (regexp-quote pattern)
+	  apropos-all-words-regexp pattern
+	  apropos-pattern pattern
+	  apropos-regexp pattern)))
+
 
 (defun apropos-calc-scores (str words)
   "Return apropos scores for string STR matching WORDS.
 Value is a list of offsets of the words into the string."
-  (let ((scores ())
-	i)
+  (let (scores i)
     (if words
 	(dolist (word words scores)
 	  (if (setq i (string-match word str))
 	      (setq scores (cons i scores))))
       ;; Return list of start and end position of regexp
-      (string-match apropos-regexp str)
-      (list (match-beginning 0) (match-end 0)))))
+      (and (string-match apropos-pattern str)
+	   (list (match-beginning 0) (match-end 0))))))
 
 (defun apropos-score-str (str)
   "Return apropos score for string STR."
   (if str
-      (let* (
-	     (l (length str))
-	     (score (- (/ l 10)))
-	    i)
+      (let* ((l (length str))
+	     (score (- (/ l 10))))
 	(dolist (s (apropos-calc-scores str apropos-all-words) score)
 	  (setq score (+ score 1000 (/ (* (- l s) 1000) l)))))
       0))
 
 (defun apropos-score-doc (doc)
   "Return apropos score for documentation string DOC."
-  (if doc
-      (let ((score 0)
-	    (l (length doc))
-	    i)
-	(dolist (s (apropos-calc-scores doc apropos-all-words) score)
-	  (setq score (+ score 50 (/ (* (- l s) 50) l)))))
-      0))
-	  
+  (let ((l (length doc)))
+    (if (> l 0)
+	(let ((score 0) i)
+	  (when (setq i (string-match apropos-pattern-quoted doc))
+	    (setq score 10000))
+	  (dolist (s (apropos-calc-scores doc apropos-all-words) score)
+	    (setq score (+ score 50 (/ (* (- l s) 50) l)))))
+      0)))
+
 (defun apropos-score-symbol (symbol &optional weight)
   "Return apropos score for SYMBOL."
   (setq symbol (symbol-name symbol))
   (let ((score 0)
-	(l (length symbol))
-	i)
+	(l (length symbol)))
     (dolist (s (apropos-calc-scores symbol apropos-words) (* score (or weight 3)))
       (setq score (+ score (- 60 l) (/ (* (- l s) 60) l))))))
 
@@ -345,25 +399,26 @@ This requires that at least 2 keywords (unless only one was given)."
   "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.
 
 \\{apropos-mode-map}")
 
 ;;;###autoload
-(defun apropos-variable (regexp &optional do-all)
-  "Show user variables that match REGEXP.
-With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also show
+(defun apropos-variable (pattern &optional do-all)
+  "Show user variables that match PATTERN.
+PATTERN can be a word, a list of words (separated by spaces),
+or a regexp (using some regexp special characters).  If it is a word,
+search for matches for that word as a substring.  If it is a list of words,
+search for matches for any two (or more) of those words.
+
+With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also show
 normal variables."
-  (interactive (list (read-string
-                      (concat "Apropos "
-                              (if (or current-prefix-arg apropos-do-all)
-				  "variable"
-				"user option")
-                              " (regexp or words): "))
+  (interactive (list (apropos-read-pattern
+		      (if (or current-prefix-arg apropos-do-all)
+			  "variable" "user option"))
                      current-prefix-arg))
-  (apropos-command regexp nil
+  (apropos-command pattern nil
 		   (if (or do-all apropos-do-all)
 		       #'(lambda (symbol)
 			   (and (boundp symbol)
@@ -374,21 +429,26 @@ normal variables."
 ;;;###autoload
 (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.
-With optional prefix DO-ALL, or if `apropos-do-all' is non-nil, also show
+(defun apropos-command (pattern &optional do-all var-predicate)
+  "Show commands (interactively callable functions) that match PATTERN.
+PATTERN can be a word, a list of words (separated by spaces),
+or a regexp (using some regexp special characters).  If it is a word,
+search for matches for that word as a substring.  If it is a list of words,
+search for matches for any two (or more) of those words.
+
+With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also show
 noninteractive functions.
 
 If VAR-PREDICATE is non-nil, show only variables, and only those that
-satisfy the predicate VAR-PREDICATE."
-  (interactive (list (read-string (concat
-				   "Apropos command "
-				   (if (or current-prefix-arg
-					   apropos-do-all)
-				       "or function ")
-				   "(regexp or words): "))
+satisfy the predicate VAR-PREDICATE.
+
+When called from a Lisp program, a string PATTERN is used as a regexp,
+while a list of strings is used as a word list."
+  (interactive (list (apropos-read-pattern
+		      (if (or current-prefix-arg apropos-do-all)
+			  "command or function" "command"))
 		     current-prefix-arg))
-  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
+  (apropos-parse-pattern pattern)
   (let ((message
 	 (let ((standard-output (get-buffer-create "*Apropos*")))
 	   (print-help-return-message 'identity))))
@@ -413,7 +473,7 @@ satisfy the predicate VAR-PREDICATE."
 		     (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
@@ -426,88 +486,108 @@ satisfy the predicate VAR-PREDICATE."
 					  (string-match "\n" doc)))))))
 	(setcar (cdr (car p)) score)
 	(setq p (cdr p))))
-    (and (apropos-print t nil)
+    (and (apropos-print t nil nil t)
 	 message
-	 (message message))))
+	 (message "%s" 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.
-With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also
-show unbound symbols and key bindings, which is a little more
-time-consuming.  Returns list of symbols and documentation found."
-  (interactive "sApropos symbol (regexp or words): \nP")
-  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
-  (setq apropos-accumulator
-	(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)"))
+(defun apropos (pattern &optional do-all)
+  "Show all meaningful Lisp symbols whose names match PATTERN.
+Symbols are shown if they are defined as functions, variables, or
+faces, or if they have nonempty property lists.
+
+PATTERN can be a word, a list of words (separated by spaces),
+or a regexp (using some regexp special characters).  If it is a word,
+search for matches for that word as a substring.  If it is a list of words,
+search for matches for any two (or more) of those words.
+
+With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil,
+consider all symbols (if they match PATTERN).
+
+Returns list of symbols and documentation found."
+  (interactive (list (apropos-read-pattern "symbol")
+		     current-prefix-arg))
+  (apropos-parse-pattern pattern)
+  (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)))))
+   (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
-(defun apropos-value (apropos-regexp &optional do-all)
-  "Show all symbols whose value's printed image matches APROPOS-REGEXP.
-With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also looks
+(defun apropos-value (pattern &optional do-all)
+  "Show all symbols whose value's printed representation matches PATTERN.
+PATTERN can be a word, a list of words (separated by spaces),
+or a regexp (using some regexp special characters).  If it is a word,
+search for matches for that word as a substring.  If it is a list of words,
+search for matches for any two (or more) of those words.
+
+With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also looks
 at the function and at the names and values of properties.
 Returns list of symbols and values found."
-  (interactive "sApropos value (regexp or words): \nP")
-  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
+  (interactive (list (apropos-read-pattern "value")
+		     current-prefix-arg))
+  (apropos-parse-pattern pattern)
   (or do-all (setq do-all apropos-do-all))
   (setq apropos-accumulator ())
    (let (f v p)
@@ -515,7 +595,7 @@ Returns list of symbols and values found."
       (lambda (symbol)
 	(setq f nil v nil p nil)
 	(or (memq symbol '(apropos-regexp
-			   apropos-orig-regexp apropos-all-regexp
+			   apropos-pattern apropos-all-words-regexp
 			   apropos-words apropos-all-words
 			   do-all apropos-accumulator
 			   symbol f v p))
@@ -530,7 +610,7 @@ Returns list of symbols and values found."
 	(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))
@@ -540,17 +620,24 @@ Returns list of symbols and values found."
 
 
 ;;;###autoload
-(defun apropos-documentation (apropos-regexp &optional do-all)
-  "Show symbols whose documentation contain matches for APROPOS-REGEXP.
-With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also use
+(defun apropos-documentation (pattern &optional do-all)
+  "Show symbols whose documentation contains matches for PATTERN.
+PATTERN can be a word, a list of words (separated by spaces),
+or a regexp (using some regexp special characters).  If it is a word,
+search for matches for that word as a substring.  If it is a list of words,
+search for matches for any two (or more) of those words.
+
+With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also use
 documentation that is not stored in the documentation file and show key
 bindings.
 Returns list of symbols and documentation found."
-  (interactive "sApropos documentation (regexp or words): \nP")
-  (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
+  (interactive (list (apropos-read-pattern "documentation")
+		     current-prefix-arg))
+  (apropos-parse-pattern pattern)
   (or do-all (setq do-all apropos-do-all))
   (setq apropos-accumulator () apropos-files-scanned ())
   (let ((standard-input (get-buffer-create " apropos-temp"))
+	(apropos-sort-by-scores apropos-documentation-sort-by-scores)
 	f v sf sv)
     (unwind-protect
 	(save-excursion
@@ -579,11 +666,11 @@ Returns list of symbols and documentation found."
 				 (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-print nil "\n----------------\n"))
+	  (apropos-print nil "\n----------------\n" nil t))
       (kill-buffer standard-input))))
 
 
@@ -602,16 +689,17 @@ Returns list of symbols and documentation found."
 (defun apropos-documentation-internal (doc)
   (if (consp doc)
       (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)
-				  (match-end 0)
-				  'face apropos-match-face
-				  (setq doc (copy-sequence doc))))
-	   doc))))
+    (if (and doc
+	     (string-match apropos-all-words-regexp doc)
+	     (apropos-true-hit-doc doc))
+	(when apropos-match-face
+	  (setq doc (substitute-command-keys (copy-sequence doc)))
+	  (if (or (string-match apropos-pattern-quoted doc)
+		  (string-match apropos-all-words-regexp doc))
+	      (put-text-property (match-beginning 0)
+				 (match-end 0)
+				 'face apropos-match-face doc))
+	  doc))))
 
 (defun apropos-format-plist (pl sep &optional compare)
   (setq pl (symbol-plist pl))
@@ -637,7 +725,7 @@ Returns list of symbols and documentation found."
 ;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
 
 (defun apropos-documentation-check-doc-file ()
-  (let (type symbol (sepa 2) sepb beg end)
+  (let (type symbol (sepa 2) sepb)
     (insert ?\^_)
     (backward-char)
     (insert-file-contents (concat doc-directory internal-doc-file-name))
@@ -648,30 +736,31 @@ Returns list of symbols and documentation found."
       (beginning-of-line 2)
       (if (save-restriction
 	    (narrow-to-region (point) (1- sepb))
-	    (re-search-forward apropos-all-regexp nil t))
+	    (re-search-forward apropos-all-words-regexp nil t))
 	  (progn
-	    (setq beg (match-beginning 0)
-		  end (point))
 	    (goto-char (1+ sepa))
 	    (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-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))
+	      (when apropos-match-face
+		(setq doc (substitute-command-keys doc))
+		(if (or (string-match apropos-pattern-quoted doc)
+			(string-match apropos-all-words-regexp doc))
+		    (put-text-property (match-beginning 0)
+				       (match-end 0)
+				       'face apropos-match-face doc)))
 	      (setcar (nthcdr type apropos-item) doc))))
       (setq sepa (goto-char sepb)))))
 
@@ -691,7 +780,7 @@ Returns list of symbols and documentation found."
 	(if (save-restriction
 	      ;; match ^ and $ relative to doc string
 	      (narrow-to-region beg end)
-	      (re-search-forward apropos-all-regexp nil t))
+	      (re-search-forward apropos-all-words-regexp nil t))
 	    (progn
 	      (goto-char (+ end 2))
 	      (setq doc (buffer-substring beg end)
@@ -719,9 +808,13 @@ Returns list of symbols and documentation found."
 						   nil nil)
 				apropos-accumulator (cons apropos-item
 							  apropos-accumulator)))
-		      (if apropos-match-face
-			  (put-text-property beg end 'face apropos-match-face
-					     doc))
+		      (when apropos-match-face
+			(setq doc (substitute-command-keys doc))
+			(if (or (string-match apropos-pattern-quoted doc)
+				(string-match apropos-all-words-regexp doc))
+			    (put-text-property (match-beginning 0)
+					       (match-end 0)
+					       'face apropos-match-face doc)))
 		      (setcar (nthcdr (if this-is-a-variable 3 2)
 				      apropos-item)
 			      doc))))))))))
@@ -751,24 +844,29 @@ Will return nil instead."
     function))
 
 
-(defun apropos-print (do-keys spacing)
+(defun apropos-print (do-keys spacing &optional text nosubst)
   "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)
+      (message "No apropos matches for `%s'" apropos-pattern)
     (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))
@@ -785,23 +883,32 @@ separate items with that string."
 		" 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))
 	  (setq apropos-item (car p)
 		symbol (car apropos-item)
 		p (cdr p))
+	  ;; Insert dummy score element for backwards compatibility with 21.x
+	  ;; apropos-item format.
+	  (if (not (numberp (cadr apropos-item)))
+	      (setq apropos-item
+		    (cons (car apropos-item)
+			  (cons nil (cdr apropos-item)))))
 	  (insert-text-button (symbol-name symbol)
 			      'type 'apropos-symbol
 			      ;; Can't use default, since user may have
 			      ;; changed the variable!
 			      ;; Just say `no' to variables containing faces!
 			      'face apropos-symbol-face)
-	  (if apropos-show-scores
+	  (if (and (eq apropos-sort-by-scores 'verbose)
+		   (cadr apropos-item))
 	      (insert " (" (number-to-string (cadr apropos-item)) ") "))
 	  ;; Calculate key-bindings if we want them.
 	  (and do-keys
 	       (commandp symbol)
+	       (not (eq symbol 'self-insert-command))
 	       (indent-to 30 1)
 	       (if (let ((keys
 			  (save-excursion
@@ -836,13 +943,12 @@ separate items with that string."
 					      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)
@@ -850,8 +956,8 @@ separate items with that string."
 			       (if (apropos-macrop symbol)
 				   'apropos-macro
 				 'apropos-function))
-			     t)
-	  (apropos-print-doc 3 'apropos-variable t)
+			     (not nosubst))
+	  (apropos-print-doc 3 'apropos-variable (not nosubst))
 	  (apropos-print-doc 7 'apropos-group t)
 	  (apropos-print-doc 6 'apropos-face t)
 	  (apropos-print-doc 5 'apropos-widget t)
@@ -862,7 +968,7 @@ separate items with that string."
 
 
 (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)))
@@ -898,13 +1004,15 @@ separate items with that string."
 
 (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)))
@@ -912,4 +1020,5 @@ separate items with that string."
 
 (provide 'apropos)
 
+;;; arch-tag: d56fa2ac-e56b-4ce3-84ff-852f9c0dc66e
 ;;; apropos.el ends here