;;; ehelp.el --- bindings for electric-help mode
-;; Copyright (C) 1986, 1995 Free Software Foundation, Inc.
+;; Copyright (C) 1986, 1995, 2000, 2001 Free Software Foundation, Inc.
;; Maintainer: FSF
;; Keywords: help, extensions
(defvar electric-help-form-to-execute nil)
+(defgroup electric-help ()
+ "Electric help facility."
+ :version "21.1"
+ :group 'help)
+
+(defcustom electric-help-shrink-window t
+ "If set, adjust help window sizes to buffer sizes when displaying help."
+ :type 'boolean
+ :group 'electric-help)
+
+(defcustom electric-help-mode-hook nil
+ "Hook run by `with-electric-help' after initializing the buffer."
+ :type 'hook
+ :group 'electric-help)
+
(put 'electric-help-undefined 'suppress-keymap t)
(if electric-help-map
()
(setq major-mode 'help)
(setq mode-line-buffer-identification '(" Help: %b"))
(use-local-map electric-help-map)
- (setq mouse-leave-buffer-hook '(electric-help-retain))
+ (add-hook 'mouse-leave-buffer-hook 'electric-help-retain)
(view-mode -1)
;; this is done below in with-electric-help
;(run-hooks 'electric-help-mode-hook)
this value is non-nil.
If THUNK returns nil, we display BUFFER starting at the top, and
-shrink the window to fit. If THUNK returns non-nil, we don't do those
-things.
+shrink the window to fit if `electric-help-shrink-window' is non-nil.
+If THUNK returns non-nil, we don't do those things.
-When the user exits (with `electric-help-exit', or otherwise) the help
-buffer's window disappears (i.e., we use `save-window-excursion')
+When the user exits (with `electric-help-exit', or otherwise), the help
+buffer's window disappears (i.e., we use `save-window-excursion'), and
BUFFER is put into `default-major-mode' (or `fundamental-mode') when we exit."
(setq buffer (get-buffer-create (or buffer "*Help*")))
(let ((one (one-window-p t))
(electric-help-form-to-execute nil))
(unwind-protect
(save-excursion
- (if one (goto-char (window-start (selected-window))))
+ (when one
+ (goto-char (window-start (selected-window))))
(let ((pop-up-windows t))
(pop-to-buffer buffer))
(save-excursion
(set-buffer buffer)
- (if (and minheight (< (window-height) minheight))
- (enlarge-window (- minheight (window-height))))
+ (when (and minheight (< (window-height) minheight))
+ (enlarge-window (- minheight (window-height))))
(electric-help-mode)
- (or noerase
- (let ((inhibit-read-only t))
- (erase-buffer))))
+ (setq buffer-read-only nil)
+ (unless noerase
+ (erase-buffer)))
(let ((standard-output buffer))
- (if (not (funcall thunk))
- (progn
- (set-buffer buffer)
- (set-buffer-modified-p nil)
- (goto-char (point-min))
- (if one (shrink-window-if-larger-than-buffer (selected-window))))))
+ (unless (funcall thunk)
+ (set-buffer buffer)
+ (set-buffer-modified-p nil)
+ (goto-char (point-min))
+ (when (and one electric-help-shrink-window)
+ (shrink-window-if-larger-than-buffer))))
(set-buffer buffer)
(run-hooks 'electric-help-mode-hook)
- (if (eq (car-safe (electric-help-command-loop))
- 'retain)
+ (setq buffer-read-only t)
+ (if (eq (car-safe (electric-help-command-loop)) 'retain)
(setq config (current-window-configuration))
- (setq bury t)))
+ (setq bury t))
+ ;; Remove the hook.
+ (when (memq 'electric-help-retain mouse-leave-buffer-hook)
+ (remove-hook 'mouse-leave-buffer-hook 'electric-help-retain)))
(message "")
(set-buffer buffer)
(setq buffer-read-only nil)
+
+ ;; We should really get a usable *Help* buffer when retaining
+ ;; the electric one with `r'. The problem is that a simple
+ ;; call to help-mode won't cut it; at least RET is bound wrong
+ ;; afterwards. It's also not clear that `help-mode' is always
+ ;; the right thing, maybe we should add an optional parameter.
(condition-case ()
(funcall (or default-major-mode 'fundamental-mode))
(error nil))
+
(set-window-configuration config)
- (if bury
- (progn
- ;;>> Perhaps this shouldn't be done.
- ;; so that when we say "Press space to bury" we mean it
- (replace-buffer-in-windows buffer)
- ;; must do this outside of save-window-excursion
- (bury-buffer buffer)))
+ (when bury
+ ;;>> Perhaps this shouldn't be done,
+ ;; so that when we say "Press space to bury" we mean it
+ (replace-buffer-in-windows buffer)
+ ;; must do this outside of save-window-excursion
+ (bury-buffer buffer))
(eval electric-help-form-to-execute))))
(defun electric-help-command-loop ()
; (scroll-up arg)))
(defun electric-help-exit ()
- ">>>Doc"
+ "Exit `electric-help', restoring the previous window/buffer configuration.
+\(The *Help* buffer will be buried.)"
(interactive)
- (throw 'exit t))
+ ;; Make sure that we don't throw twice, even if two events cause
+ ;; calling this function:
+ (if (memq 'electric-help-retain mouse-leave-buffer-hook)
+ (progn
+ (remove-hook 'mouse-leave-buffer-hook 'electric-help-retain)
+ (throw 'exit t))))
(defun electric-help-retain ()
"Exit `electric-help', retaining the current window/buffer configuration.
(interactive)
;; Make sure that we don't throw twice, even if two events cause
;; calling this function:
- (if mouse-leave-buffer-hook
- (progn
- (setq mouse-leave-buffer-hook nil)
- (throw 'exit '(retain)))))
+ (if (memq 'electric-help-retain mouse-leave-buffer-hook)
+ (progn
+ (remove-hook 'mouse-leave-buffer-hook 'electric-help-retain)
+ (throw 'exit '(retain)))))
(defun electric-help-undefined ()
\f
;;;###autoload
-(defun electric-helpify (fun)
- (let ((name "*Help*"))
+(defun electric-helpify (fun &optional name)
+ (let ((name (or name "*Help*")))
(if (save-window-excursion
;; kludge-o-rama
(let* ((p (symbol-function 'print-help-return-message))
(defun electric-command-apropos ()
(interactive)
- (electric-helpify 'command-apropos))
+ (electric-helpify 'command-apropos "*Apropos*"))
;(define-key help-map "a" 'electric-command-apropos)