;; 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.
+;; 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:
;;; Code:
+(defgroup apropos nil
+ "Apropos commands for users and programmers"
+ :group 'Help
+ :prefix "apropos")
+
;; I see a degradation of maybe 10-20% only.
-(defvar apropos-do-all nil
+(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.")
+
+Slows them down more or less. Set this non-nil if you have a fast machine."
+ :group 'apropos
+ :type 'boolean)
-(defvar apropos-symbol-face (if window-system 'bold)
- "*Face for symbol name in apropos output or `nil'.
-This looks good, but slows down the commands several times.")
+(defcustom apropos-symbol-face (if window-system 'bold)
+ "*Face for symbol name in apropos output or `nil'.
+This looks good, but slows down the commands several times."
+ :group 'apropos
+ :type 'face)
-(defvar apropos-keybinding-face (if window-system 'underline)
+(defcustom apropos-keybinding-face (if window-system 'underline)
"*Face for keybinding display in apropos output or `nil'.
-This looks good, but slows down the commands several times.")
+This looks good, but slows down the commands several times."
+ :group 'apropos
+ :type 'face)
-(defvar apropos-label-face (if window-system 'italic)
+(defcustom apropos-label-face (if window-system 'italic)
"*Face for label (Command, Variable ...) in apropos output or `nil'.
If this is `nil' no mouse highlighting occurs.
This looks good, but slows down the commands several times.
When this is a face name, as it is initially, it gets transformed to a
-text-property list for efficiency.")
+text-property list for efficiency."
+ :group 'apropos
+ :type 'face)
-(defvar apropos-property-face (if window-system 'bold-italic)
+(defcustom apropos-property-face (if window-system 'bold-italic)
"*Face for property name in apropos output or `nil'.
-This looks good, but slows down the commands several times.")
+This looks good, but slows down the commands several times."
+ :group 'apropos
+ :type 'face)
-(defvar apropos-match-face (if window-system 'highlight)
+(defcustom apropos-match-face (if window-system 'secondary-selection)
"*Face for matching part in apropos-documentation/value output or `nil'.
-This looks good, but slows down the commands several times.")
+This looks good, but slows down the commands several times."
+ :group 'apropos
+ :type 'face)
-(defvar apropos-local-map
+(defvar apropos-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\C-m" 'apropos-follow)
+ (define-key map " " 'scroll-up)
+ (define-key map "\177" 'scroll-down)
(define-key map [mouse-2] 'apropos-mouse-follow)
(define-key map [down-mouse-2] nil)
map)
- "Local map active when displaying apropos output.")
+ "Keymap used in Apropos mode.")
(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-documentaion'.")
+ "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
+(defun apropos-mode ()
+ "Major mode for following hyperlinks in output of apropos commands.
+
+\\{apropos-mode-map}"
+ (interactive)
+ (kill-all-local-variables)
+ (use-local-map apropos-mode-map)
+ (setq major-mode 'apropos-mode
+ mode-name "Apropos"))
+
+;;;###autoload
+(defun apropos-variable (regexp)
+ (interactive (list (read-string "Apropos variable (regexp): ")))
+ (apropos-command regexp nil t))
+
;; For auld lang syne:
;;;###autoload
(fset 'command-apropos 'apropos-command)
;;;###autoload
-(defun apropos-command (apropos-regexp &optional do-all)
- "Shows commands (interactively callable functions) that match REGEXP.
-With optional prefix ARG or if `apropos-do-all' is non-nil, also show
-variables."
- (interactive (list (read-string (concat "Apropos command "
- (if (or current-prefix-arg
- apropos-do-all)
- "or variable ")
- "(regexp): "))
+(defun apropos-command (apropos-regexp &optional do-all just-vars)
+ "Show commands (interactively callable functions) that match REGEXP.
+With optional prefix ARG, or if `apropos-do-all' is non-nil, also show
+variables. If JUST-VARS is non-nil, show only variables."
+ (interactive (list (read-string (concat
+ "Apropos command "
+ (if (or current-prefix-arg
+ apropos-do-all)
+ "or variable ")
+ "(regexp): "))
current-prefix-arg))
(let ((message
- (let ((standard-output (get-buffer-create "*Help*")))
+ (let ((standard-output (get-buffer-create "*Apropos*")))
(print-help-return-message 'identity))))
(or do-all (setq do-all apropos-do-all))
(setq apropos-accumulator
(if do-all
(lambda (symbol) (or (commandp symbol)
(user-variable-p symbol)))
- 'commandp)))
+ (if just-vars 'user-variable-p
+ '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))))
(if (apropos-print
t
(lambda (p)
(while p
(setcar p (list
(setq symbol (car p))
- (if (commandp symbol)
- (if (setq doc (documentation symbol t))
- (substring doc 0 (string-match "\n" doc))
- "(not documented)"))
+ (if (or do-all (not just-vars))
+ (if (commandp symbol)
+ (if (setq doc (documentation symbol t))
+ (substring doc 0 (string-match "\n" doc))
+ "(not documented)")))
(and do-all
(user-variable-p symbol)
(if (setq doc (documentation-property
(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))))
(apropos-print
(or do-all apropos-do-all)
(lambda (p)
- (let (symbol doc)
+ (let (symbol doc properties)
(while p
(setcar p (list
(setq symbol (car p))
- (if (fboundp symbol)
- (if (setq doc (documentation symbol t))
- (substring doc 0 (string-match "\n" doc))
- "(not documented)"))
- (if (boundp symbol)
- (if (setq doc (documentation-property
- symbol 'variable-documentation t))
- (substring doc 0
- (string-match "\n" doc))
- "(not documented)"))
- (if (setq doc (symbol-plist symbol))
- (if (eq (setq doc (/ (length doc) 2)) 1)
- "1 property"
- (concat doc " properties")))))
+ (when (fboundp symbol)
+ (if (setq doc (documentation symbol t))
+ (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)))))
nil))
;;;###autoload
(defun apropos-documentation (apropos-regexp &optional do-all)
- "Show symbols whose names or documentation contain matches for REGEXP.
+ "Show symbols whose documentation contain matches for REGEXP.
With optional prefix ARG or if `apropos-do-all' is non-nil, also use
documentation that is not stored in the documentation file and show key
bindings.
(mapatoms
(lambda (symbol)
(setq f (apropos-safe-documentation symbol)
- v (get symbol 'variable-documentation)
- v (if (integerp v) nil v))
- (or (string-match apropos-regexp (symbol-name symbol))
- (setq f (apropos-documentation-internal f)
- v (apropos-documentation-internal v)))
+ 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)))
(setq apropos-accumulator
(cons (list symbol f v)
apropos-accumulator)))))))
- (apropos-print do-all nil t))
+ (apropos-print nil nil t))
(kill-buffer standard-input))))
\f
;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
(defun apropos-documentation-check-doc-file ()
- (let (type symbol beg end)
+ (let (type symbol (sepa 2) sepb beg end)
+ (insert ?\^_)
+ (backward-char)
(insert-file-contents (concat doc-directory internal-doc-file-name))
- (while (re-search-forward apropos-regexp nil t)
- (setq beg (match-beginning 0)
- end (point))
- (search-backward "\C-_")
- (if (> (point) beg)
- ()
- (or (setq type (if (eq ?F (char-after (1+ (point))))
- 1 ;function documentation
- 2) ;variable documentation
- symbol (prog2
- (forward-char 2)
- (read))
- beg (- beg (point) 1)
- end (- end (point) 1)
- doc (buffer-substring
- (1+ (point))
- (if (search-forward "\C-_" nil 'move)
- (1- (point))
- (point)))
- apropos-item (assq symbol apropos-accumulator))
- (setq apropos-item (list symbol nil nil)
- apropos-accumulator (cons apropos-item apropos-accumulator)))
- (and apropos-match-face
- (>= beg 0)
- (put-text-property beg end 'face apropos-match-face doc))
- (setcar (nthcdr type apropos-item) doc)))))
+ (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 end1 this-is-a-variable)
+ (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 (point)
- end (+ (point) end 1))
- (if (re-search-forward apropos-regexp end t)
+ 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)
- (setq doc (buffer-substring (1+ beg) (- end 2))
- end1 (- (match-end 0) beg 1)
- beg (- (match-beginning 0) beg 1)
- this-is-a-variable (looking-at "(defvar\\|(defconst")
+ (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 1)
+ (forward-char)
(read))
symbol (if (consp symbol)
(nth 1 symbol)
apropos-accumulator (cons apropos-item
apropos-accumulator)))
(if apropos-match-face
- (put-text-property beg end1 'face 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)))))
- (goto-char end)))))
+ doc)))))))))
(funcall doc-fn apropos-accumulator))
(setq apropos-accumulator
(sort apropos-accumulator (lambda (a b)
- (string-lessp (car a) (car b)))))
+ (string-lessp (car a) (car b)))))
(and apropos-label-face
(symbolp apropos-label-face)
(setq apropos-label-face `(face ,apropos-label-face
mouse-face highlight)))
- (with-output-to-temp-buffer "*Help*"
+ (with-output-to-temp-buffer "*Apropos*"
(let ((p apropos-accumulator)
(old-buffer (current-buffer))
symbol item point1 point2)
- (save-excursion
- (set-buffer standard-output)
- (if window-system
- (insert (substitute-command-keys
- "Click \\<apropos-local-map>\\[apropos-mouse-follow] to get full documentation.\n")))
- (insert (substitute-command-keys
- "In this buffer, type \\<apropos-local-map>\\[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)
- point1 (point))
- (princ symbol) ;print symbol name
- (setq point2 (point))
- ;; don't calculate key-bindings unless needed
- (and do-keys
- (commandp symbol)
- (indent-to 30 1)
- (insert
- (if (setq item (save-excursion
- (set-buffer old-buffer)
- (where-is-internal symbol)))
- (mapconcat
+ (set-buffer standard-output)
+ (apropos-mode)
+ (if window-system
+ (insert "If you move the mouse over text that changes color,\n"
+ (substitute-command-keys
+ "you can click \\[apropos-mouse-follow] to get more information.\n")))
+ (insert (substitute-command-keys
+ "In this buffer, 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)
+ point1 (point))
+ (princ symbol) ; print symbol name
+ (setq point2 (point))
+ ;; 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 (key-description key))
(if apropos-keybinding-face
- (lambda (key)
- (setq key (key-description key))
- (put-text-property 0 (length key)
- 'face apropos-keybinding-face
- key)
- key)
- 'key-description)
- item ", ")
- "(not bound to any keys)")))
- (terpri)
- ;; only now so we don't propagate text attributes all over
- (put-text-property point1 (1+ point1) 'item
- (if (eval `(or ,@(cdr apropos-item)))
- (car apropos-item)
- apropos-item))
- (if apropos-symbol-face
- (put-text-property point1 point2 'face apropos-symbol-face))
- (apropos-print-doc 'describe-function 1
- (if (commandp symbol)
- "Command"
- (if (apropos-macrop symbol)
- "Macro"
- "Function"))
- do-keys)
+ (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)
+ ;; only now so we don't propagate text attributes all over
+ (put-text-property point1 point2 'item
+ (if (eval `(or ,@(cdr apropos-item)))
+ (car apropos-item)
+ apropos-item))
+ (if apropos-symbol-face
+ (put-text-property point1 point2 'face apropos-symbol-face))
+ (apropos-print-doc 'describe-function 1
+ (if (commandp symbol)
+ "Command"
+ (if (apropos-macrop symbol)
+ "Macro"
+ "Function"))
+ t)
+ (if (get symbol 'custom-type)
+ (apropos-print-doc 'customize-variable-other-window 2
+ "User Option" t)
(apropos-print-doc 'describe-variable 2
- "Variable" do-keys)
- (apropos-print-doc 'apropos-describe-plist 3
- "Plist" nil))
- (put-text-property 1 (point) 'local-map apropos-local-map)))))
+ "Variable" t))
+ (apropos-print-doc 'customize-group-other-window 6 "Group" t)
+ (apropos-print-doc 'customize-face-other-window 5 "Face" t)
+ (apropos-print-doc 'widget-browse-other-window 4 "Widget" t)
+ (apropos-print-doc 'apropos-describe-plist 3
+ "Plist" nil)))))
(prog1 apropos-accumulator
(setq apropos-accumulator ()))) ; permit gc
(defun apropos-mouse-follow (event)
(interactive "e")
- (let ((other (if (eq (current-buffer) (get-buffer "*Help*"))
+ (let ((other (if (eq (current-buffer) (get-buffer "*Apropos*"))
()
(current-buffer))))
- (set-buffer (window-buffer (posn-window (event-start event))))
- (goto-char (posn-point (event-start event)))
- ;; somehow when clicking with the point in another window, undoes badly
- (undo-boundary)
- (apropos-follow other)))
+ (save-excursion
+ (set-buffer (window-buffer (posn-window (event-start event))))
+ (goto-char (posn-point (event-start event)))
+ (or (and (not (eobp)) (get-text-property (point) 'mouse-face))
+ (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
+ (error "There is nothing to follow here"))
+ (apropos-follow other))))
(defun apropos-follow (&optional other)
(interactive)
- (let ((point (point))
- (item (get-text-property (point) 'item))
- action action-point)
- (or item
- (setq item (if (bobp)
- ()
- (previous-single-property-change (point) 'item))
- item (get-text-property
- (1- (goto-char
- (if item
- item
- (1+ (next-single-property-change (point) 'item)))))
- 'item)))
- (if (consp item)
- (error "%s is just a lonely smbol." (car item)))
- (while (if (setq action-point
- (next-single-property-change (point) 'action))
- (<= action-point point))
- (goto-char (1+ action-point))
- (setq action action-point))
- (funcall
- (prog1 (get-text-property (or action action-point (point)) 'action)
- (if other (set-buffer other)))
- item))
- (message "%sype %s (undo) to get back to apropos-listing."
- (if other "In *Help* buffer t" "T")
- (key-description (where-is-internal 'undo nil 1))))
+ (let* (;; Properties are always found at the beginning of the line.
+ (bol (save-excursion (beginning-of-line) (point)))
+ ;; If there is no `item' property here, look behind us.
+ (item (get-text-property bol 'item))
+ (item-at (if item nil (previous-single-property-change bol 'item)))
+ ;; Likewise, if there is no `action' property here, look in front.
+ (action (get-text-property bol 'action))
+ (action-at (if action nil (next-single-property-change bol 'action))))
+ (and (null item) item-at
+ (setq item (get-text-property (1- item-at) 'item)))
+ (and (null action) action-at
+ (setq action (get-text-property action-at 'action)))
+ (if (not (and item action))
+ (error "There is nothing to follow here"))
+ (if (consp item) (error "There is nothing to follow in `%s'" (car item)))
+ (if other (set-buffer other))
+ (funcall action item)))
(if apropos-symbol-face
(put-text-property 8 (- (point) 14) 'face apropos-symbol-face))
(insert (apropos-format-plist symbol "\n "))
- (princ ")")))
+ (princ ")")
+ (print-help-return-message)))
+
+(provide 'apropos)
;;; apropos.el ends here