(defvar electric-help-map ()
"Keymap defining commands available in `electric-help-mode'.")
+(defvar electric-help-form-to-execute nil)
+
(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)
)
(let ((one (one-window-p t))
(config (current-window-configuration))
(bury nil)
- (to-be-executed nil))
+ (electric-help-form-to-execute nil))
(unwind-protect
(save-excursion
(if one (goto-char (window-start (selected-window))))
(if (and minheight (< (window-height) minheight))
(enlarge-window (- minheight (window-height))))
(electric-help-mode)
- (or noerase (erase-buffer)))
+ (setq buffer-read-only nil)
+ (or noerase
+ (erase-buffer)))
(let ((standard-output buffer))
(if (not (funcall thunk))
(progn
(if one (shrink-window-if-larger-than-buffer (selected-window))))))
(set-buffer buffer)
(run-hooks 'electric-help-mode-hook)
+ (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.
+ (if (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)
(replace-buffer-in-windows buffer)
;; must do this outside of save-window-excursion
(bury-buffer buffer)))
- (eval to-be-executed))))
+ (eval electric-help-form-to-execute))))
(defun electric-help-command-loop ()
(catch 'exit
(if (pos-visible-in-window-p (point-max))
- (progn (message (substitute-command-keys "<<< Press Space to bury the help buffer, Press \\[electric-help-retain] to retain it >>>"))
+ (progn (message "%s" (substitute-command-keys "<<< Press Space to bury the help buffer, Press \\[electric-help-retain] to retain it >>>"))
(if (equal (setq unread-command-events (list (read-event)))
'(?\ ))
(progn (setq unread-command-events nil)
; (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))
;; continues with execute-extended-command.
(defun electric-help-execute-extended (prefixarg)
(interactive "p")
- (setq to-be-executed '(execute-extended-command nil))
+ (setq electric-help-form-to-execute '(execute-extended-command nil))
(electric-help-retain))
;; This is to be buond to C-x in ehelp mode. Retains ehelp buffer and then
;; continues with ctrl-x prefix.
(defun electric-help-ctrl-x-prefix (prefixarg)
(interactive "p")
- (setq to-be-executed '(progn (message nil) (setq unread-command-char ?\C-x)))
+ (setq electric-help-form-to-execute '(progn (message nil) (setq unread-command-char ?\C-x)))
(electric-help-retain))
\f
(defun electric-command-apropos ()
(interactive)
- (electric-helpify 'command-apropos))
+ (electric-helpify 'command-apropos "*Apropos*"))
;(define-key help-map "a" 'electric-command-apropos)