Mercurial > emacs
annotate lisp/ehelp.el @ 106353:dec940ff2ab6
* mail/sendmail.el (mail-setup-hook, mail-send-hook): Doc fixes.
* gnus/message.el (message-setup-hook, message-send-hook): Make into aliases
for mail-*-hook.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Tue, 01 Dec 2009 16:20:59 +0000 |
parents | 009383a57ce8 |
children | 1d1d5d9bd884 |
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, |
7043df4031e9
Comment (add Author:, based on authors.el).
Glenn Morris <rgm@gnu.org>
parents:
100908
diff
changeset
|
4 ;; 2007, 2008, 2009 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 | 11 ;; This file is part of GNU Emacs. |
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 | 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 | 17 |
18 ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 ;; GNU General Public License for more details. | |
22 | |
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 | 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 | 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 | 42 (require 'electric) |
43 | |
14474 | 44 (defvar electric-help-form-to-execute nil) |
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 | 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 | 64 (let ((map (make-keymap))) |
13261 | 65 ;; allow all non-self-inserting keys - search, scroll, etc, but |
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 | 68 (define-key map "\C-u" 'electric-help-undefined) |
69 (define-key map [?\C-0] 'electric-help-undefined) | |
70 (define-key map [?\C-1] 'electric-help-undefined) | |
71 (define-key map [?\C-2] 'electric-help-undefined) | |
72 (define-key map [?\C-3] 'electric-help-undefined) | |
73 (define-key map [?\C-4] 'electric-help-undefined) | |
74 (define-key map [?\C-5] 'electric-help-undefined) | |
75 (define-key map [?\C-6] 'electric-help-undefined) | |
76 (define-key map [?\C-7] 'electric-help-undefined) | |
77 (define-key map [?\C-8] 'electric-help-undefined) | |
78 (define-key map [?\C-9] 'electric-help-undefined) | |
36 | 79 (define-key map (char-to-string help-char) 'electric-help-help) |
80 (define-key map "?" 'electric-help-help) | |
81 (define-key map " " 'scroll-up) | |
82 (define-key map "\^?" 'scroll-down) | |
83 (define-key map "." 'beginning-of-buffer) | |
84 (define-key map "<" 'beginning-of-buffer) | |
85 (define-key map ">" 'end-of-buffer) | |
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 | 88 (define-key map "q" 'electric-help-exit) |
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 | 91 (define-key map "r" 'electric-help-retain) |
13261 | 92 (define-key map "\ex" 'electric-help-execute-extended) |
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 | 96 |
36 | 97 (defun electric-help-mode () |
200 | 98 "`with-electric-help' temporarily places its buffer in this mode. |
104682
73bff1db57b6
* gnus/nnheader.el (nnheader-find-file-noselect):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104386
diff
changeset
|
99 \(On exit from `with-electric-help', the buffer is put in default `major-mode'.)" |
36 | 100 (setq buffer-read-only t) |
101 (setq mode-name "Help") | |
102 (setq major-mode 'help) | |
103 (setq mode-line-buffer-identification '(" Help: %b")) | |
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 | 106 (view-mode -1) |
36 | 107 ;; this is done below in with-electric-help |
108 ;(run-hooks 'electric-help-mode-hook) | |
109 ) | |
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 | 114 THUNK is a function of no arguments which is called to initialize the |
115 contents of BUFFER. BUFFER defaults to `*Help*'. BUFFER will be | |
116 erased before THUNK is called unless NOERASE is non-nil. THUNK will | |
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 |
99750
f5057049058b
* ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
94678
diff
changeset
|
120 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
|
121 the window to fit. If THUNK returns non-nil, we don't do those things. |
36 | 122 |
99750
f5057049058b
* ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
94678
diff
changeset
|
123 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
|
124 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
|
125 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
|
126 be at least MINHEIGHT if this value is non-nil. |
13261 | 127 |
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 | 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 |
104682
73bff1db57b6
* gnus/nnheader.el (nnheader-find-file-noselect):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104386
diff
changeset
|
134 BUFFER is put into default `major-mode' (or `fundamental-mode')." |
36 | 135 (setq buffer (get-buffer-create (or buffer "*Help*"))) |
136 (let ((one (one-window-p t)) | |
160 | 137 (config (current-window-configuration)) |
13261 | 138 (bury nil) |
14474 | 139 (electric-help-form-to-execute nil)) |
160 | 140 (unwind-protect |
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 | 144 (let ((pop-up-windows t)) |
145 (pop-to-buffer buffer)) | |
104682
73bff1db57b6
* gnus/nnheader.el (nnheader-find-file-noselect):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104386
diff
changeset
|
146 (with-current-buffer buffer |
31792
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
147 (when (and minheight (< (window-height) minheight)) |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
148 (enlarge-window (- minheight (window-height)))) |
160 | 149 (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
|
150 (setq buffer-read-only nil) |
31792
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
151 (unless noerase |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
152 (erase-buffer))) |
160 | 153 (let ((standard-output buffer)) |
31792
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
154 (unless (funcall thunk) |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
155 (set-buffer buffer) |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
156 (set-buffer-modified-p nil) |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
157 (goto-char (point-min)) |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
158 (when (and one electric-help-shrink-window) |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
159 (shrink-window-if-larger-than-buffer)))) |
160 | 160 (set-buffer buffer) |
161 (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
|
162 (setq buffer-read-only t) |
31792
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
163 (if (eq (car-safe (electric-help-command-loop)) 'retain) |
160 | 164 (setq config (current-window-configuration)) |
31792
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
165 (setq bury t)) |
17255
30b7f4899d66
(with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents:
15310
diff
changeset
|
166 ;; Remove the hook. |
31792
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
167 (when (memq 'electric-help-retain mouse-leave-buffer-hook) |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
168 (remove-hook 'mouse-leave-buffer-hook 'electric-help-retain))) |
160 | 169 (message "") |
170 (set-buffer buffer) | |
171 (setq buffer-read-only nil) | |
31792
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
172 |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
173 ;; We should really get a usable *Help* buffer when retaining |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
174 ;; 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
|
175 ;; 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
|
176 ;; 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
|
177 ;; the right thing, maybe we should add an optional parameter. |
160 | 178 (condition-case () |
104682
73bff1db57b6
* gnus/nnheader.el (nnheader-find-file-noselect):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104386
diff
changeset
|
179 (funcall (or (default-value 'major-mode) 'fundamental-mode)) |
160 | 180 (error nil)) |
49588
37645a051842
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
36892
diff
changeset
|
181 |
160 | 182 (set-window-configuration config) |
31792
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
183 (when bury |
36240
5432010ffe02
(with-electric-help): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
31792
diff
changeset
|
184 ;;>> Perhaps this shouldn't be done, |
31792
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
185 ;; 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
|
186 (replace-buffer-in-windows buffer) |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
187 ;; must do this outside of save-window-excursion |
bad7093b5361
(electric-help): New defgroup.
Gerd Moellmann <gerd@gnu.org>
parents:
17255
diff
changeset
|
188 (bury-buffer buffer)) |
14474 | 189 (eval electric-help-form-to-execute)))) |
36 | 190 |
191 (defun electric-help-command-loop () | |
192 (catch 'exit | |
193 (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
|
194 (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
|
195 (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
|
196 '(?\s)) |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1608
diff
changeset
|
197 (progn (setq unread-command-events nil) |
36 | 198 (throw 'exit t))))) |
199 (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
|
200 (standard (and (eq (key-binding " " nil t) |
36 | 201 'scroll-up) |
55347
ca50b63ed141
(electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
202 (eq (key-binding "\^?" nil t) |
36 | 203 'scroll-down) |
55347
ca50b63ed141
(electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
204 (eq (key-binding "q" nil t) |
36 | 205 'electric-help-exit) |
55347
ca50b63ed141
(electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
206 (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
|
207 'electric-help-retain)))) |
36 | 208 (Electric-command-loop |
209 'exit | |
210 (function (lambda () | |
49588
37645a051842
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
36892
diff
changeset
|
211 (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
|
212 ;beginning-of-buffer - otherwise pos-visible-in-window-p |
13261 | 213 ;will yield a wrong result. |
36 | 214 (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
|
215 (max (pos-visible-in-window-p (1- (point-max))))) |
13261 | 216 (cond (isearch-mode 'noprompt) |
217 ((and min max) | |
10740
45c4759f286e
(electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents:
4479
diff
changeset
|
218 (cond (standard "Press q to exit, r to retain ") |
36 | 219 (neither) |
10740
45c4759f286e
(electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents:
4479
diff
changeset
|
220 (t (setq neither (substitute-command-keys "Press \\[electric-help-exit] to exit, \\[electric-help-retain] to retain "))))) |
36 | 221 (min |
10740
45c4759f286e
(electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents:
4479
diff
changeset
|
222 (cond (standard "Press SPC to scroll, q to exit, r to retain ") |
36 | 223 (up) |
10740
45c4759f286e
(electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents:
4479
diff
changeset
|
224 (t (setq up (substitute-command-keys "Press \\[scroll-up] to scroll, \\[electric-help-exit] to exit, \\[electric-help-retain] to retain "))))) |
36 | 225 (max |
13261 | 226 (cond (standard "Press DEL to scroll back, q to exit, r to retain ") |
36 | 227 (down) |
10740
45c4759f286e
(electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents:
4479
diff
changeset
|
228 (t (setq down (substitute-command-keys "Press \\[scroll-down] to scroll back, \\[electric-help-exit] to exit, \\[electric-help-retain] to retain "))))) |
36 | 229 (t |
13261 | 230 (cond (standard "Press SPC to scroll, DEL to scroll back, q to exit, r to retain ") |
36 | 231 (both) |
10740
45c4759f286e
(electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents:
4479
diff
changeset
|
232 (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 | 233 t)))) |
234 | |
235 | |
236 | |
237 ;(defun electric-help-scroll-up (arg) | |
238 ; ">>>Doc" | |
239 ; (interactive "P") | |
240 ; (if (and (null arg) (pos-visible-in-window-p (point-max))) | |
241 ; (electric-help-exit) | |
242 ; (scroll-up arg))) | |
243 | |
244 (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
|
245 "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
|
246 \(The *Help* buffer will be buried.)" |
36 | 247 (interactive) |
17255
30b7f4899d66
(with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents:
15310
diff
changeset
|
248 ;; 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
|
249 ;; calling this function: |
30b7f4899d66
(with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents:
15310
diff
changeset
|
250 (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
|
251 (progn |
30b7f4899d66
(with-electric-help): Remove hook on exit.
Richard M. Stallman <rms@gnu.org>
parents:
15310
diff
changeset
|
252 (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
|
253 (throw 'exit t)))) |
36 | 254 |
255 (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
|
256 "Exit `with-electric-help', retaining the current window/buffer configuration. |
36 | 257 \(The *Help* buffer will not be selected, but \\[switch-to-buffer-other-window] RET |
258 will select it.)" | |
259 (interactive) | |
13261 | 260 ;; Make sure that we don't throw twice, even if two events cause |
261 ;; 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
|
262 (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
|
263 (progn |
2c44547d2364
(electric-help-mode): Use add-hook mouse-leave-buffer-hook.
Richard M. Stallman <rms@gnu.org>
parents:
14781
diff
changeset
|
264 (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
|
265 (throw 'exit '(retain))))) |
36 | 266 |
267 | |
268 (defun electric-help-undefined () | |
269 (interactive) | |
270 (error "%s is undefined -- Press %s to exit" | |
271 (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
|
272 (if (eq (key-binding "q" nil t) 'electric-help-exit) |
13261 | 273 "q" |
36 | 274 (substitute-command-keys "\\[electric-help-exit]")))) |
275 | |
276 | |
277 ;>>> this needs to be hairified (recursive help, anybody?) | |
278 (defun electric-help-help () | |
279 (interactive) | |
55347
ca50b63ed141
(electric-help-command-loop, electric-help-undefined, electric-help-help):
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
280 (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
|
281 (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
|
282 (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
|
283 (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
|
284 (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
|
285 (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 | 286 (sit-for 2)) |
287 | |
288 | |
12601
ca43eab4d2a6
(electric-helpify): Autoload with-electric-help, electric-helpify.
Richard M. Stallman <rms@gnu.org>
parents:
11234
diff
changeset
|
289 ;;;###autoload |
15310
f1e444468043
(electric-helpify): Allow NAME to be given as arg.
Richard M. Stallman <rms@gnu.org>
parents:
14943
diff
changeset
|
290 (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
|
291 (let ((name (or name "*Help*"))) |
36 | 292 (if (save-window-excursion |
293 ;; 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
|
294 (let* ((p (symbol-function 'help-print-return-message)) |
36 | 295 (b (get-buffer name)) |
296 (m (buffer-modified-p b))) | |
297 (and b (not (get-buffer-window b)) | |
298 (setq b nil)) | |
299 (unwind-protect | |
300 (progn | |
301 (message "%s..." (capitalize (symbol-name fun))) | |
302 ;; with-output-to-temp-buffer marks the buffer as unmodified. | |
303 ;; kludging excessively and relying on that as some sort | |
304 ;; of indication leads to the following abomination... | |
305 ;;>> This would be doable without such icky kludges if either | |
306 ;;>> (a) there were a function to read the interactive | |
307 ;;>> args for a command and return a list of those args. | |
308 ;;>> (To which one would then just apply the command) | |
309 ;;>> (The only problem with this is that interactive-p | |
310 ;;>> would break, but that is such a misfeature in | |
311 ;;>> any case that I don't care) | |
312 ;;>> It is easy to do this for emacs-lisp functions; | |
313 ;;>> the only problem is getting the interactive spec | |
314 ;;>> for subrs | |
315 ;;>> (b) there were a function which returned a | |
316 ;;>> modification-tick for a buffer. One could tell | |
317 ;;>> whether a buffer had changed by whether the | |
318 ;;>> modification-tick were different. | |
319 ;;>> (Presumably there would have to be a way to either | |
320 ;;>> restore the tick to some previous value, or to | |
321 ;;>> suspend updating of the tick in order to allow | |
322 ;;>> things like momentary-string-display) | |
323 (and b | |
105994
009383a57ce8
* x-dnd.el (x-dnd-maybe-call-test-function):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104682
diff
changeset
|
324 (with-current-buffer b |
36 | 325 (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
|
326 (fset 'help-print-return-message 'ignore) |
36 | 327 (call-interactively fun) |
328 (and (get-buffer name) | |
329 (get-buffer-window (get-buffer name)) | |
330 (or (not b) | |
331 (not (eq b (get-buffer name))) | |
332 (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
|
333 (fset 'help-print-return-message p) |
36 | 334 (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
|
335 (with-current-buffer b |
36 | 336 (set-buffer-modified-p m)))))) |
337 (with-electric-help 'ignore name t)))) | |
338 | |
339 | |
13261 | 340 |
49588
37645a051842
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
36892
diff
changeset
|
341 ;; This is to be bound to M-x in ehelp mode. Retains ehelp buffer and then |
13261 | 342 ;; continues with execute-extended-command. |
343 (defun electric-help-execute-extended (prefixarg) | |
344 (interactive "p") | |
14474 | 345 (setq electric-help-form-to-execute '(execute-extended-command nil)) |
13261 | 346 (electric-help-retain)) |
347 | |
348 ;; This is to be buond to C-x in ehelp mode. Retains ehelp buffer and then | |
349 ;; continues with ctrl-x prefix. | |
350 (defun electric-help-ctrl-x-prefix (prefixarg) | |
351 (interactive "p") | |
14474 | 352 (setq electric-help-form-to-execute '(progn (message nil) (setq unread-command-char ?\C-x))) |
13261 | 353 (electric-help-retain)) |
354 | |
355 | |
36 | 356 (defun electric-describe-key () |
357 (interactive) | |
358 (electric-helpify 'describe-key)) | |
359 | |
360 (defun electric-describe-mode () | |
361 (interactive) | |
362 (electric-helpify 'describe-mode)) | |
363 | |
364 (defun electric-view-lossage () | |
365 (interactive) | |
366 (electric-helpify 'view-lossage)) | |
367 | |
368 ;(defun electric-help-for-help () | |
369 ; "See help-for-help" | |
370 ; (interactive) | |
371 ; ) | |
372 | |
373 (defun electric-describe-function () | |
374 (interactive) | |
375 (electric-helpify 'describe-function)) | |
376 | |
377 (defun electric-describe-variable () | |
378 (interactive) | |
379 (electric-helpify 'describe-variable)) | |
380 | |
381 (defun electric-describe-bindings () | |
382 (interactive) | |
383 (electric-helpify 'describe-bindings)) | |
384 | |
385 (defun electric-describe-syntax () | |
386 (interactive) | |
387 (electric-helpify 'describe-syntax)) | |
388 | |
389 (defun electric-command-apropos () | |
390 (interactive) | |
15310
f1e444468043
(electric-helpify): Allow NAME to be given as arg.
Richard M. Stallman <rms@gnu.org>
parents:
14943
diff
changeset
|
391 (electric-helpify 'command-apropos "*Apropos*")) |
36 | 392 |
393 ;(define-key help-map "a" 'electric-command-apropos) | |
394 | |
10740
45c4759f286e
(electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents:
4479
diff
changeset
|
395 (defun electric-apropos () |
45c4759f286e
(electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents:
4479
diff
changeset
|
396 (interactive) |
45c4759f286e
(electric-help-help, electric-help-command-loop):
Richard M. Stallman <rms@gnu.org>
parents:
4479
diff
changeset
|
397 (electric-helpify 'apropos)) |
36 | 398 |
399 | |
400 ;;;; ehelp-map | |
401 | |
99750
f5057049058b
* ehelp.el (electric-help-map, ehelp-map): Define within defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
94678
diff
changeset
|
402 (defvar ehelp-map |
49588
37645a051842
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
36892
diff
changeset
|
403 (let ((map (copy-keymap help-map))) |
13261 | 404 (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
|
405 (substitute-key-definition 'command-apropos 'electric-command-apropos map) |
36 | 406 (substitute-key-definition 'describe-key 'electric-describe-key map) |
407 (substitute-key-definition 'describe-mode 'electric-describe-mode map) | |
408 (substitute-key-definition 'view-lossage 'electric-view-lossage map) | |
409 (substitute-key-definition 'describe-function 'electric-describe-function map) | |
410 (substitute-key-definition 'describe-variable 'electric-describe-variable map) | |
411 (substitute-key-definition 'describe-bindings 'electric-describe-bindings map) | |
412 (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
|
413 map)) |
51807
96f6726bae4d
(ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents:
49588
diff
changeset
|
414 |
96f6726bae4d
(ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents:
49588
diff
changeset
|
415 ;;;###(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
|
416 (defalias 'ehelp-command ehelp-map) |
96f6726bae4d
(ehelp-command): Use defalias to define ehelp-command.
Richard M. Stallman <rms@gnu.org>
parents:
49588
diff
changeset
|
417 (put 'ehelp-command 'documentation "Prefix command for ehelp.") |
36 | 418 |
49588
37645a051842
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
36892
diff
changeset
|
419 (provide 'ehelp) |
584 | 420 |
93975
1e3a407766b9
Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
79721
diff
changeset
|
421 ;; arch-tag: e0e3037f-42c0-433e-ba18-322c5d951f46 |
662
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
422 ;;; ehelp.el ends here |