X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/d189e346891ee0e050e6a406ca64dabcee7e9a2e..efa434d9f2720aa71fbc67fed5897a2f16943fde:/lisp/help-macro.el diff --git a/lisp/help-macro.el b/lisp/help-macro.el index 2e1f88f0a4..366466142d 100644 --- a/lisp/help-macro.el +++ b/lisp/help-macro.el @@ -1,12 +1,11 @@ ;;; help-macro.el --- Makes command line help such as help-for-help -;; Copyright (C) 1993 Free Software Foundation, Inc. +;; Copyright (C) 1993, 1994 Free Software Foundation, Inc. ;; Author: Lynn Slater +;; Maintainer: FSF ;; Created: : Mon Oct 1 11:42:39 1990 ;; Adapted-By: ESR -;; Last Modified By: Lynn Slater x2048 -;; Last Modified On: Mon Sep 23 14:40:19 1991 ;; This file is part of GNU Emacs. @@ -21,12 +20,13 @@ ;; 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: -;; -;; This file supplies the macro make-help-screen which constructs + +;; This file supplies the macro make-help-screen which constructs ;; single character dispatching with browsable help such as that provided ;; by help-for-help. This can be used to make many modes easier to use; for ;; example, the Gnu Emacs Empire Tool uses this for every "nested" mode map @@ -82,7 +82,7 @@ A value of nil means skip the middle step, so that (defmacro make-help-screen (fname help-line help-text helped-map) "Construct help-menu function name FNAME. When invoked, FNAME shows HELP-LINE and reads a command using HELPED-MAP. -If the command is the help character is requested, FNAME displays HELP-TEXT +If the command is the help character, FNAME displays HELP-TEXT and continues trying to read a command using HELPED-MAP. When FNAME finally does get a command, it executes that command and then returns." @@ -92,61 +92,94 @@ and then returns." (let ((line-prompt (substitute-command-keys (, help-line)))) (if three-step-help - (message line-prompt)) - (let* ((overriding-local-map (make-sparse-keymap)) + (message "%s" line-prompt)) + (let* ((help-screen (documentation (quote (, fname)))) + ;; We bind overriding-local-map for very small + ;; sections, *excluding* where we switch buffers + ;; and where we execute the chosen help command. + (local-map (make-sparse-keymap)) (minor-mode-map-alist nil) - config key char help-screen) + (prev-frame (selected-frame)) + config new-frame key char) (unwind-protect (progn - (setcdr overriding-local-map (, helped-map)) - (define-key overriding-local-map [t] 'undefined) - (setq help-screen (documentation (quote (, fname)))) + (setcdr local-map (, helped-map)) + (define-key local-map [t] 'undefined) + ;; Make the scroll bar keep working normally. + (define-key local-map [vertical-scroll-bar] + (lookup-key global-map [vertical-scroll-bar])) (if three-step-help - (setq key (read-key-sequence nil) - char (aref key 0)) + (progn + (setq key (let ((overriding-local-map local-map)) + (read-key-sequence nil))) + ;; Make the HELP key translate to C-h. + (if (lookup-key function-key-map key) + (setq key (lookup-key function-key-map key))) + (setq char (aref key 0))) (setq char ??)) - (if (or (eq char ??) (eq char help-char)) + (if (or (eq char ??) (eq char help-char) + (memq char help-event-list)) (progn (setq config (current-window-configuration)) (switch-to-buffer-other-window "*Help*") + (and (fboundp 'make-frame) + (not (eq (window-frame (selected-window)) + prev-frame)) + (setq new-frame (window-frame (selected-window)) + config nil)) + (setq buffer-read-only nil) (erase-buffer) (insert help-screen) + (help-mode) (goto-char (point-min)) - (while (or (memq char (cons help-char '(?? ?\C-v ?\ ?\177 delete ?\M-v))) + (while (or (memq char (append help-event-list + (cons help-char '(?? ?\C-v ?\ ?\177 delete backspace vertical-scroll-bar ?\M-v)))) + (eq (car-safe char) 'switch-frame) (equal key "\M-v")) - (setq list (cons key list)) (condition-case nil (progn + (if (eq (car-safe char) 'switch-frame) + (handle-switch-frame char)) (if (memq char '(?\C-v ?\ )) (scroll-up)) - (if (or (memq char '(?\177 ?\M-v delete)) + (if (or (memq char '(?\177 ?\M-v + delete backspace)) (equal key "\M-v")) (scroll-down))) (error nil)) - (let ((cursor-in-echo-area t)) + (let ((cursor-in-echo-area t) + (overriding-local-map local-map)) (setq key (read-key-sequence (format "Type one of the options listed%s: " (if (pos-visible-in-window-p (point-max)) - "" " or Space to scroll"))) - char (aref key 0)))) - (setq list (cons key list)))) + "" ", or SPACE or DEL to scroll"))) + char (aref key 0))) + + ;; If this is a scroll bar command, just run it. + (when (eq char 'vertical-scroll-bar) + (command-execute (lookup-key local-map key) nil key))))) + ;; We don't need the prompt any more. + (message "") ;; Mouse clicks are not part of the help feature, ;; so reexecute them in the standard environment. (if (listp char) (setq unread-command-events (cons char unread-command-events) config nil) - (let ((defn (key-binding key))) + (let ((defn (lookup-key local-map key))) (if defn (progn (if config (progn (set-window-configuration config) (setq config nil))) - (setq overriding-local-map nil) + (if new-frame + (progn (iconify-frame new-frame) + (setq new-frame nil))) (call-interactively defn)) (ding))))) + (if new-frame (iconify-frame new-frame)) (if config (set-window-configuration config)))))) ))