(x_display_and_set_cursor): Set phys_cursor_width to

[bpt/emacs.git] / lisp / help-macro.el

diff --git a/lisp/help-macro.el b/lisp/help-macro.el
index 3664661..19add58 100644 (file)
--- a/lisp/help-macro.el
+++ b/lisp/help-macro.el
@@ -1,10 +1,10 @@
-;;; help-macro.el --- Makes command line help such as help-for-help
+;;; help-macro.el --- makes command line help such as help-for-help
 
 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
 
 ;; Author: Lynn Slater <lrs@indetech.com>
 ;; Maintainer: FSF
-;; Created: : Mon Oct  1 11:42:39 1990
+;; Created: Mon Oct  1 11:42:39 1990
 ;; Adapted-By: ESR
 
 ;; This file is part of GNU Emacs.
@@ -29,7 +29,7 @@
 ;; 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
+;; example, the GNU Emacs Empire Tool uses this for every "nested" mode map
 ;; called from the main mode map.
 
 ;;       The name of this package was changed from help-screen.el to
@@ -44,7 +44,7 @@
 ;;->
 ;;->c  Redistribute civs from overfull sectors into connected underfull ones
 ;;->     The functions typically named by empire-ideal-civ-fcn control
-;;->          based in part on empire-sector-civ-threshold  
+;;->          based in part on empire-sector-civ-threshold
 ;;->m  Redistribute military using levels given by empire-ideal-mil-fcn
 ;;->p  Redistribute excess population to highways for max pop growth
 ;;->     Excess is any sector so full babies will not be born.
@@ -62,38 +62,44 @@
 
 ;;; Change Log:
 ;;
-;; 22-Jan-1991         Lynn Slater x2048       
+;; 22-Jan-1991         Lynn Slater x2048
 ;;    Last Modified: Mon Oct  1 11:43:52 1990 #3 (Lynn Slater)
 ;;    documented better
 
 ;;; Code:
 
-(provide 'help-macro)
 (require 'backquote)
 
 ;;;###autoload
-(defvar three-step-help nil
+(defcustom three-step-help nil
   "*Non-nil means give more info about Help command in three steps.
 The three steps are simple prompt, prompt with all options,
 and window listing and describing the options.
 A value of nil means skip the middle step, so that
-\\[help-command] \\[help-command] gives the window that lists the options.")
+\\[help-command] \\[help-command] gives the window that lists the options."
+  :type 'boolean
+  :group 'help)
 
 (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, FNAME displays HELP-TEXT
 and continues trying to read a command using HELPED-MAP.
+If HELP-TEXT contains the sequence `%THIS-KEY%', that is replaced
+with the key sequence that invoked FNAME.
 When FNAME finally does get a command, it executes that command
 and then returns."
-  (` (defun (, fname) ()
-          (, help-text)
+ (let ((doc-fn (intern (concat (symbol-name fname) "-doc"))))
+  `(progn
+    (defun ,doc-fn () ,help-text)
+    (defun ,fname ()
+          "Help command."
           (interactive)
           (let ((line-prompt
-                 (substitute-command-keys (, help-line))))
+                 (substitute-command-keys ,help-line)))
             (if three-step-help
                 (message "%s" line-prompt))
-            (let* ((help-screen (documentation (quote (, fname))))
+            (let* ((help-screen (documentation (quote ,doc-fn)))
                    ;; We bind overriding-local-map for very small
                    ;; sections, *excluding* where we switch buffers
                    ;; and where we execute the chosen help command.
@@ -101,9 +107,13 @@ and then returns."
                    (minor-mode-map-alist nil)
                    (prev-frame (selected-frame))
                    config new-frame key char)
+              (if (string-match "%THIS-KEY%" help-screen)
+                  (setq help-screen
+                        (replace-match (key-description (substring (this-command-keys) 0 -1))
+                                       t t help-screen)))
               (unwind-protect
                   (progn
-                    (setcdr local-map (, helped-map))
+                    (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]
@@ -182,7 +192,8 @@ and then returns."
                 (if new-frame (iconify-frame new-frame))
                 (if config
                     (set-window-configuration config))))))
-     ))
+     )))
 
-;;; help-macro.el
+(provide 'help-macro)
 
+;;; help-macro.el ends here