-;;; apropos.el --- faster apropos commands.
-
-;; Copyright (C) 1989 Free Software Foundation, Inc.
-
-;; Author: Joe Wells <jbw@bigbird.bu.edu>
-;; Keywords: help
-
-;; This file is part of GNU Emacs.
-
-;; GNU Emacs is free software; you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
-
-;; GNU Emacs is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-;; GNU General Public License for more details.
-
-;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
-
-;;; Commentary:
-
-;; The ideas for this package were derived from the C code in
-;; src/keymap.c and elsewhere. The functions in this file should
-;; always be byte-compiled for speed. Someone should rewrite this in
-;; C (as part of src/keymap.c) for speed.
-
-;; The idea for super-apropos is based on the original implementation
-;; by Lynn Slater <lrs@esl.com>.
-
-;; History:
-;; Fixed bug, current-local-map can return nil.
-;; Change, doesn't calculate key-bindings unless needed.
-;; Added super-apropos capability, changed print functions.
-;; Made fast-apropos and super-apropos share code.
-;; Sped up fast-apropos again.
-;; Added apropos-do-all option.
-;; Added fast-command-apropos.
-;; Changed doc strings to comments for helping functions.
-;; Made doc file buffer read-only, buried it.
-;; Only call substitute-command-keys if do-all set.
-
-;;; Code:
-
-(defvar apropos-do-all nil
- "*Whether `apropos' and `super-apropos' should do everything that they can.
-Makes them run 2 or 3 times slower. Set this non-nil if you have a fast
-machine.")
-
-;; If there isn't already a lisp variable named internal-doc-file-name, create
-;; it and document it. This is so the code will work right after RMS adds
-;; internal-doc-file-name.
-;(or (boundp 'internal-doc-file-name)
-; (setq internal-doc-file-name (concat data-directory "DOC")))
-;(or (documentation-property 'internal-doc-file-name 'variable-documentation)
-; (put 'internal-doc-file-name 'variable-documentation
-; "The complete pathname of the documentation file that contains all
-;documentation for functions and variables defined before Emacs is dumped."))
-
-;;;###autoload
-(defun apropos (regexp &optional do-all pred)
- "Show all symbols whose names contain matches for REGEXP.
-If optional argument DO-ALL is non-nil, does more (time-consuming) work such as
-showing key bindings. Optional argument PRED is called with each symbol, and
-if it returns nil, the symbol is not shown.
-
-Returns list of symbols and documentation found."
- (interactive "sApropos (regexp): \nP")
- (setq do-all (or apropos-do-all do-all))
- (let ((apropos-accumulate (apropos-internal regexp pred)))
- (if (null apropos-accumulate)
- (message "No apropos matches for `%s'" regexp)
- (apropos-get-doc apropos-accumulate)
- (with-output-to-temp-buffer "*Help*"
- (apropos-print-matches apropos-accumulate regexp nil do-all)))
- apropos-accumulate))
-
-;; If "C-h a" still has its original binding of command-apropos, change it to
-;; use fast-command-apropos. I don't use substitute-key-definition because
-;; it's slow.
-;(if (eq 'command-apropos (lookup-key help-map "a"))
-; (define-key help-map "a" 'fast-command-apropos))
-
-;; Takes LIST of symbols and adds documentation. Modifies LIST in place.
-;; Resulting alist is of form ((symbol fn-doc var-doc) ...). Should only be
-;; called by apropos. Returns LIST.
-
-(defun apropos-get-doc (list)
- (let ((p list)
- fn-doc var-doc symbol)
- (while (consp p)
- (setq symbol (car p)
- fn-doc (and (fboundp symbol)
- (documentation symbol))
- var-doc (documentation-property symbol 'variable-documentation)
- fn-doc (and fn-doc
- (substring fn-doc 0 (string-match "\n" fn-doc)))
- var-doc (and var-doc
- (substring var-doc 0 (string-match "\n" var-doc))))
- (setcar p (list symbol fn-doc var-doc))
- (setq p (cdr p)))
- list))
-
-;;;###autoload
-(defun super-apropos (regexp &optional do-all)
- "Show symbols whose names/documentation contain matches for REGEXP.
-If optional argument DO-ALL is non-nil, does more (time-consuming) work such as
-showing key bindings and documentation that is not stored in the documentation
-file.
-
-Returns list of symbols and documentation found."
- (interactive "sSuper Apropos: \nP")
- (setq do-all (or apropos-do-all do-all))
- (let (apropos-accumulate fn-doc var-doc item)
- (setq apropos-accumulate (super-apropos-check-doc-file regexp))
- (if (null apropos-accumulate)
- (message "No apropos matches for `%s'" regexp)
- (if do-all (mapatoms 'super-apropos-accumulate))
- (with-output-to-temp-buffer "*Help*"
- (apropos-print-matches apropos-accumulate nil t do-all)))
- apropos-accumulate))
-
-;; Finds all documentation related to REGEXP in internal-doc-file-name.
-;; Returns an alist of form ((symbol fn-doc var-doc) ...).
-
-(defun super-apropos-check-doc-file (regexp)
- (let* ((doc-file (concat data-directory internal-doc-file-name))
- (doc-buffer (find-file-noselect doc-file t))
- ;; (doc-buffer (or (get-file-buffer doc-file)
- ;; (find-file-noselect doc-file)))
- type symbol doc sym-list)
- (save-excursion
- (set-buffer doc-buffer)
- ;; a user said he might accidentally edit the doc file
- (setq buffer-read-only t)
- (bury-buffer doc-buffer)
- (goto-char (point-min))
- (while (re-search-forward regexp nil t)
- (search-backward "\C-_")
- (setq type (if (eq ?F (char-after (1+ (point))))
- 1 ;function documentation
- 2) ;variable documentation
- symbol (progn
- (forward-char 2)
- (read doc-buffer))
- doc (buffer-substring
- (point)
- (progn
- (if (search-forward "\C-_" nil 'move)
- (1- (point))
- (point))))
- item (assq symbol sym-list))
- (or item
- (setq item (list symbol nil nil)
- sym-list (cons item sym-list)))
- (setcar (nthcdr type item) doc)))
- sym-list))
-
-;; This is passed as the argument to map-atoms, so it is called once for every
-;; symbol in obarray. Takes one argument SYMBOL, and finds any memory-resident
-;; documentation on that symbol if it matches a variable regexp. WARNING: this
-;; function depends on the symbols fn-doc var-doc regexp and item being bound
-;; correctly when it is called!"
-
-(defun super-apropos-accumulate (symbol)
- (cond ((string-match regexp (symbol-name symbol))
- (setq item (apropos-get-accum-item symbol))
- (setcar (cdr item) (or (safe-documentation symbol)
- (nth 1 item)))
- (setcar (nthcdr 2 item) (or (safe-documentation-property symbol)
- (nth 2 item))))
- (t
- (and (setq fn-doc (safe-documentation symbol))
- (string-match regexp fn-doc)
- (setcar (cdr (apropos-get-accum-item symbol)) fn-doc))
- (and (setq var-doc (safe-documentation-property symbol))
- (string-match regexp var-doc)
- (setcar (nthcdr 2 (apropos-get-accum-item symbol)) var-doc))))
- nil)
-
-;; Prints the symbols and documentation in alist MATCHES of form ((symbol
-;; fn-doc var-doc) ...). Uses optional argument REGEXP to speed up searching
-;; for keybindings. The names of all symbols in MATCHES must match REGEXP.
-;; Displays in the buffer pointed to by standard-output. Optional argument
-;; SPACING means put blank lines in between each symbol's documentation.
-;; Optional argument DO-ALL means do more time-consuming work, specifically,
-;; consulting key bindings. Should only be called within a
-;; with-output-to-temp-buffer.
-
-(defun apropos-print-matches (matches &optional regexp spacing do-all)
- (setq matches (sort matches (function
- (lambda (a b)
- (string-lessp (car a) (car b))))))
- (let ((p matches)
- (old-buffer (current-buffer))
- item keys-done symbol)
- (save-excursion
- (set-buffer standard-output)
- (or matches (princ "No matches found."))
- (while (consp p)
- (setq item (car p)
- symbol (car item)
- p (cdr p))
- (or (not spacing) (bobp) (terpri))
- (princ symbol) ;print symbol name
- ;; don't calculate key-bindings unless needed
- (cond ((and do-all (commandp symbol) (not keys-done))
- (save-excursion
- (set-buffer old-buffer)
- (apropos-match-keys matches regexp))
- (setq keys-done t)))
- (cond ((and do-all
- (or (setq tem (nthcdr 3 item))
- (commandp symbol)))
- (indent-to 30 1)
- (if tem
- (princ (mapconcat 'key-description tem ", "))
- (princ "(not bound to any keys)"))))
- (terpri)
- (cond ((setq tem (nth 1 item))
- (princ " Function: ")
- (princ (if do-all (substitute-command-keys tem) tem))))
- (or (bolp) (terpri))
- (cond ((setq tem (nth 2 item))
- (princ " Variable: ")
- (princ (if do-all (substitute-command-keys tem) tem))))
- (or (bolp) (terpri)))))
- t)
-
-;; Find key bindings for symbols that are cars in ALIST. Optionally, first
-;; match the symbol name against REGEXP. Modifies ALIST in place. Each key
-;; binding is added as a string to the end of the list in ALIST whose car is
-;; the corresponding symbol. The pointer to ALIST is returned.
-
-(defun apropos-match-keys (alist &optional regexp)
- (let* ((current-local-map (current-local-map))
- (maps (append (and current-local-map
- (accessible-keymaps current-local-map))
- (accessible-keymaps (current-global-map))))
- map ;map we are now inspecting
- sequence ;key sequence to reach map
- i ;index into vector map
- command ;what is bound to current keys
- key ;last key to reach command
- local ;local binding for sequence + key
- item) ;symbol data item in alist
- ;; examine all reachable keymaps
- (while (consp maps)
- (setq map (cdr (car maps))
- sequence (car (car maps)) ;keys to reach this map
- maps (cdr maps))
- ;; Skip the leading `keymap', doc string, etc.
- (if (eq (car map) 'keymap)
- (setq map (cdr map)))
- (while (stringp (car-safe map))
- (setq map (cdr map)))
- (while (consp map)
- (cond ((consp (car map))
- (setq command (cdr (car map))
- key (car (car map)))
- ;; Skip any menu prompt in this key binding.
- (and (consp command) (symbolp (cdr command))
- (setq command (cdr command)))
- ;; if is a symbol, and matches optional regexp, and is a car
- ;; in alist, and is not shadowed by a different local binding,
- ;; record it
- (and (symbolp command)
- (if regexp (string-match regexp (symbol-name command)))
- (setq item (assq command alist))
- (if (or (vectorp sequence) (not (integerp key)))
- (setq key (vconcat sequence (vector key)))
- (setq key (concat sequence (char-to-string key))))
- ;; checking if shadowed by local binding.
- ;; either no local map, no local binding, or runs off the
- ;; binding tree (number), or is the same binding
- (or (not current-local-map)
- (not (setq local (lookup-key current-local-map key)))
- (numberp local)
- (eq command local))
- ;; add this key binding to the item in alist
- (nconc item (cons key nil))))
- ((vectorp (car map))
- (let ((i 0)
- (vec (car map))
- (len (length (car map))))
- (while (< i len)
- (setq command (aref vec i))
- (setq key i)
- ;; Skip any menu prompt in this key binding.
- (and (consp command) (symbolp (cdr command))
- (setq command (cdr command)))
- ;; This is the same as the code in the previous case.
- (and (symbolp command)
- (if regexp (string-match regexp (symbol-name command)))
- (setq item (assq command alist))
- (if (or (vectorp sequence) (not (integerp key)))
- (setq key (vconcat sequence (vector key)))
- (setq key (concat sequence (char-to-string key))))
- ;; checking if shadowed by local binding.
- ;; either no local map, no local binding, or runs off the
- ;; binding tree (number), or is the same binding
- (or (not current-local-map)
- (not (setq local (lookup-key current-local-map key)))
- (numberp local)
- (eq command local))
- ;; add this key binding to the item in alist
- (nconc item (cons key nil)))
- (setq i (1+ i))))))
- (setq map (cdr map)))))
- alist)
-
-;; Get an alist item in alist apropos-accumulate whose car is SYMBOL. Creates
-;; the item if not already present. Modifies apropos-accumulate in place.
-
-(defun apropos-get-accum-item (symbol)
- (or (assq symbol apropos-accumulate)
- (progn
- (setq apropos-accumulate
- (cons (list symbol nil nil) apropos-accumulate))
- (assq symbol apropos-accumulate))))
-
-(defun safe-documentation (function)
- "Like documentation, except it avoids calling `get_doc_string'.
-Will return nil instead."
- (while (symbolp function)
- (setq function (if (fboundp function)
- (symbol-function function)
- 0)))
- (if (not (consp function))
- nil
- (if (eq (car function) 'macro)
- (setq function (cdr function)))
- (if (not (memq (car function) '(lambda autoload)))
- nil
- (setq function (nth 2 function))
- (if (stringp function)
- function
- nil))))
-
-(defun safe-documentation-property (symbol)
- "Like documentation-property, except it avoids calling `get_doc_string'.
-Will return nil instead."
- (setq symbol (get symbol 'variable-documentation))
- (if (numberp symbol)
- nil
- symbol))
-
-;;; apropos.el ends here
+;;; apropos.el --- apropos commands for users and programmers
+
+;; Copyright (C) 1989, 1994, 1995, 2001 Free Software Foundation, Inc.
+
+;; Author: Joe Wells <jbw@bigbird.bu.edu>
+;; Rewritten: Daniel Pfeiffer <occitan@esperanto.org>
+;; Keywords: help
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 2, or (at your option)
+;; any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; 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.
+
+;;; Commentary:
+
+;; The ideas for this package were derived from the C code in
+;; src/keymap.c and elsewhere. The functions in this file should
+;; always be byte-compiled for speed. Someone should rewrite this in
+;; C (as part of src/keymap.c) for speed.
+
+;; The idea for super-apropos is based on the original implementation
+;; by Lynn Slater <lrs@esl.com>.
+
+;; History:
+;; Fixed bug, current-local-map can return nil.
+;; Change, doesn't calculate key-bindings unless needed.
+;; Added super-apropos capability, changed print functions.
+;;; Made fast-apropos and super-apropos share code.
+;;; Sped up fast-apropos again.
+;; Added apropos-do-all option.
+;;; Added fast-command-apropos.
+;; Changed doc strings to comments for helping functions.
+;;; Made doc file buffer read-only, buried it.
+;; Only call substitute-command-keys if do-all set.
+
+;; Optionally use configurable faces to make the output more legible.
+;; Differentiate between command, function and macro.
+;; Apropos-command (ex command-apropos) does cmd and optionally user var.
+;; Apropos shows all 3 aspects of symbols (fn, var and plist)
+;; Apropos-documentation (ex super-apropos) now finds all it should.
+;; New apropos-value snoops through all values and optionally plists.
+;; Reading DOC file doesn't load nroff.
+;; Added hypertext following of documentation, mouse-2 on variable gives value
+;; from buffer in active window.
+
+;;; Code:
+
+(require 'button)
+
+(defgroup apropos nil
+ "Apropos commands for users and programmers"
+ :group 'help
+ :prefix "apropos")
+
+;; I see a degradation of maybe 10-20% only.
+(defcustom apropos-do-all nil
+ "*Whether the apropos commands should do more.
+
+Slows them down more or less. Set this non-nil if you have a fast machine."
+ :group 'apropos
+ :type 'boolean)
+
+
+(defcustom apropos-symbol-face 'bold
+ "*Face for symbol name in Apropos output, or nil for none."
+ :group 'apropos
+ :type 'face)
+
+(defcustom apropos-keybinding-face 'underline
+ "*Face for lists of keybinding in Apropos output, or nil for none."
+ :group 'apropos
+ :type 'face)
+
+(defcustom apropos-label-face 'italic
+ "*Face for label (`Command', `Variable' ...) in Apropos output.
+A value of nil means don't use any special font for them, and also
+turns off mouse highlighting."
+ :group 'apropos
+ :type 'face)
+
+(defcustom apropos-property-face 'bold-italic
+ "*Face for property name in apropos output, or nil for none."
+ :group 'apropos
+ :type 'face)
+
+(defcustom apropos-match-face 'secondary-selection
+ "*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)
+
+
+(defvar apropos-mode-map
+ (let ((map (make-sparse-keymap)))
+ (set-keymap-parent map button-buffer-map)
+ ;; Use `apropos-follow' instead of just using the button
+ ;; definition of RET, so that users can use it anywhere in an
+ ;; apropos item, not just on top of a button.
+ (define-key map "\C-m" 'apropos-follow)
+ (define-key map " " 'scroll-up)
+ (define-key map "\177" 'scroll-down)
+ (define-key map "q" 'quit-window)
+ map)
+ "Keymap used in Apropos mode.")
+
+(defvar apropos-mode-hook nil
+ "*Hook run when mode is turned on.")
+
+(defvar apropos-regexp nil
+ "Regexp used in current apropos run.")
+
+(defvar apropos-files-scanned ()
+ "List of elc files already scanned in current run of `apropos-documentation'.")
+
+(defvar apropos-accumulator ()
+ "Alist of symbols already found in current apropos run.")
+
+(defvar apropos-item ()
+ "Current item in or for `apropos-accumulator'.")
+
+\f
+;;; 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"
+ 'action #'apropos-symbol-button-display-help
+ 'skip t)
+
+(defun apropos-symbol-button-display-help (button)
+ "Display further help for the `apropos-symbol' button BUTTON."
+ (button-activate
+ (or (apropos-next-label-button (button-start button))
+ (error "There is nothing to follow for `%s'" (button-label button)))))
+
+(define-button-type 'apropos-function
+ 'apropos-label "Function"
+ 'action (lambda (button)
+ (describe-function (button-get button 'apropos-symbol)))
+ 'help-echo "mouse-2, RET: Display more help on this function")
+(define-button-type 'apropos-macro
+ 'apropos-label "Macro"
+ 'action (lambda (button)
+ (describe-function (button-get button 'apropos-symbol)))
+ 'help-echo "mouse-2, RET: Display more help on this macro")
+(define-button-type 'apropos-command
+ 'apropos-label "Command"
+ 'action (lambda (button)
+ (describe-function (button-get button 'apropos-symbol)))
+ 'help-echo "mouse-2, RET: Display more help on this command")
+
+;; We used to use `customize-variable-other-window' instead for a
+;; customizable variable, but that is slow. It is better to show an
+;; ordinary help buffer and let the user click on the customization
+;; button in that buffer, if he wants to.
+;; Likewise for `customize-face-other-window'.
+(define-button-type 'apropos-variable
+ 'apropos-label "Variable"
+ 'help-echo "mouse-2, RET: Display more help on this variable"
+ '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"
+ '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"
+ 'action (lambda (button)
+ (customize-variable-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"
+ '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"
+ 'action (lambda (button)
+ (apropos-describe-plist (button-get button 'apropos-symbol))))
+
+(defun apropos-next-label-button (pos)
+ "Returns the next apropos label button after POS, or nil if there's none.
+Will also return nil if more than one `apropos-symbol' button is encountered
+before finding a label."
+ (let* ((button (next-button pos t))
+ (already-hit-symbol nil)
+ (label (and button (button-get button 'apropos-label)))
+ (type (and button (button-get button 'type))))
+ (while (and button
+ (not label)
+ (or (not (eq type 'apropos-symbol))
+ (not already-hit-symbol)))
+ (when (eq type 'apropos-symbol)
+ (setq already-hit-symbol t))
+ (setq button (next-button (button-start button)))
+ (when button
+ (setq label (button-get button 'apropos-label))
+ (setq type (button-get button 'type))))
+ (and label button)))
+
+\f
+;;;###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
+normal variables."
+ (interactive (list (read-string
+ (concat "Apropos "
+ (if (or current-prefix-arg apropos-do-all)
+ "variable"
+ "user option")
+ " (regexp): "))
+ current-prefix-arg))
+ (apropos-command regexp nil
+ (if (or do-all apropos-do-all)
+ #'(lambda (symbol)
+ (and (boundp symbol)
+ (get symbol 'variable-documentation)))
+ 'user-variable-p)))
+
+;; For auld lang syne:
+;;;###autoload
+(fset '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
+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): "))
+ current-prefix-arg))
+ (let ((message
+ (let ((standard-output (get-buffer-create "*Apropos*")))
+ (print-help-return-message 'identity))))
+ (or do-all (setq do-all apropos-do-all))
+ (setq apropos-accumulator
+ (apropos-internal apropos-regexp
+ (or var-predicate
+ (if do-all 'functionp 'commandp))))
+ (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)
+ doc symbol)
+ (while p
+ (setcar p (list
+ (setq symbol (car p))
+ (unless var-predicate
+ (if (functionp symbol)
+ (if (setq doc (documentation symbol t))
+ (substring doc 0 (string-match "\n" doc))
+ "(not documented)")))
+ (and var-predicate
+ (funcall var-predicate symbol)
+ (if (setq doc (documentation-property
+ symbol 'variable-documentation t))
+ (substring doc 0
+ (string-match "\n" doc))))))
+ (setq p (cdr p))))
+ (and (apropos-print t nil)
+ message
+ (message message))))
+
+
+;;;###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): \nP")
+ (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))
+ (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)"))
+ (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))
+
+
+;;;###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
+at the function and at the names and values of properties.
+Returns list of symbols and values found."
+ (interactive "sApropos value (regexp): \nP")
+ (or do-all (setq do-all apropos-do-all))
+ (setq apropos-accumulator ())
+ (let (f v p)
+ (mapatoms
+ (lambda (symbol)
+ (setq f nil v nil p nil)
+ (or (memq symbol '(apropos-regexp do-all apropos-accumulator
+ symbol f v p))
+ (setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
+ (if do-all
+ (setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
+ p (apropos-format-plist symbol "\n " t)))
+ (if (or f v p)
+ (setq apropos-accumulator (cons (list symbol f v p)
+ apropos-accumulator))))))
+ (apropos-print nil t))
+
+
+;;;###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
+documentation that is not stored in the documentation file and show key
+bindings.
+Returns list of symbols and documentation found."
+ (interactive "sApropos documentation (regexp): \nP")
+ (or do-all (setq do-all apropos-do-all))
+ (setq apropos-accumulator () apropos-files-scanned ())
+ (let ((standard-input (get-buffer-create " apropos-temp"))
+ f v)
+ (unwind-protect
+ (save-excursion
+ (set-buffer standard-input)
+ (apropos-documentation-check-doc-file)
+ (if do-all
+ (mapatoms
+ (lambda (symbol)
+ (setq f (apropos-safe-documentation symbol)
+ v (get symbol 'variable-documentation))
+ (if (integerp v) (setq v))
+ (setq f (apropos-documentation-internal f)
+ v (apropos-documentation-internal v))
+ (if (or f v)
+ (if (setq apropos-item
+ (cdr (assq symbol apropos-accumulator)))
+ (progn
+ (if f
+ (setcar apropos-item f))
+ (if v
+ (setcar (cdr apropos-item) v)))
+ (setq apropos-accumulator
+ (cons (list symbol f v)
+ apropos-accumulator)))))))
+ (apropos-print nil t))
+ (kill-buffer standard-input))))
+
+\f
+(defun apropos-value-internal (predicate symbol function)
+ (if (funcall predicate symbol)
+ (progn
+ (setq symbol (prin1-to-string (funcall function symbol)))
+ (if (string-match apropos-regexp symbol)
+ (progn
+ (if apropos-match-face
+ (put-text-property (match-beginning 0) (match-end 0)
+ 'face apropos-match-face
+ symbol))
+ symbol)))))
+
+(defun apropos-documentation-internal (doc)
+ (if (consp doc)
+ (apropos-documentation-check-elc-file (car doc))
+ (and doc
+ (string-match apropos-regexp 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))))
+
+(defun apropos-format-plist (pl sep &optional compare)
+ (setq pl (symbol-plist pl))
+ (let (p p-out)
+ (while pl
+ (setq p (format "%s %S" (car pl) (nth 1 pl)))
+ (if (or (not compare) (string-match apropos-regexp p))
+ (if apropos-property-face
+ (put-text-property 0 (length (symbol-name (car pl)))
+ 'face apropos-property-face p))
+ (setq p nil))
+ (if p
+ (progn
+ (and compare apropos-match-face
+ (put-text-property (match-beginning 0) (match-end 0)
+ 'face apropos-match-face
+ p))
+ (setq p-out (concat p-out (if p-out sep) p))))
+ (setq pl (nthcdr 2 pl)))
+ p-out))
+
+
+;; 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)
+ (insert ?\^_)
+ (backward-char)
+ (insert-file-contents (concat doc-directory internal-doc-file-name))
+ (forward-char)
+ (while (save-excursion
+ (setq sepb (search-forward "\^_"))
+ (not (eobp)))
+ (beginning-of-line 2)
+ (if (save-restriction
+ (narrow-to-region (point) (1- sepb))
+ (re-search-forward apropos-regexp nil t))
+ (progn
+ (setq beg (match-beginning 0)
+ end (point))
+ (goto-char (1+ sepa))
+ (or (setq type (if (eq ?F (preceding-char))
+ 1 ; function documentation
+ 2) ; 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))
+ (setq apropos-item (list symbol 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)
+ (if (member file apropos-files-scanned)
+ nil
+ (let (symbol doc beg end this-is-a-variable)
+ (setq apropos-files-scanned (cons file apropos-files-scanned))
+ (erase-buffer)
+ (insert-file-contents file)
+ (while (search-forward "\n#@" nil t)
+ ;; Read the comment length, and advance over it.
+ (setq end (read)
+ beg (1+ (point))
+ end (+ (point) end -1))
+ (forward-char)
+ (if (save-restriction
+ ;; match ^ and $ relative to doc string
+ (narrow-to-region beg end)
+ (re-search-forward apropos-regexp nil t))
+ (progn
+ (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 (setq apropos-item (assq symbol apropos-accumulator))
+ (setq apropos-item (list symbol 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 2 1)
+ apropos-item)
+ doc)))))))))
+
+
+
+(defun apropos-safe-documentation (function)
+ "Like `documentation', except it avoids calling `get_doc_string'.
+Will return nil instead."
+ (while (and function (symbolp function))
+ (setq function (if (fboundp function)
+ (symbol-function function))))
+ (if (eq (car-safe function) 'macro)
+ (setq function (cdr function)))
+ (setq function (if (byte-code-function-p function)
+ (if (> (length function) 4)
+ (aref function 4))
+ (if (eq (car-safe function) 'autoload)
+ (nth 2 function)
+ (if (eq (car-safe function) 'lambda)
+ (if (stringp (nth 2 function))
+ (nth 2 function)
+ (if (stringp (nth 3 function))
+ (nth 3 function)))))))
+ (if (integerp function)
+ nil
+ function))
+
+
+(defun apropos-print (do-keys spacing)
+ "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 (SYMBOL FN-DOC VAR-DOC [PLIST-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 (null apropos-accumulator)
+ (message "No apropos matches for `%s'" apropos-regexp)
+ (setq apropos-accumulator
+ (sort apropos-accumulator (lambda (a b)
+ (string-lessp (car a) (car b)))))
+ (with-output-to-temp-buffer "*Apropos*"
+ (let ((p apropos-accumulator)
+ (old-buffer (current-buffer))
+ symbol item)
+ (set-buffer standard-output)
+ (apropos-mode)
+ (if (display-mouse-p)
+ (insert "If moving the mouse over text changes the text's color,\n"
+ (substitute-command-keys
+ "you can click \\[push-button] on that text to get more information.\n")))
+ (insert "In this buffer, go to the name of the command, or function,"
+ " or variable,\n"
+ (substitute-command-keys
+ "and type \\[apropos-follow] to get full documentation.\n\n"))
+ (while (consp p)
+ (or (not spacing) (bobp) (terpri))
+ (setq apropos-item (car p)
+ symbol (car apropos-item)
+ p (cdr p))
+ (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)
+ ;; Calculate key-bindings if we want them.
+ (and do-keys
+ (commandp symbol)
+ (indent-to 30 1)
+ (if (let ((keys
+ (save-excursion
+ (set-buffer old-buffer)
+ (where-is-internal symbol)))
+ filtered)
+ ;; Copy over the list of key sequences,
+ ;; omitting any that contain a buffer or a frame.
+ (while keys
+ (let ((key (car keys))
+ (i 0)
+ loser)
+ (while (< i (length key))
+ (if (or (framep (aref key i))
+ (bufferp (aref key i)))
+ (setq loser t))
+ (setq i (1+ i)))
+ (or loser
+ (setq filtered (cons key filtered))))
+ (setq keys (cdr keys)))
+ (setq item filtered))
+ ;; Convert the remaining keys to a string and insert.
+ (insert
+ (mapconcat
+ (lambda (key)
+ (setq key (condition-case ()
+ (key-description key)
+ (error)))
+ (if apropos-keybinding-face
+ (put-text-property 0 (length key)
+ 'face apropos-keybinding-face
+ 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)))
+ (terpri)
+ (apropos-print-doc 1
+ (if (commandp symbol)
+ 'apropos-command
+ (if (apropos-macrop symbol)
+ 'apropos-macro
+ 'apropos-function))
+ t)
+ (apropos-print-doc 2 'apropos-variable t)
+ (apropos-print-doc 6 'apropos-group t)
+ (apropos-print-doc 5 'apropos-face t)
+ (apropos-print-doc 4 'apropos-widget t)
+ (apropos-print-doc 3 'apropos-plist nil))
+ (setq buffer-read-only t))))
+ (prog1 apropos-accumulator
+ (setq apropos-accumulator ()))) ; permit gc
+
+
+(defun apropos-macrop (symbol)
+ "T if SYMBOL is a Lisp macro."
+ (and (fboundp symbol)
+ (consp (setq symbol
+ (symbol-function symbol)))
+ (or (eq (car symbol) 'macro)
+ (if (eq (car symbol) 'autoload)
+ (memq (nth 4 symbol)
+ '(macro t))))))
+
+
+(defun apropos-print-doc (i type do-keys)
+ (if (stringp (setq i (nth i apropos-item)))
+ (progn
+ (insert " ")
+ (insert-text-button (button-type-get type 'apropos-label)
+ 'type type
+ ;; Can't use the default button face, since
+ ;; user may have changed the variable!
+ ;; Just say `no' to variables containing faces!
+ 'face apropos-label-face
+ 'apropos-symbol (car apropos-item))
+ (insert ": ")
+ (insert (if do-keys (substitute-command-keys i) i))
+ (or (bolp) (terpri)))))
+
+
+(defun apropos-follow ()
+ "Invokes any button at point, otherwise invokes the nearest label button."
+ (interactive)
+ (button-activate
+ (or (apropos-next-label-button (line-beginning-position))
+ (error "There is nothing to follow here"))))
+
+
+(defun apropos-describe-plist (symbol)
+ "Display a pretty listing of SYMBOL's plist."
+ (with-output-to-temp-buffer "*Help*"
+ (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))
+ (insert (apropos-format-plist symbol "\n "))
+ (princ ")")
+ (print-help-return-message)))
+
+
+(provide 'apropos)
+
+;;; apropos.el ends here
HCoop / bpt / emacs.git / blobdiff