Mercurial > emacs
annotate lisp/map-ynp.el @ 3137:1e7d462c176f
(hexlify-command, dehexlify-command): Use exec-directory.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 26 May 1993 21:17:31 +0000 |
parents | b88e105bdbf7 |
children | cb593618786e |
rev | line source |
---|---|
659
505130d1ddf8
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
580
diff
changeset
|
1 ;;; map-ynp.el --- General-purpose boolean question-asker. |
505130d1ddf8
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
580
diff
changeset
|
2 |
840
113281b361ec
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
3 ;;; Copyright (C) 1991, 1992 Free Software Foundation, Inc. |
113281b361ec
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
4 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
659
diff
changeset
|
5 ;; Author: Roland McGrath <roland@gnu.ai.mit.edu> |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
6 ;; Keywords: lisp, extensions |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
659
diff
changeset
|
7 |
304 | 8 ;;; This program is free software; you can redistribute it and/or modify |
9 ;;; it under the terms of the GNU General Public License as published by | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
659
diff
changeset
|
10 ;;; the Free Software Foundation; either version 2, or (at your option) |
304 | 11 ;;; any later version. |
12 ;;; | |
13 ;;; This program is distributed in the hope that it will be useful, | |
14 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 ;;; GNU General Public License for more details. | |
17 ;;; | |
18 ;;; A copy of the GNU General Public License can be obtained from this | |
19 ;;; program's author (send electronic mail to roland@ai.mit.edu) or from | |
20 ;;; the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA | |
21 ;;; 02139, USA. | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
659
diff
changeset
|
22 |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
659
diff
changeset
|
23 ;;; Commentary: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
659
diff
changeset
|
24 |
304 | 25 ;;; map-y-or-n-p is a general-purpose question-asking function. |
26 ;;; It asks a series of y/n questions (a la y-or-n-p), and decides to | |
27 ;;; applies an action to each element of a list based on the answer. | |
28 ;;; The nice thing is that you also get some other possible answers | |
29 ;;; to use, reminiscent of query-replace: ! to answer y to all remaining | |
30 ;;; questions; ESC or q to answer n to all remaining questions; . to answer | |
31 ;;; y once and then n for the remainder; and you can get help with C-h. | |
32 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
659
diff
changeset
|
33 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
659
diff
changeset
|
34 |
304 | 35 ;;;###autoload |
891 | 36 (defun map-y-or-n-p (prompter actor list &optional help action-alist) |
304 | 37 "Ask a series of boolean questions. |
891 | 38 Takes args PROMPTER ACTOR LIST, and optional args HELP and ACTION-ALIST. |
304 | 39 |
40 LIST is a list of objects, or a function of no arguments to return the next | |
41 object or nil. | |
42 | |
580 | 43 If PROMPTER is a string, the prompt is \(format PROMPTER OBJECT\). If not |
572 | 44 a string, PROMPTER is a function of one arg (an object from LIST), which |
45 returns a string to be used as the prompt for that object. If the return | |
46 value is not a string, it is eval'd to get the answer; it may be nil to | |
47 ignore the object, t to act on the object without asking the user, or a | |
48 form to do a more complex prompt. | |
49 | |
304 | 50 ACTOR is a function of one arg (an object from LIST), |
51 which gets called with each object that the user answers `yes' for. | |
52 | |
53 If HELP is given, it is a list (OBJECT OBJECTS ACTION), | |
54 where OBJECT is a string giving the singular noun for an elt of LIST; | |
55 OBJECTS is the plural noun for elts of LIST, and ACTION is a transitive | |
56 verb describing ACTOR. The default is \(\"object\" \"objects\" \"act on\"\). | |
57 | |
58 At the prompts, the user may enter y, Y, or SPC to act on that object; | |
59 n, N, or DEL to skip that object; ! to act on all following objects; | |
60 ESC or q to exit (skip all following objects); . (period) to act on the | |
61 current object and then exit; or \\[help-command] to get help. | |
62 | |
891 | 63 If ACTION-ALIST is given, it is an alist (KEY FUNCTION HELP) of extra keys |
64 that will be accepted. KEY is a character; FUNCTION is a function of one | |
65 arg (an object from LIST); HELP is a string. When the user hits KEY, | |
66 FUNCTION is called. If it returns non-nil, the object is considered | |
67 \"acted upon\", and the next object from LIST is processed. If it returns | |
68 nil, the prompt is repeated for the same object. | |
69 | |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
70 This function uses `query-replace-map' to define the standard responses, |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
71 but not all of the responses which `query-replace' understands |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
72 are meaningful here. |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
73 |
304 | 74 Returns the number of actions taken." |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
75 (let* ((user-keys (if action-alist |
1235
a9e3ec19b7d7
Use (function ...) around lambdas, so it works in v18.
Roland McGrath <roland@gnu.org>
parents:
911
diff
changeset
|
76 (concat (mapconcat (function |
a9e3ec19b7d7
Use (function ...) around lambdas, so it works in v18.
Roland McGrath <roland@gnu.org>
parents:
911
diff
changeset
|
77 (lambda (elt) |
a9e3ec19b7d7
Use (function ...) around lambdas, so it works in v18.
Roland McGrath <roland@gnu.org>
parents:
911
diff
changeset
|
78 (key-description |
a9e3ec19b7d7
Use (function ...) around lambdas, so it works in v18.
Roland McGrath <roland@gnu.org>
parents:
911
diff
changeset
|
79 (char-to-string (car elt))))) |
891 | 80 action-alist ", ") |
81 " ") | |
82 "")) | |
2442
f692546797f9
(map-y-or-n-p): Make bindings of user-defined keys be each a vector
Roland McGrath <roland@gnu.org>
parents:
2082
diff
changeset
|
83 ;; Make a map that defines each user key as a vector containing |
f692546797f9
(map-y-or-n-p): Make bindings of user-defined keys be each a vector
Roland McGrath <roland@gnu.org>
parents:
2082
diff
changeset
|
84 ;; its definition. |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
85 (map (cons 'keymap |
2442
f692546797f9
(map-y-or-n-p): Make bindings of user-defined keys be each a vector
Roland McGrath <roland@gnu.org>
parents:
2082
diff
changeset
|
86 (append (mapcar (lambda (elt) |
f692546797f9
(map-y-or-n-p): Make bindings of user-defined keys be each a vector
Roland McGrath <roland@gnu.org>
parents:
2082
diff
changeset
|
87 (cons (car elt) (vector (nth 1 elt)))) |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
88 action-alist) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
89 query-replace-map))) |
474 | 90 (actions 0) |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
91 prompt char elt tail def |
474 | 92 (next (if (or (symbolp list) |
93 (subrp list) | |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1616
diff
changeset
|
94 (byte-code-function-p list) |
474 | 95 (and (consp list) |
96 (eq (car list) 'lambda))) | |
97 (function (lambda () | |
98 (setq elt (funcall list)))) | |
99 (function (lambda () | |
100 (if list | |
101 (progn | |
102 (setq elt (car list) | |
103 list (cdr list)) | |
104 t) | |
105 nil)))))) | |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
106 |
304 | 107 (if (stringp prompter) |
108 (setq prompter (` (lambda (object) | |
109 (format (, prompter) object))))) | |
415 | 110 (while (funcall next) |
304 | 111 (setq prompt (funcall prompter elt)) |
112 (if (stringp prompt) | |
113 (progn | |
2082
4b05402f3ac5
(map-y-or-n-p): Handle `quit' as answer.
Richard M. Stallman <rms@gnu.org>
parents:
2081
diff
changeset
|
114 (setq quit-flag nil) |
304 | 115 ;; Prompt the user about this object. |
116 (let ((cursor-in-echo-area t)) | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
891
diff
changeset
|
117 (message "%s(y, n, !, ., q, %sor %s) " |
891 | 118 prompt user-keys |
119 (key-description (char-to-string help-char))) | |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
120 (setq char (read-event))) |
2793
b88e105bdbf7
(map-y-or-n-p): Show the answers in the echo area.
Richard M. Stallman <rms@gnu.org>
parents:
2442
diff
changeset
|
121 ;; Show the answer to the question. |
b88e105bdbf7
(map-y-or-n-p): Show the answers in the echo area.
Richard M. Stallman <rms@gnu.org>
parents:
2442
diff
changeset
|
122 (message "%s(y, n, !, ., q, %sor %s) %s" |
b88e105bdbf7
(map-y-or-n-p): Show the answers in the echo area.
Richard M. Stallman <rms@gnu.org>
parents:
2442
diff
changeset
|
123 prompt user-keys |
b88e105bdbf7
(map-y-or-n-p): Show the answers in the echo area.
Richard M. Stallman <rms@gnu.org>
parents:
2442
diff
changeset
|
124 (key-description (char-to-string help-char)) |
b88e105bdbf7
(map-y-or-n-p): Show the answers in the echo area.
Richard M. Stallman <rms@gnu.org>
parents:
2442
diff
changeset
|
125 (single-key-description char)) |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
126 (setq def (lookup-key map (vector char))) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
127 (cond ((eq def 'exit) |
304 | 128 (setq next (function (lambda () nil)))) |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
129 ((eq def 'act) |
304 | 130 ;; Act on the object. |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
131 (funcall actor elt) |
304 | 132 (setq actions (1+ actions))) |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
133 ((eq def 'skip) |
304 | 134 ;; Skip the object. |
135 ) | |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
136 ((eq def 'act-and-exit) |
304 | 137 ;; Act on the object and then exit. |
138 (funcall actor elt) | |
139 (setq actions (1+ actions) | |
140 next (function (lambda () nil)))) | |
2082
4b05402f3ac5
(map-y-or-n-p): Handle `quit' as answer.
Richard M. Stallman <rms@gnu.org>
parents:
2081
diff
changeset
|
141 ((eq def 'quit) |
4b05402f3ac5
(map-y-or-n-p): Handle `quit' as answer.
Richard M. Stallman <rms@gnu.org>
parents:
2081
diff
changeset
|
142 (setq quit-flag t) |
4b05402f3ac5
(map-y-or-n-p): Handle `quit' as answer.
Richard M. Stallman <rms@gnu.org>
parents:
2081
diff
changeset
|
143 (setq next (` (lambda () |
4b05402f3ac5
(map-y-or-n-p): Handle `quit' as answer.
Richard M. Stallman <rms@gnu.org>
parents:
2081
diff
changeset
|
144 (setq next '(, next)) |
4b05402f3ac5
(map-y-or-n-p): Handle `quit' as answer.
Richard M. Stallman <rms@gnu.org>
parents:
2081
diff
changeset
|
145 '(, elt))))) |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
146 ((eq def 'automatic) |
319 | 147 ;; Act on this and all following objects. |
148 (if (eval (funcall prompter elt)) | |
149 (progn | |
150 (funcall actor elt) | |
151 (setq actions (1+ actions)))) | |
474 | 152 (while (funcall next) |
319 | 153 (if (eval (funcall prompter elt)) |
304 | 154 (progn |
155 (funcall actor elt) | |
308 | 156 (setq actions (1+ actions)))))) |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
157 ((eq def 'help) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
158 (with-output-to-temp-buffer "*Help*" |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
159 (princ |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
160 (let ((object (if help (nth 0 help) "object")) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
161 (objects (if help (nth 1 help) "objects")) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
162 (action (if help (nth 2 help) "act on"))) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
163 (concat (format "Type SPC or `y' to %s the current %s; |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
164 DEL or `n' to skip the current %s; |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
165 ! to %s all remaining %s; |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
166 ESC or `q' to exit;\n" |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
167 action object object action objects) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
168 (mapconcat (function |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
169 (lambda (elt) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
170 (format "%c to %s" |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
171 (nth 0 elt) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
172 (nth 2 elt)))) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
173 action-alist |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
174 ";\n") |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
175 (if action-alist ";\n") |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
176 (format "or . (period) to %s \ |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
177 the current %s and exit." |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
178 action object))))) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
179 |
319 | 180 (setq next (` (lambda () |
181 (setq next '(, next)) | |
182 '(, elt))))) | |
2442
f692546797f9
(map-y-or-n-p): Make bindings of user-defined keys be each a vector
Roland McGrath <roland@gnu.org>
parents:
2082
diff
changeset
|
183 ((vectorp def) |
891 | 184 ;; A user-defined key. |
2442
f692546797f9
(map-y-or-n-p): Make bindings of user-defined keys be each a vector
Roland McGrath <roland@gnu.org>
parents:
2082
diff
changeset
|
185 (if (funcall (aref def 0) elt) ;Call its function. |
891 | 186 ;; The function has eaten this object. |
187 (setq actions (1+ actions)) | |
188 ;; Regurgitated; try again. | |
189 (setq next (` (lambda () | |
2081
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
190 (setq next '(, next)) |
2b04be5e47e6
(map-y-or-n-p): Use query-replace-map.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
191 '(, elt)))))) |
304 | 192 (t |
193 ;; Random char. | |
194 (message "Type %s for help." | |
195 (key-description (char-to-string help-char))) | |
196 (beep) | |
197 (sit-for 1) | |
319 | 198 (setq next (` (lambda () |
199 (setq next '(, next)) | |
200 '(, elt))))))) | |
304 | 201 (if (eval prompt) |
202 (progn | |
319 | 203 (funcall actor elt) |
204 (setq actions (1+ actions)))))) | |
304 | 205 ;; Clear the last prompt from the minibuffer. |
206 (message "") | |
207 ;; Return the number of actions that were taken. | |
208 actions)) | |
659
505130d1ddf8
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
580
diff
changeset
|
209 |
505130d1ddf8
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
580
diff
changeset
|
210 ;;; map-ynp.el ends here |