annotate lisp/help-macro.el @ 109313:e856a274549b

Constify functions taking char * * alloc.c (pending_malloc_warning, malloc_warning): Add const. * callproc.c (relocate_fd, getenv_internal_1, getenv_internal) (egetenv): Likewise. * doprnt.c (doprnt): Likewise. * editfns.c (set_time_zone_rule, format2): Likewise. * emacs.c (decode_env_path): Likewise. * eval.c (signal_error, error): Likewise. * insdel.c (replace_range_2): Likewise. * keyboard.c (cmd_error_internal): Likewise. * lread.c (isfloat_string, make_symbol, dir_warning): Likewise. * print.c (write_string, write_string_1, print_error_message): Likewise. * vm-limit.c (warn_function, memory_warnings): Likewise. * xdisp.c (message1, message1_nolog, message_with_string) (vmessage, message, message_nolog): Likewise. * emacs.c: Remove duplicate declaration. * keyboard.h: Likewise. * lisp.h: Update prototypes.
author Andreas Schwab <schwab@linux-m68k.org>
date Sun, 11 Jul 2010 11:27:13 +0200
parents 1d1d5d9bd884
children 280c8ae2476d 376148b31b5e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38412
253f761ad37b Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents: 25298
diff changeset
1 ;;; help-macro.el --- makes command line help such as help-for-help
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
2
74442
b2e5081b9320 Update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 74229
diff changeset
3 ;; Copyright (C) 1993, 1994, 2001, 2002, 2003, 2004,
106815
1d1d5d9bd884 Add 2010 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 105216
diff changeset
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
5
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
6 ;; Author: Lynn Slater <lrs@indetech.com>
17976
852464ce5d6a Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 14316
diff changeset
7 ;; Maintainer: FSF
38412
253f761ad37b Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents: 25298
diff changeset
8 ;; Created: Mon Oct 1 11:42:39 1990
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
9 ;; Adapted-By: ESR
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
10
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
11 ;; This file is part of GNU Emacs.
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
12
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
14 ;; it under the terms of the GNU General Public License as published by
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
15 ;; the Free Software Foundation, either version 3 of the License, or
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
16 ;; (at your option) any later version.
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
17
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
18 ;; GNU Emacs is distributed in the hope that it will be useful,
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
21 ;; GNU General Public License for more details.
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
22
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
23 ;; You should have received a copy of the GNU General Public License
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
25
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
26 ;;; Commentary:
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 12423
diff changeset
27
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 12423
diff changeset
28 ;; This file supplies the macro make-help-screen which constructs
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
29 ;; single character dispatching with browsable help such as that provided
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
30 ;; by help-for-help. This can be used to make many modes easier to use; for
38412
253f761ad37b Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents: 25298
diff changeset
31 ;; example, the GNU Emacs Empire Tool uses this for every "nested" mode map
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
32 ;; called from the main mode map.
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
33
2530
1e1a30d5d523 Name changed to fit in a 14-character limit.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2456
diff changeset
34 ;; The name of this package was changed from help-screen.el to
1e1a30d5d523 Name changed to fit in a 14-character limit.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2456
diff changeset
35 ;; help-macro.el in order to fit in a 14-character limit.
1e1a30d5d523 Name changed to fit in a 14-character limit.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2456
diff changeset
36
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
37 ;;-> *********************** Example of use *********************************
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
38
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
39 ;;->(make-help-screen help-for-empire-redistribute-map
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
40 ;;-> "c:civ m:mil p:population f:food ?"
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
41 ;;-> "You have discovered the GEET redistribution commands
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
42 ;;-> From here, you can use the following options:
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
43 ;;->
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
44 ;;->c Redistribute civs from overfull sectors into connected underfull ones
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
45 ;;-> The functions typically named by empire-ideal-civ-fcn control
25298
866b59632531 Move provide to end.
Dave Love <fx@gnu.org>
parents: 23331
diff changeset
46 ;;-> based in part on empire-sector-civ-threshold
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
47 ;;->m Redistribute military using levels given by empire-ideal-mil-fcn
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
48 ;;->p Redistribute excess population to highways for max pop growth
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
49 ;;-> Excess is any sector so full babies will not be born.
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
50 ;;->f Even out food on highways to highway min and leave levels
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
51 ;;-> This is good to pump max food to all warehouses/dist pts
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
52 ;;->
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
53 ;;->
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
54 ;;->Use \\[help-for-empire-redistribute-map] for help on redistribution.
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
55 ;;->Use \\[help-for-empire-extract-map] for help on data extraction.
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
56 ;;->Please use \\[describe-key] to find out more about any of the other keys."
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
57 ;;-> empire-shell-redistribute-map)
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
58
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
59 ;;-> (define-key c-mp "\C-h" 'help-for-empire-redistribute-map)
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
60 ;;-> (define-key c-mp help-character 'help-for-empire-redistribute-map)
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
61
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
62 ;;; Change Log:
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
63 ;;
25298
866b59632531 Move provide to end.
Dave Love <fx@gnu.org>
parents: 23331
diff changeset
64 ;; 22-Jan-1991 Lynn Slater x2048
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
65 ;; Last Modified: Mon Oct 1 11:43:52 1990 #3 (Lynn Slater)
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
66 ;; documented better
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
67
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
68 ;;; Code:
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
69
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
70 (require 'backquote)
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
71
5679
90ba98c692b5 (three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents: 5640
diff changeset
72 ;;;###autoload
25298
866b59632531 Move provide to end.
Dave Love <fx@gnu.org>
parents: 23331
diff changeset
73 (defcustom three-step-help nil
99664
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
74 "Non-nil means give more info about Help command in three steps.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
75 The three steps are simple prompt, prompt with all options, and
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
76 window listing and describing the options.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
77 A value of nil means skip the middle step, so that \\[help-command] \\[help-command]
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
78 gives the window that lists the options."
25298
866b59632531 Move provide to end.
Dave Love <fx@gnu.org>
parents: 23331
diff changeset
79 :type 'boolean
866b59632531 Move provide to end.
Dave Love <fx@gnu.org>
parents: 23331
diff changeset
80 :group 'help)
5679
90ba98c692b5 (three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents: 5640
diff changeset
81
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
82 (defmacro make-help-screen (fname help-line help-text helped-map)
5378
32a291ab0c5f (make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents: 3128
diff changeset
83 "Construct help-menu function name FNAME.
32a291ab0c5f (make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents: 3128
diff changeset
84 When invoked, FNAME shows HELP-LINE and reads a command using HELPED-MAP.
8709
258aaa4b66ed (make-help-screen): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 8661
diff changeset
85 If the command is the help character, FNAME displays HELP-TEXT
5378
32a291ab0c5f (make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents: 3128
diff changeset
86 and continues trying to read a command using HELPED-MAP.
23331
8e860ff326de (make-help-screen): Keep HELP-TEXT
Richard M. Stallman <rms@gnu.org>
parents: 21120
diff changeset
87 If HELP-TEXT contains the sequence `%THIS-KEY%', that is replaced
8e860ff326de (make-help-screen): Keep HELP-TEXT
Richard M. Stallman <rms@gnu.org>
parents: 21120
diff changeset
88 with the key sequence that invoked FNAME.
5378
32a291ab0c5f (make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents: 3128
diff changeset
89 When FNAME finally does get a command, it executes that command
32a291ab0c5f (make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents: 3128
diff changeset
90 and then returns."
99664
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
91 (let ((doc-fn (intern (concat (symbol-name fname) "-doc"))))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
92 `(progn
105216
fb7e59394e9b * help.el (help-for-help-internal): Don't purecopy the text (bug#4560).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 100908
diff changeset
93 (defun ,doc-fn () ,help-text nil)
99664
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
94 (defun ,fname ()
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
95 "Help command."
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
96 (interactive)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
97 (let ((line-prompt
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
98 (substitute-command-keys ,help-line)))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
99 (when three-step-help
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
100 (message "%s" line-prompt))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
101 (let* ((help-screen (documentation (quote ,doc-fn)))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
102 ;; We bind overriding-local-map for very small
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
103 ;; sections, *excluding* where we switch buffers
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
104 ;; and where we execute the chosen help command.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
105 (local-map (make-sparse-keymap))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
106 (new-minor-mode-map-alist minor-mode-map-alist)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
107 (prev-frame (selected-frame))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
108 config new-frame key char)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
109 (when (string-match "%THIS-KEY%" help-screen)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
110 (setq help-screen
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
111 (replace-match (key-description
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
112 (substring (this-command-keys) 0 -1))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
113 t t help-screen)))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
114 (unwind-protect
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
115 (let ((minor-mode-map-alist nil))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
116 (setcdr local-map ,helped-map)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
117 (define-key local-map [t] 'undefined)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
118 ;; Make the scroll bar keep working normally.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
119 (define-key local-map [vertical-scroll-bar]
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
120 (lookup-key global-map [vertical-scroll-bar]))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
121 (if three-step-help
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
122 (progn
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
123 (setq key (let ((overriding-local-map local-map))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
124 (read-key-sequence nil)))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
125 ;; Make the HELP key translate to C-h.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
126 (if (lookup-key function-key-map key)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
127 (setq key (lookup-key function-key-map key)))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
128 (setq char (aref key 0)))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
129 (setq char ??))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
130 (when (or (eq char ??) (eq char help-char)
12423
ee433b44920d (make-help-screen): Handle help-event-list.
Richard M. Stallman <rms@gnu.org>
parents: 11424
diff changeset
131 (memq char help-event-list))
99664
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
132 (setq config (current-window-configuration))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
133 (switch-to-buffer-other-window "*Help*")
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
134 (and (fboundp 'make-frame)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
135 (not (eq (window-frame (selected-window))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
136 prev-frame))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
137 (setq new-frame (window-frame (selected-window))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
138 config nil))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
139 (setq buffer-read-only nil)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
140 (let ((inhibit-read-only t))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
141 (erase-buffer)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
142 (insert help-screen))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
143 (let ((minor-mode-map-alist new-minor-mode-map-alist))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
144 (help-mode)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
145 (setq new-minor-mode-map-alist minor-mode-map-alist))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
146 (goto-char (point-min))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
147 (while (or (memq char (append help-event-list
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
148 (cons help-char '(?? ?\C-v ?\s ?\177 delete backspace vertical-scroll-bar ?\M-v))))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
149 (eq (car-safe char) 'switch-frame)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
150 (equal key "\M-v"))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
151 (condition-case nil
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
152 (cond
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
153 ((eq (car-safe char) 'switch-frame)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
154 (handle-switch-frame char))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
155 ((memq char '(?\C-v ?\s))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
156 (scroll-up))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
157 ((or (memq char '(?\177 ?\M-v delete backspace))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
158 (equal key "\M-v"))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
159 (scroll-down)))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
160 (error nil))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
161 (let ((cursor-in-echo-area t)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
162 (overriding-local-map local-map))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
163 (setq key (read-key-sequence
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
164 (format "Type one of the options listed%s: "
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
165 (if (pos-visible-in-window-p
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
166 (point-max))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
167 "" ", or SPACE or DEL to scroll")))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
168 char (aref key 0)))
20029
857e1ce3f14b (make-help-screen): Make scroll bar work normally.
Richard M. Stallman <rms@gnu.org>
parents: 18656
diff changeset
169
99664
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
170 ;; If this is a scroll bar command, just run it.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
171 (when (eq char 'vertical-scroll-bar)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
172 (command-execute (lookup-key local-map key) nil key))))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
173 ;; We don't need the prompt any more.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
174 (message "")
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
175 ;; Mouse clicks are not part of the help feature,
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
176 ;; so reexecute them in the standard environment.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
177 (if (listp char)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
178 (setq unread-command-events
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
179 (cons char unread-command-events)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
180 config nil)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
181 (let ((defn (lookup-key local-map key)))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
182 (if defn
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
183 (progn
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
184 (when config
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
185 (set-window-configuration config)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
186 (setq config nil))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
187 ;; `defn' must make sure that its frame is
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
188 ;; selected, so we won't iconify it below.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
189 (call-interactively defn)
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
190 (when new-frame
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
191 ;; Do not iconify the selected frame.
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
192 (unless (eq new-frame (selected-frame))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
193 (iconify-frame new-frame))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
194 (setq new-frame nil)))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
195 (ding)))))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
196 (when config
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
197 (set-window-configuration config))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
198 (when new-frame
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
199 (iconify-frame new-frame))
77d381812b04 (three-step-help): Remove * from defcustom.
Martin Rudalics <rudalics@gmx.at>
parents: 98216
diff changeset
200 (setq minor-mode-map-alist new-minor-mode-map-alist))))))))
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
201
25298
866b59632531 Move provide to end.
Dave Love <fx@gnu.org>
parents: 23331
diff changeset
202 (provide 'help-macro)
2456
39a58fdf2dee Initial revision
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
diff changeset
203
93975
1e3a407766b9 Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 79721
diff changeset
204 ;; arch-tag: 59fee949-1686-485a-8a05-83418073e257
25298
866b59632531 Move provide to end.
Dave Love <fx@gnu.org>
parents: 23331
diff changeset
205 ;;; help-macro.el ends here