annotate lisp/ehelp.el @ 95370:fafc513e04bc

(tar-summarize-buffer): Fix reporter initialization. (tar-mode): Use write-region-annotate-functions rather than write-contents-functions. (tar-extract): Remove unused var `pos'. (tar-subfile-save-buffer): Remove unused var `following-descs'. (tar-mode-write-file): Remove. (tar-write-region-annotate): New function.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Wed, 28 May 2008 17:43:58 +0000
parents ee5932bf781d
children f5057049058b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
662
8a533acedb77 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 584
diff changeset
1 ;;; ehelp.el --- bindings for electric-help mode
8a533acedb77 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 584
diff changeset
2
64762
41bb365f41c4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64091
diff changeset
3 ;; Copyright (C) 1986, 1995, 2000, 2001, 2002, 2003, 2004,
79721
73661ddc7ac7 Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78236
diff changeset
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
846
20674ae6bf52 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 811
diff changeset
5
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
6 ;; Maintainer: FSF
811
e694e0879463 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 807
diff changeset
7 ;; Keywords: help, extensions
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
8
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
10
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
12 ;; 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
13 ;; 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
14 ;; (at your option) any later version.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
15
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
20
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
21 ;; 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
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
23
2307
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
24 ;;; Commentary:
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
25
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
26 ;; This package provides a pre-packaged `Electric Help Mode' for
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
27 ;; browsing on-line help screens. There is one entry point,
12601
ca43eab4d2a6 (electric-helpify): Autoload with-electric-help, electric-helpify.
Richard M. Stallman <rms@gnu.org>
parents: 11234
diff changeset
28 ;; `with-electric-help'; all you have to give it is a no-argument
4479
9fab557f1e16 Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 3440
diff changeset
29 ;; function that generates the actual text of the help into the current
2307
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
30 ;; buffer.
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
31
12721
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
32 ;; To make this the default, you must do
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
33 ;; (require 'ehelp)
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
34 ;; (define-key global-map "\C-h" 'ehelp-command)
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
35 ;; (define-key global-map [help] 'ehelp-command)
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
36 ;; (define-key global-map [f1] 'ehelp-command)
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
37
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
38 ;;; Code:
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
39
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
40 (require 'electric)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
41 (defvar electric-help-map ()
200
74504bd76aaa *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 160
diff changeset
42 "Keymap defining commands available in `electric-help-mode'.")
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
43
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
44 (defvar electric-help-form-to-execute nil)
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
45
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
46 (defgroup electric-help ()
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
47 "Electric help facility."
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
48 :version "21.1"
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
49 :group 'help)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
50
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
51 (defcustom electric-help-shrink-window t
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
52 "If set, adjust help window sizes to buffer sizes when displaying help."
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
53 :type 'boolean
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
54 :group 'electric-help)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
55
36892
ca2938d86ae9 (electric-help-mode-hook): Add defcustom.
Gerd Moellmann <gerd@gnu.org>
parents: 36240
diff changeset
56 (defcustom electric-help-mode-hook nil
ca2938d86ae9 (electric-help-mode-hook): Add defcustom.
Gerd Moellmann <gerd@gnu.org>
parents: 36240
diff changeset
57 "Hook run by `with-electric-help' after initializing the buffer."
ca2938d86ae9 (electric-help-mode-hook): Add defcustom.
Gerd Moellmann <gerd@gnu.org>
parents: 36240
diff changeset
58 :type 'hook
ca2938d86ae9 (electric-help-mode-hook): Add defcustom.
Gerd Moellmann <gerd@gnu.org>
parents: 36240
diff changeset
59 :group 'electric-help)
ca2938d86ae9 (electric-help-mode-hook): Add defcustom.
Gerd Moellmann <gerd@gnu.org>
parents: 36240
diff changeset
60
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
61 (put 'electric-help-undefined 'suppress-keymap t)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
62 (if electric-help-map
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
63 ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
64 (let ((map (make-keymap)))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
65 ;; allow all non-self-inserting keys - search, scroll, etc, but
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
66 ;; let M-x and C-x exit ehelp mode and retain buffer:
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
67 (suppress-keymap map)
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
68 (define-key map "\C-u" 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
69 (define-key map [?\C-0] 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
70 (define-key map [?\C-1] 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
71 (define-key map [?\C-2] 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
72 (define-key map [?\C-3] 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
73 (define-key map [?\C-4] 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
74 (define-key map [?\C-5] 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
75 (define-key map [?\C-6] 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
76 (define-key map [?\C-7] 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
77 (define-key map [?\C-8] 'electric-help-undefined)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
78 (define-key map [?\C-9] 'electric-help-undefined)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
79 (define-key map (char-to-string help-char) 'electric-help-help)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
80 (define-key map "?" 'electric-help-help)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
81 (define-key map " " 'scroll-up)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
82 (define-key map "\^?" 'scroll-down)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
83 (define-key map "." 'beginning-of-buffer)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
84 (define-key map "<" 'beginning-of-buffer)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
85 (define-key map ">" 'end-of-buffer)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
86 ;(define-key map "\C-g" 'electric-help-exit)
57859
40f8936f0305 (electric-help-map): Reorder Q/q and R/r entries so
Kim F. Storm <storm@cua.dk>
parents: 55379
diff changeset
87 (define-key map "Q" 'electric-help-exit)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
88 (define-key map "q" 'electric-help-exit)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
89 ;;a better key than this?
57859
40f8936f0305 (electric-help-map): Reorder Q/q and R/r entries so
Kim F. Storm <storm@cua.dk>
parents: 55379
diff changeset
90 (define-key map "R" 'electric-help-retain)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
91 (define-key map "r" 'electric-help-retain)
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
92 (define-key map "\ex" 'electric-help-execute-extended)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
93 (define-key map "\C-x" 'electric-help-ctrl-x-prefix)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
94
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
95 (setq electric-help-map map)))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
96
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
97 (defun electric-help-mode ()
200
74504bd76aaa *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 160
diff changeset
98 "`with-electric-help' temporarily places its buffer in this mode.
74504bd76aaa *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 160
diff changeset
99 \(On exit from `with-electric-help', the buffer is put in `default-major-mode'.)"
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
100 (setq buffer-read-only t)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
101 (setq mode-name "Help")
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
102 (setq major-mode 'help)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
103 (setq mode-line-buffer-identification '(" Help: %b"))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
104 (use-local-map electric-help-map)
14943
2c44547d2364 (electric-help-mode): Use add-hook mouse-leave-buffer-hook.
Richard M. Stallman <rms@gnu.org>
parents: 14781
diff changeset
105 (add-hook 'mouse-leave-buffer-hook 'electric-help-retain)
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
106 (view-mode -1)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
107 ;; this is done below in with-electric-help
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
108 ;(run-hooks 'electric-help-mode-hook)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
109 )
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
110
12601
ca43eab4d2a6 (electric-helpify): Autoload with-electric-help, electric-helpify.
Richard M. Stallman <rms@gnu.org>
parents: 11234
diff changeset
111 ;;;###autoload
13381
0cbe99851fab (with-electric-help): Add missing argument MINHEIGHT.
Erik Naggum <erik@naggum.no>
parents: 13261
diff changeset
112 (defun with-electric-help (thunk &optional buffer noerase minheight)
12721
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
113 "Pop up an \"electric\" help buffer.
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
114 THUNK is a function of no arguments which is called to initialize the
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
115 contents of BUFFER. BUFFER defaults to `*Help*'. BUFFER will be
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
116 erased before THUNK is called unless NOERASE is non-nil. THUNK will
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
117 be called while BUFFER is current and with `standard-output' bound to
12721
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
118 the buffer specified by BUFFER.
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
119
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
120 If THUNK returns nil, we display BUFFER starting at the top, and
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
121 shrink the window to fit. If THUNK returns non-nil, we don't do those things.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
122
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
123 After THUNK has been called, this function \"electrically\" pops up a window
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
124 in which BUFFER is displayed and allows the user to scroll through that buffer
75839
e71b1d9b5c5e (with-electric-help, electric-help-exit, electric-help-retain): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents: 75347
diff changeset
125 in `electric-help-mode'. The window's height will be at least MINHEIGHT if
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
126 this value is non-nil.
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
127
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
128 If THUNK returns nil, we display BUFFER starting at the top, and
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
129 shrink the window to fit if `electric-help-shrink-window' is non-nil.
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
130 If THUNK returns non-nil, we don't do those things.
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
131
36240
5432010ffe02 (with-electric-help): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 31792
diff changeset
132 When the user exits (with `electric-help-exit', or otherwise), the help
5432010ffe02 (with-electric-help): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 31792
diff changeset
133 buffer's window disappears (i.e., we use `save-window-excursion'), and
75839
e71b1d9b5c5e (with-electric-help, electric-help-exit, electric-help-retain): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents: 75347
diff changeset
134 BUFFER is put into `default-major-mode' (or `fundamental-mode')."
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
135 (setq buffer (get-buffer-create (or buffer "*Help*")))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
136 (let ((one (one-window-p t))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
137 (config (current-window-configuration))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
138 (bury nil)
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
139 (electric-help-form-to-execute nil))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
140 (unwind-protect
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
141 (save-excursion
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
142 (when one
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
143 (goto-char (window-start (selected-window))))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
144 (let ((pop-up-windows t))
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
145 (pop-to-buffer buffer))
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
146 (save-excursion
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
147 (set-buffer buffer)
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
148 (when (and minheight (< (window-height) minheight))
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
149 (enlarge-window (- minheight (window-height))))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
150 (electric-help-mode)
14781
b4879ed5b5c3 (with-electric-help): Make buffer read-only as last thing.
Richard M. Stallman <rms@gnu.org>
parents: 14474
diff changeset
151 (setq buffer-read-only nil)
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
152 (unless noerase
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
153 (erase-buffer)))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
154 (let ((standard-output buffer))
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
155 (unless (funcall thunk)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
156 (set-buffer buffer)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
157 (set-buffer-modified-p nil)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
158 (goto-char (point-min))
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
159 (when (and one electric-help-shrink-window)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
160 (shrink-window-if-larger-than-buffer))))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
161 (set-buffer buffer)
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
162 (run-hooks 'electric-help-mode-hook)
14781
b4879ed5b5c3 (with-electric-help): Make buffer read-only as last thing.
Richard M. Stallman <rms@gnu.org>
parents: 14474
diff changeset
163 (setq buffer-read-only t)
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
164 (if (eq (car-safe (electric-help-command-loop)) 'retain)
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
165 (setq config (current-window-configuration))
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
166 (setq bury t))
17255
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
167 ;; Remove the hook.
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
168 (when (memq 'electric-help-retain mouse-leave-buffer-hook)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
169 (remove-hook 'mouse-leave-buffer-hook 'electric-help-retain)))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
170 (message "")
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
171 (set-buffer buffer)
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
172 (setq buffer-read-only nil)
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
173
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
174 ;; We should really get a usable *Help* buffer when retaining
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
175 ;; the electric one with `r'. The problem is that a simple
36240
5432010ffe02 (with-electric-help): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 31792
diff changeset
176 ;; call to help-mode won't cut it; at least RET is bound wrong
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
177 ;; afterwards. It's also not clear that `help-mode' is always
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
178 ;; the right thing, maybe we should add an optional parameter.
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
179 (condition-case ()
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
180 (funcall (or default-major-mode 'fundamental-mode))
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
181 (error nil))
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
182
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
183 (set-window-configuration config)
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
184 (when bury
36240
5432010ffe02 (with-electric-help): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 31792
diff changeset
185 ;;>> Perhaps this shouldn't be done,
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
186 ;; so that when we say "Press space to bury" we mean it
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
187 (replace-buffer-in-windows buffer)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
188 ;; must do this outside of save-window-excursion
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
189 (bury-buffer buffer))
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
190 (eval electric-help-form-to-execute))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
191
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
192 (defun electric-help-command-loop ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
193 (catch 'exit
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
194 (if (pos-visible-in-window-p (point-max))
14311
381c7a6d21f6 (electric-help-command-loop): Pass proper format string to message.
Karl Heuer <kwzh@gnu.org>
parents: 14169
diff changeset
195 (progn (message "%s" (substitute-command-keys "<<< Press Space to bury the help buffer, Press \\[electric-help-retain] to retain it >>>"))
3440
bccf04c8a5b6 (electric-help-command-loop): Use equal to compare
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
196 (if (equal (setq unread-command-events (list (read-event)))
74227
de93c5d7bb99 (electric-help-command-loop): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents: 68651
diff changeset
197 '(?\s))
1821
04fb1d3d6992 JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents: 1608
diff changeset
198 (progn (setq unread-command-events nil)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
199 (throw 'exit t)))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
200 (let (up down both neither
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
201 (standard (and (eq (key-binding " " nil t)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
202 'scroll-up)
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
203 (eq (key-binding "\^?" nil t)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
204 'scroll-down)
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
205 (eq (key-binding "q" nil t)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
206 'electric-help-exit)
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
207 (eq (key-binding "r" nil t)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
208 'electric-help-retain))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
209 (Electric-command-loop
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
210 'exit
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
211 (function (lambda ()
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
212 (sit-for 0) ;necessary if last command was end-of-buffer or
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
213 ;beginning-of-buffer - otherwise pos-visible-in-window-p
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
214 ;will yield a wrong result.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
215 (let ((min (pos-visible-in-window-p (point-min)))
55379
a5a7f792d532 (electric-help-command-loop): Check whether the last character is visible,
Juanma Barranquero <lekktu@gmail.com>
parents: 55347
diff changeset
216 (max (pos-visible-in-window-p (1- (point-max)))))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
217 (cond (isearch-mode 'noprompt)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
218 ((and min max)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
219 (cond (standard "Press q to exit, r to retain ")
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
220 (neither)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
221 (t (setq neither (substitute-command-keys "Press \\[electric-help-exit] to exit, \\[electric-help-retain] to retain ")))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
222 (min
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
223 (cond (standard "Press SPC to scroll, q to exit, r to retain ")
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
224 (up)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
225 (t (setq up (substitute-command-keys "Press \\[scroll-up] to scroll, \\[electric-help-exit] to exit, \\[electric-help-retain] to retain ")))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
226 (max
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
227 (cond (standard "Press DEL to scroll back, q to exit, r to retain ")
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
228 (down)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
229 (t (setq down (substitute-command-keys "Press \\[scroll-down] to scroll back, \\[electric-help-exit] to exit, \\[electric-help-retain] to retain ")))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
230 (t
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
231 (cond (standard "Press SPC to scroll, DEL to scroll back, q to exit, r to retain ")
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
232 (both)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
233 (t (setq both (substitute-command-keys "Press \\[scroll-up] to scroll, \\[scroll-down] to scroll back, \\[electric-help-exit] to exit, \\[electric-help-retain] to retain ")))))))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
234 t))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
235
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
236
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
237
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
238 ;(defun electric-help-scroll-up (arg)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
239 ; ">>>Doc"
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
240 ; (interactive "P")
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
241 ; (if (and (null arg) (pos-visible-in-window-p (point-max)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
242 ; (electric-help-exit)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
243 ; (scroll-up arg)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
244
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
245 (defun electric-help-exit ()
75839
e71b1d9b5c5e (with-electric-help, electric-help-exit, electric-help-retain): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents: 75347
diff changeset
246 "Exit `with-electric-help', restoring the previous window/buffer configuration.
17255
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
247 \(The *Help* buffer will be buried.)"
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
248 (interactive)
17255
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
249 ;; Make sure that we don't throw twice, even if two events cause
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
250 ;; calling this function:
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
251 (if (memq 'electric-help-retain mouse-leave-buffer-hook)
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
252 (progn
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
253 (remove-hook 'mouse-leave-buffer-hook 'electric-help-retain)
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
254 (throw 'exit t))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
255
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
256 (defun electric-help-retain ()
75839
e71b1d9b5c5e (with-electric-help, electric-help-exit, electric-help-retain): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents: 75347
diff changeset
257 "Exit `with-electric-help', retaining the current window/buffer configuration.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
258 \(The *Help* buffer will not be selected, but \\[switch-to-buffer-other-window] RET
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
259 will select it.)"
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
260 (interactive)
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
261 ;; Make sure that we don't throw twice, even if two events cause
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
262 ;; calling this function:
14943
2c44547d2364 (electric-help-mode): Use add-hook mouse-leave-buffer-hook.
Richard M. Stallman <rms@gnu.org>
parents: 14781
diff changeset
263 (if (memq 'electric-help-retain mouse-leave-buffer-hook)
2c44547d2364 (electric-help-mode): Use add-hook mouse-leave-buffer-hook.
Richard M. Stallman <rms@gnu.org>
parents: 14781
diff changeset
264 (progn
2c44547d2364 (electric-help-mode): Use add-hook mouse-leave-buffer-hook.
Richard M. Stallman <rms@gnu.org>
parents: 14781
diff changeset
265 (remove-hook 'mouse-leave-buffer-hook 'electric-help-retain)
2c44547d2364 (electric-help-mode): Use add-hook mouse-leave-buffer-hook.
Richard M. Stallman <rms@gnu.org>
parents: 14781
diff changeset
266 (throw 'exit '(retain)))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
267
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
268
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
269 (defun electric-help-undefined ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
270 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
271 (error "%s is undefined -- Press %s to exit"
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
272 (mapconcat 'single-key-description (this-command-keys) " ")
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
273 (if (eq (key-binding "q" nil t) 'electric-help-exit)
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
274 "q"
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
275 (substitute-command-keys "\\[electric-help-exit]"))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
276
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
277
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
278 ;>>> this needs to be hairified (recursive help, anybody?)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
279 (defun electric-help-help ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
280 (interactive)
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
281 (if (and (eq (key-binding "q" nil t) 'electric-help-exit)
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
282 (eq (key-binding " " nil t) 'scroll-up)
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
283 (eq (key-binding "\^?" nil t) 'scroll-down)
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
284 (eq (key-binding "r" nil t) 'electric-help-retain))
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
285 (message "SPC scrolls up, DEL scrolls down, q exits burying help buffer, r exits")
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
286 (message "%s" (substitute-command-keys "\\[scroll-up] scrolls up, \\[scroll-down] scrolls down, \\[electric-help-exit] exits burying help buffer, \\[electric-help-retain] exits")))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
287 (sit-for 2))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
288
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
289
12601
ca43eab4d2a6 (electric-helpify): Autoload with-electric-help, electric-helpify.
Richard M. Stallman <rms@gnu.org>
parents: 11234
diff changeset
290 ;;;###autoload
15310
f1e444468043 (electric-helpify): Allow NAME to be given as arg.
Richard M. Stallman <rms@gnu.org>
parents: 14943
diff changeset
291 (defun electric-helpify (fun &optional name)
f1e444468043 (electric-helpify): Allow NAME to be given as arg.
Richard M. Stallman <rms@gnu.org>
parents: 14943
diff changeset
292 (let ((name (or name "*Help*")))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
293 (if (save-window-excursion
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
294 ;; kludge-o-rama
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
295 (let* ((p (symbol-function 'print-help-return-message))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
296 (b (get-buffer name))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
297 (m (buffer-modified-p b)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
298 (and b (not (get-buffer-window b))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
299 (setq b nil))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
300 (unwind-protect
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
301 (progn
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
302 (message "%s..." (capitalize (symbol-name fun)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
303 ;; with-output-to-temp-buffer marks the buffer as unmodified.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
304 ;; kludging excessively and relying on that as some sort
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
305 ;; of indication leads to the following abomination...
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
306 ;;>> This would be doable without such icky kludges if either
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
307 ;;>> (a) there were a function to read the interactive
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
308 ;;>> args for a command and return a list of those args.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
309 ;;>> (To which one would then just apply the command)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
310 ;;>> (The only problem with this is that interactive-p
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
311 ;;>> would break, but that is such a misfeature in
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
312 ;;>> any case that I don't care)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
313 ;;>> It is easy to do this for emacs-lisp functions;
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
314 ;;>> the only problem is getting the interactive spec
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
315 ;;>> for subrs
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
316 ;;>> (b) there were a function which returned a
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
317 ;;>> modification-tick for a buffer. One could tell
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
318 ;;>> whether a buffer had changed by whether the
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
319 ;;>> modification-tick were different.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
320 ;;>> (Presumably there would have to be a way to either
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
321 ;;>> restore the tick to some previous value, or to
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
322 ;;>> suspend updating of the tick in order to allow
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
323 ;;>> things like momentary-string-display)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
324 (and b
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
325 (save-excursion
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
326 (set-buffer b)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
327 (set-buffer-modified-p t)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
328 (fset 'print-help-return-message 'ignore)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
329 (call-interactively fun)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
330 (and (get-buffer name)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
331 (get-buffer-window (get-buffer name))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
332 (or (not b)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
333 (not (eq b (get-buffer name)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
334 (not (buffer-modified-p b)))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
335 (fset 'print-help-return-message p)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
336 (and b (buffer-name b)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
337 (save-excursion
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
338 (set-buffer b)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
339 (set-buffer-modified-p m))))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
340 (with-electric-help 'ignore name t))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
341
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
342
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
343
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
344 ;; This is to be bound to M-x in ehelp mode. Retains ehelp buffer and then
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
345 ;; continues with execute-extended-command.
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
346 (defun electric-help-execute-extended (prefixarg)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
347 (interactive "p")
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
348 (setq electric-help-form-to-execute '(execute-extended-command nil))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
349 (electric-help-retain))
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
350
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
351 ;; This is to be buond to C-x in ehelp mode. Retains ehelp buffer and then
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
352 ;; continues with ctrl-x prefix.
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
353 (defun electric-help-ctrl-x-prefix (prefixarg)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
354 (interactive "p")
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
355 (setq electric-help-form-to-execute '(progn (message nil) (setq unread-command-char ?\C-x)))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
356 (electric-help-retain))
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
357
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
358
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
359 (defun electric-describe-key ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
360 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
361 (electric-helpify 'describe-key))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
362
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
363 (defun electric-describe-mode ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
364 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
365 (electric-helpify 'describe-mode))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
366
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
367 (defun electric-view-lossage ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
368 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
369 (electric-helpify 'view-lossage))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
370
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
371 ;(defun electric-help-for-help ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
372 ; "See help-for-help"
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
373 ; (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
374 ; )
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
375
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
376 (defun electric-describe-function ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
377 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
378 (electric-helpify 'describe-function))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
379
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
380 (defun electric-describe-variable ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
381 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
382 (electric-helpify 'describe-variable))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
383
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
384 (defun electric-describe-bindings ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
385 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
386 (electric-helpify 'describe-bindings))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
387
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
388 (defun electric-describe-syntax ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
389 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
390 (electric-helpify 'describe-syntax))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
391
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
392 (defun electric-command-apropos ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
393 (interactive)
15310
f1e444468043 (electric-helpify): Allow NAME to be given as arg.
Richard M. Stallman <rms@gnu.org>
parents: 14943
diff changeset
394 (electric-helpify 'command-apropos "*Apropos*"))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
395
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
396 ;(define-key help-map "a" 'electric-command-apropos)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
397
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
398 (defun electric-apropos ()
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
399 (interactive)
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
400 (electric-helpify 'apropos))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
401
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
402
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
403 ;;;; ehelp-map
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
404
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
405 (defvar ehelp-map ())
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
406 (if ehelp-map
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
407 nil
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
408 (let ((map (copy-keymap help-map)))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
409 (substitute-key-definition 'apropos 'electric-apropos map)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
410 (substitute-key-definition 'command-apropos 'electric-command-apropos map)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
411 (substitute-key-definition 'describe-key 'electric-describe-key map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
412 (substitute-key-definition 'describe-mode 'electric-describe-mode map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
413 (substitute-key-definition 'view-lossage 'electric-view-lossage map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
414 (substitute-key-definition 'describe-function 'electric-describe-function map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
415 (substitute-key-definition 'describe-variable 'electric-describe-variable map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
416 (substitute-key-definition 'describe-bindings 'electric-describe-bindings map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
417 (substitute-key-definition 'describe-syntax 'electric-describe-syntax map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
418
51807
96f6726bae4d (ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents: 49588
diff changeset
419 (setq ehelp-map map)))
96f6726bae4d (ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents: 49588
diff changeset
420
96f6726bae4d (ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents: 49588
diff changeset
421 ;;;###(autoload 'ehelp-command "ehelp" "Prefix command for ehelp." t 'keymap)
96f6726bae4d (ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents: 49588
diff changeset
422 (defalias 'ehelp-command ehelp-map)
96f6726bae4d (ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents: 49588
diff changeset
423 (put 'ehelp-command 'documentation "Prefix command for ehelp.")
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
424
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
425 (provide 'ehelp)
584
4cd7543be581 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 200
diff changeset
426
93975
1e3a407766b9 Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 79721
diff changeset
427 ;; arch-tag: e0e3037f-42c0-433e-ba18-322c5d951f46
662
8a533acedb77 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 584
diff changeset
428 ;;; ehelp.el ends here