annotate lisp/ehelp.el @ 110453:cb1da66792a4

Check in missing ChangeLog entry.
author Dan Nicolaescu <dann@ics.uci.edu>
date Tue, 21 Sep 2010 09:36:01 +0300
parents 1734936f6133
children 417b1e4d63cd
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
101106
7043df4031e9 Comment (add Author:, based on authors.el).
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
3 ;; Copyright (C) 1986, 1995, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
106815
1d1d5d9bd884 Add 2010 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 105994
diff changeset
4 ;; 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
846
20674ae6bf52 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 811
diff changeset
5
101106
7043df4031e9 Comment (add Author:, based on authors.el).
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
6 ;; Author: Richard Mlynarik
7043df4031e9 Comment (add Author:, based on authors.el).
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
7 ;; (according to ack.texi and authors.el)
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
8 ;; Maintainer: FSF
811
e694e0879463 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 807
diff changeset
9 ;; Keywords: help, extensions
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
10
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
11 ;; This file is part of GNU Emacs.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
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
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
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.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
17
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
18 ;; GNU Emacs is distributed in the hope that it will be useful,
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
21 ;; GNU General Public License for more details.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
22
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
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/>.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
25
2307
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
26 ;;; Commentary:
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
27
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
28 ;; 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
29 ;; 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
30 ;; `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
31 ;; 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
32 ;; buffer.
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2027
diff changeset
33
12721
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
34 ;; To make this the default, you must do
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
35 ;; (require 'ehelp)
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
36 ;; (define-key global-map "\C-h" 'ehelp-command)
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
37 ;; (define-key global-map [help] 'ehelp-command)
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
38 ;; (define-key global-map [f1] 'ehelp-command)
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
39
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
40 ;;; Code:
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
41
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
42 (require 'electric)
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)
99750
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
62
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
63 (defvar electric-help-map
36
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)
99750
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
94 map)
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
95 "Keymap defining commands available in `electric-help-mode'.")
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
96
107764
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
97 (defvar electric-help-orig-major-mode nil)
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
98 (make-variable-buffer-local 'electric-help-orig-major-mode)
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
99
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
100 (defun electric-help-mode ()
200
74504bd76aaa *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 160
diff changeset
101 "`with-electric-help' temporarily places its buffer in this mode.
107764
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
102 \(On exit from `with-electric-help', the original `major-mode' is restored.)"
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
103 (setq buffer-read-only t)
107764
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
104 (setq electric-help-orig-major-mode major-mode)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
105 (setq mode-name "Help")
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
106 (setq major-mode 'help)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
107 (setq mode-line-buffer-identification '(" Help: %b"))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
108 (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
109 (add-hook 'mouse-leave-buffer-hook 'electric-help-retain)
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
110 (view-mode -1)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
111 ;; this is done below in with-electric-help
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
112 ;(run-hooks 'electric-help-mode-hook)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
113 )
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
114
12601
ca43eab4d2a6 (electric-helpify): Autoload with-electric-help, electric-helpify.
Richard M. Stallman <rms@gnu.org>
parents: 11234
diff changeset
115 ;;;###autoload
13381
0cbe99851fab (with-electric-help): Add missing argument MINHEIGHT.
Erik Naggum <erik@naggum.no>
parents: 13261
diff changeset
116 (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
117 "Pop up an \"electric\" help buffer.
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
118 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
119 contents of BUFFER. BUFFER defaults to `*Help*'. BUFFER will be
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
120 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
121 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
122 the buffer specified by BUFFER.
363b0c8f817d (with-electric-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12601
diff changeset
123
99750
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
124 If THUNK returns nil, we display BUFFER starting at the top, and shrink
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
125 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
126
99750
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
127 After THUNK has been called, this function \"electrically\" pops up a
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
128 window in which BUFFER is displayed and allows the user to scroll
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
129 through that buffer in `electric-help-mode'. The window's height will
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
130 be at least MINHEIGHT if this value is non-nil.
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
131
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
132 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
133 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
134 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
135
36240
5432010ffe02 (with-electric-help): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 31792
diff changeset
136 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
137 buffer's window disappears (i.e., we use `save-window-excursion'), and
107764
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
138 BUFFER is put back into its original major mode."
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
139 (setq buffer (get-buffer-create (or buffer "*Help*")))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
140 (let ((one (one-window-p t))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
141 (config (current-window-configuration))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
142 (bury nil)
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
143 (electric-help-form-to-execute nil))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
144 (unwind-protect
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
145 (save-excursion
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
146 (when one
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
147 (goto-char (window-start (selected-window))))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
148 (let ((pop-up-windows t))
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
149 (pop-to-buffer buffer))
104682
73bff1db57b6 * gnus/nnheader.el (nnheader-find-file-noselect):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104386
diff changeset
150 (with-current-buffer buffer
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
151 (when (and minheight (< (window-height) minheight))
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
152 (enlarge-window (- minheight (window-height))))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
153 (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
154 (setq buffer-read-only nil)
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
155 (unless noerase
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
156 (erase-buffer)))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
157 (let ((standard-output buffer))
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
158 (unless (funcall thunk)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
159 (set-buffer buffer)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
160 (set-buffer-modified-p nil)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
161 (goto-char (point-min))
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
162 (when (and one electric-help-shrink-window)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
163 (shrink-window-if-larger-than-buffer))))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
164 (set-buffer buffer)
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
165 (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
166 (setq buffer-read-only t)
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
167 (if (eq (car-safe (electric-help-command-loop)) 'retain)
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
168 (setq config (current-window-configuration))
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
169 (setq bury t))
17255
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
170 ;; Remove the hook.
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
171 (when (memq 'electric-help-retain mouse-leave-buffer-hook)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
172 (remove-hook 'mouse-leave-buffer-hook 'electric-help-retain)))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
173 (message "")
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
174 (set-buffer buffer)
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
175 (setq buffer-read-only nil)
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
176
107764
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
177 ;; Restore the original major mode saved by `electric-help-mode'.
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
178 ;; We should really get a usable *Help* buffer when retaining
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
179 ;; the electric one with `r'. The problem is that a simple
107764
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
180 ;; call to `help-mode' won't cut it; e.g. RET is bound wrong
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
181 ;; afterwards (`View-scroll-line-forward' instead of `help-follow').
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
182 ;; That's because Help mode should be set with `with-help-window'
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
183 ;; instead of the direct call to `help-mode'. But at least
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
184 ;; RET works correctly on links after using `help-mode'.
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
185 ;; This is satisfactory enough.
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
186 (condition-case ()
107764
1734936f6133 * ehelp.el (electric-help-orig-major-mode): New buffer-local variable.
Juri Linkov <juri@jurta.org>
parents: 106815
diff changeset
187 (funcall (or electric-help-orig-major-mode 'fundamental-mode))
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
188 (error nil))
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
189
160
84efc09a36b4 *** empty log message ***
root <root>
parents: 36
diff changeset
190 (set-window-configuration config)
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
191 (when bury
36240
5432010ffe02 (with-electric-help): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 31792
diff changeset
192 ;;>> Perhaps this shouldn't be done,
31792
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
193 ;; 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
194 (replace-buffer-in-windows buffer)
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
195 ;; must do this outside of save-window-excursion
bad7093b5361 (electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents: 17255
diff changeset
196 (bury-buffer buffer))
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
197 (eval electric-help-form-to-execute))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
198
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
199 (defun electric-help-command-loop ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
200 (catch 'exit
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
201 (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
202 (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
203 (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
204 '(?\s))
1821
04fb1d3d6992 JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents: 1608
diff changeset
205 (progn (setq unread-command-events nil)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
206 (throw 'exit t)))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
207 (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
208 (standard (and (eq (key-binding " " nil t)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
209 'scroll-up)
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
210 (eq (key-binding "\^?" nil t)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
211 'scroll-down)
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
212 (eq (key-binding "q" nil t)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
213 'electric-help-exit)
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
214 (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
215 'electric-help-retain))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
216 (Electric-command-loop
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
217 'exit
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
218 (function (lambda ()
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
219 (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
220 ;beginning-of-buffer - otherwise pos-visible-in-window-p
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
221 ;will yield a wrong result.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
222 (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
223 (max (pos-visible-in-window-p (1- (point-max)))))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
224 (cond (isearch-mode 'noprompt)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
225 ((and min max)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
226 (cond (standard "Press q to exit, r to retain ")
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
227 (neither)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
228 (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
229 (min
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
230 (cond (standard "Press SPC to scroll, q to exit, r to retain ")
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
231 (up)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
232 (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
233 (max
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
234 (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
235 (down)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
236 (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
237 (t
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
238 (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
239 (both)
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
240 (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
241 t))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
242
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
243
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-scroll-up (arg)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
246 ; ">>>Doc"
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
247 ; (interactive "P")
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
248 ; (if (and (null arg) (pos-visible-in-window-p (point-max)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
249 ; (electric-help-exit)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
250 ; (scroll-up arg)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
251
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
252 (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
253 "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
254 \(The *Help* buffer will be buried.)"
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
255 (interactive)
17255
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
256 ;; 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
257 ;; calling this function:
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
258 (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
259 (progn
30b7f4899d66 (with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents: 15310
diff changeset
260 (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
261 (throw 'exit t))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
262
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
263 (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
264 "Exit `with-electric-help', retaining the current window/buffer configuration.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
265 \(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
266 will select it.)"
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
267 (interactive)
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
268 ;; 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
269 ;; 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
270 (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
271 (progn
2c44547d2364 (electric-help-mode): Use add-hook mouse-leave-buffer-hook.
Richard M. Stallman <rms@gnu.org>
parents: 14781
diff changeset
272 (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
273 (throw 'exit '(retain)))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
274
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
275
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
276 (defun electric-help-undefined ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
277 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
278 (error "%s is undefined -- Press %s to exit"
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
279 (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
280 (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
281 "q"
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
282 (substitute-command-keys "\\[electric-help-exit]"))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
283
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
284
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
285 ;>>> this needs to be hairified (recursive help, anybody?)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
286 (defun electric-help-help ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
287 (interactive)
55347
ca50b63ed141 (electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
288 (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
289 (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
290 (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
291 (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
292 (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
293 (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
294 (sit-for 2))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
295
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
296
12601
ca43eab4d2a6 (electric-helpify): Autoload with-electric-help, electric-helpify.
Richard M. Stallman <rms@gnu.org>
parents: 11234
diff changeset
297 ;;;###autoload
15310
f1e444468043 (electric-helpify): Allow NAME to be given as arg.
Richard M. Stallman <rms@gnu.org>
parents: 14943
diff changeset
298 (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
299 (let ((name (or name "*Help*")))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
300 (if (save-window-excursion
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
301 ;; kludge-o-rama
104386
2e0765155e47 Use help-print-return-message rather than the now obsolete alias.
Glenn Morris <rgm@gnu.org>
parents: 101106
diff changeset
302 (let* ((p (symbol-function 'help-print-return-message))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
303 (b (get-buffer name))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
304 (m (buffer-modified-p b)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
305 (and b (not (get-buffer-window b))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
306 (setq b nil))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
307 (unwind-protect
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
308 (progn
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
309 (message "%s..." (capitalize (symbol-name fun)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
310 ;; with-output-to-temp-buffer marks the buffer as unmodified.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
311 ;; kludging excessively and relying on that as some sort
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
312 ;; of indication leads to the following abomination...
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
313 ;;>> This would be doable without such icky kludges if either
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
314 ;;>> (a) there were a function to read the interactive
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
315 ;;>> args for a command and return a list of those args.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
316 ;;>> (To which one would then just apply the command)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
317 ;;>> (The only problem with this is that interactive-p
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
318 ;;>> would break, but that is such a misfeature in
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
319 ;;>> any case that I don't care)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
320 ;;>> It is easy to do this for emacs-lisp functions;
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
321 ;;>> the only problem is getting the interactive spec
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
322 ;;>> for subrs
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
323 ;;>> (b) there were a function which returned a
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
324 ;;>> modification-tick for a buffer. One could tell
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
325 ;;>> whether a buffer had changed by whether the
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
326 ;;>> modification-tick were different.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
327 ;;>> (Presumably there would have to be a way to either
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
328 ;;>> restore the tick to some previous value, or to
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
329 ;;>> suspend updating of the tick in order to allow
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
330 ;;>> things like momentary-string-display)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
331 (and b
105994
009383a57ce8 * x-dnd.el (x-dnd-maybe-call-test-function):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104682
diff changeset
332 (with-current-buffer b
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
333 (set-buffer-modified-p t)))
104386
2e0765155e47 Use help-print-return-message rather than the now obsolete alias.
Glenn Morris <rgm@gnu.org>
parents: 101106
diff changeset
334 (fset 'help-print-return-message 'ignore)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
335 (call-interactively fun)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
336 (and (get-buffer name)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
337 (get-buffer-window (get-buffer name))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
338 (or (not b)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
339 (not (eq b (get-buffer name)))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
340 (not (buffer-modified-p b)))))
104386
2e0765155e47 Use help-print-return-message rather than the now obsolete alias.
Glenn Morris <rgm@gnu.org>
parents: 101106
diff changeset
341 (fset 'help-print-return-message p)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
342 (and b (buffer-name b)
105994
009383a57ce8 * x-dnd.el (x-dnd-maybe-call-test-function):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104682
diff changeset
343 (with-current-buffer b
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
344 (set-buffer-modified-p m))))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
345 (with-electric-help 'ignore name t))))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
346
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
347
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
348
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
349 ;; 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
350 ;; continues with execute-extended-command.
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
351 (defun electric-help-execute-extended (prefixarg)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
352 (interactive "p")
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
353 (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
354 (electric-help-retain))
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
355
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
356 ;; 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
357 ;; continues with ctrl-x prefix.
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
358 (defun electric-help-ctrl-x-prefix (prefixarg)
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
359 (interactive "p")
14474
799da4d5aeb7 (with-electric-help):
Richard M. Stallman <rms@gnu.org>
parents: 14311
diff changeset
360 (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
361 (electric-help-retain))
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
362
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
363
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
364 (defun electric-describe-key ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
365 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
366 (electric-helpify 'describe-key))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
367
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
368 (defun electric-describe-mode ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
369 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
370 (electric-helpify 'describe-mode))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
371
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
372 (defun electric-view-lossage ()
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 (electric-helpify 'view-lossage))
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-help-for-help ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
377 ; "See help-for-help"
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
378 ; (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
379 ; )
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
380
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
381 (defun electric-describe-function ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
382 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
383 (electric-helpify 'describe-function))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
384
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
385 (defun electric-describe-variable ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
386 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
387 (electric-helpify 'describe-variable))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
388
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
389 (defun electric-describe-bindings ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
390 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
391 (electric-helpify 'describe-bindings))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
392
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
393 (defun electric-describe-syntax ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
394 (interactive)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
395 (electric-helpify 'describe-syntax))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
396
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
397 (defun electric-command-apropos ()
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
398 (interactive)
15310
f1e444468043 (electric-helpify): Allow NAME to be given as arg.
Richard M. Stallman <rms@gnu.org>
parents: 14943
diff changeset
399 (electric-helpify 'command-apropos "*Apropos*"))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
400
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
401 ;(define-key help-map "a" 'electric-command-apropos)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
402
10740
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
403 (defun electric-apropos ()
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
404 (interactive)
45c4759f286e (electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents: 4479
diff changeset
405 (electric-helpify 'apropos))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
406
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
407
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
408 ;;;; ehelp-map
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
409
99750
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
410 (defvar ehelp-map
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
411 (let ((map (copy-keymap help-map)))
13261
0d673f6c334e Fix key bindings.
Richard M. Stallman <rms@gnu.org>
parents: 12721
diff changeset
412 (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
413 (substitute-key-definition 'command-apropos 'electric-command-apropos map)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
414 (substitute-key-definition 'describe-key 'electric-describe-key map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
415 (substitute-key-definition 'describe-mode 'electric-describe-mode map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
416 (substitute-key-definition 'view-lossage 'electric-view-lossage map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
417 (substitute-key-definition 'describe-function 'electric-describe-function map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
418 (substitute-key-definition 'describe-variable 'electric-describe-variable map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
419 (substitute-key-definition 'describe-bindings 'electric-describe-bindings map)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
420 (substitute-key-definition 'describe-syntax 'electric-describe-syntax map)
99750
f5057049058b * ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents: 94678
diff changeset
421 map))
51807
96f6726bae4d (ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents: 49588
diff changeset
422
96f6726bae4d (ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents: 49588
diff changeset
423 ;;;###(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
424 (defalias 'ehelp-command ehelp-map)
96f6726bae4d (ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents: 49588
diff changeset
425 (put 'ehelp-command 'documentation "Prefix command for ehelp.")
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
426
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 36892
diff changeset
427 (provide 'ehelp)
584
4cd7543be581 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 200
diff changeset
428
93975
1e3a407766b9 Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 79721
diff changeset
429 ;; arch-tag: e0e3037f-42c0-433e-ba18-322c5d951f46
662
8a533acedb77 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 584
diff changeset
430 ;;; ehelp.el ends here