1 ;;; map-ynp.el --- general-purpose boolean question-asker
3 ;; Copyright (C) 1991, 1992, 1993, 1994, 1995, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Roland McGrath <roland@gnu.org>
8 ;; Keywords: lisp, extensions
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; map-y-or-n-p is a general-purpose question-asking function.
28 ;; It asks a series of y/n questions (a la y-or-n-p), and decides to
29 ;; apply an action to each element of a list based on the answer.
30 ;; The nice thing is that you also get some other possible answers
31 ;; to use, reminiscent of query-replace: ! to answer y to all remaining
32 ;; questions; ESC or q to answer n to all remaining questions; . to answer
33 ;; y once and then n for the remainder; and you can get help with C-h.
37 (declare-function x-popup-dialog
"xmenu.c" (position contents
&optional header
))
39 (defun map-y-or-n-p (prompter actor list
&optional help action-alist
40 no-cursor-in-echo-area
)
41 "Ask a series of boolean questions.
42 Takes args PROMPTER ACTOR LIST, and optional args HELP and ACTION-ALIST.
44 LIST is a list of objects, or a function of no arguments to return the next
47 If PROMPTER is a string, the prompt is \(format PROMPTER OBJECT\). If not
48 a string, PROMPTER is a function of one arg (an object from LIST), which
49 returns a string to be used as the prompt for that object. If the return
50 value is not a string, it may be nil to ignore the object or non-nil to act
51 on the object without asking the user.
53 ACTOR is a function of one arg (an object from LIST),
54 which gets called with each object that the user answers `yes' for.
56 If HELP is given, it is a list (OBJECT OBJECTS ACTION),
57 where OBJECT is a string giving the singular noun for an elt of LIST;
58 OBJECTS is the plural noun for elts of LIST, and ACTION is a transitive
59 verb describing ACTOR. The default is \(\"object\" \"objects\" \"act on\"\).
61 At the prompts, the user may enter y, Y, or SPC to act on that object;
62 n, N, or DEL to skip that object; ! to act on all following objects;
63 ESC or q to exit (skip all following objects); . (period) to act on the
64 current object and then exit; or \\[help-command] to get help.
66 If ACTION-ALIST is given, it is an alist (KEY FUNCTION HELP) of extra keys
67 that will be accepted. KEY is a character; FUNCTION is a function of one
68 arg (an object from LIST); HELP is a string. When the user hits KEY,
69 FUNCTION is called. If it returns non-nil, the object is considered
70 \"acted upon\", and the next object from LIST is processed. If it returns
71 nil, the prompt is repeated for the same object.
73 Final optional argument NO-CURSOR-IN-ECHO-AREA non-nil says not to set
74 `cursor-in-echo-area' while prompting.
76 This function uses `query-replace-map' to define the standard responses,
77 but not all of the responses which `query-replace' understands
80 Returns the number of actions taken."
82 user-keys mouse-event map prompt char elt tail def
83 ;; Non-nil means we should use mouse menus to ask.
86 ;; Rebind other-window-scroll-buffer so that subfunctions can set
87 ;; it temporarily, without risking affecting the caller.
88 (other-window-scroll-buffer other-window-scroll-buffer
)
89 (next (if (functionp list
)
90 (lambda () (setq elt
(funcall list
)))
94 (if (and (listp last-nonmenu-event
)
96 ;; Make a list describing a dialog box.
97 (let ((object (if help
(capitalize (nth 0 help
))))
98 (objects (if help
(capitalize (nth 1 help
))))
99 (action (if help
(capitalize (nth 2 help
)))))
100 (setq map
`(("Yes" . act
) ("No" . skip
)
101 ,@(mapcar (lambda (elt)
102 (cons (with-syntax-table
103 text-mode-syntax-table
104 (capitalize (nth 2 elt
)))
105 (vector (nth 1 elt
))))
107 (,(if help
(concat action
" This But No More")
108 "Do This But No More") . act-and-exit
)
109 (,(if help
(concat action
" All " objects
)
110 "Do All") . automatic
)
111 ("No For All" . exit
))
113 mouse-event last-nonmenu-event
))
114 (setq user-keys
(if action-alist
115 (concat (mapconcat (lambda (elt)
121 ;; Make a map that defines each user key as a vector containing
124 (let ((map (make-sparse-keymap)))
125 (set-keymap-parent map query-replace-map
)
126 (define-key map
[?\C-\M-v
] 'scroll-other-window
)
127 (define-key map
[M-next
] 'scroll-other-window
)
128 (define-key map
[?\C-\M-\S-v
] 'scroll-other-window-down
)
129 (define-key map
[M-prior
] 'scroll-other-window-down
)
130 ;; The above are rather inconvenient, so maybe we should
131 ;; provide the non-other keys for the other-scroll as well.
132 ;; (define-key map [?\C-v] 'scroll-other-window)
133 ;; (define-key map [next] 'scroll-other-window)
134 ;; (define-key map [?\M-v] 'scroll-other-window-down)
135 ;; (define-key map [prior] 'scroll-other-window-down)
136 (dolist (elt action-alist
)
137 (define-key map
(vector (car elt
)) (vector (nth 1 elt
))))
141 (if (stringp prompter
)
142 (setq prompter
`(lambda (object)
143 (format ,prompter object
))))
144 (while (funcall next
)
145 (setq prompt
(funcall prompter elt
))
146 (cond ((stringp prompt
)
147 ;; Prompt the user about this object.
150 (setq def
(or (x-popup-dialog (or mouse-event use-menus
)
153 ;; Prompt in the echo area.
154 (let ((cursor-in-echo-area (not no-cursor-in-echo-area
))
155 (message-log-max nil
))
156 (message (apply 'propertize
"%s(y, n, !, ., q, %sor %s) "
157 minibuffer-prompt-properties
)
159 (key-description (vector help-char
)))
160 (if minibuffer-auto-raise
161 (raise-frame (window-frame (minibuffer-window))))
163 (setq char
(read-event))
164 ;; If we get -1, from end of keyboard
167 ;; Show the answer to the question.
168 (message "%s(y, n, !, ., q, %sor %s) %s"
170 (key-description (vector help-char
))
171 (single-key-description char
)))
172 (setq def
(lookup-key map
(vector char
))))
173 (cond ((eq def
'exit
)
174 (setq next
(lambda () nil
)))
176 ;; Act on the object.
178 (setq actions
(1+ actions
)))
182 ((eq def
'act-and-exit
)
183 ;; Act on the object and then exit.
185 (setq actions
(1+ actions
)
186 next
(lambda () nil
)))
189 (setq next
`(lambda ()
193 ;; Act on this and all following objects.
194 (if (funcall prompter elt
)
197 (setq actions
(1+ actions
))))
198 (while (funcall next
)
199 (if (funcall prompter elt
)
202 (setq actions
(1+ actions
))))))
204 (with-output-to-temp-buffer "*Help*"
206 (let ((object (if help
(nth 0 help
) "object"))
207 (objects (if help
(nth 1 help
) "objects"))
208 (action (if help
(nth 2 help
) "act on")))
210 (format "Type SPC or `y' to %s the current %s;
211 DEL or `n' to skip the current %s;
212 RET or `q' to give up on the %s (skip all remaining %s);
213 C-g to quit (cancel the whole command);
214 ! to %s all remaining %s;\n"
215 action object object action objects action
220 (single-key-description
225 (if action-alist
";\n")
226 (format "or . (period) to %s \
227 the current %s and exit."
229 (with-current-buffer standard-output
232 (setq next
`(lambda ()
235 ((and (symbolp def
) (commandp def
))
236 (call-interactively def
)
237 ;; Regurgitated; try again.
238 (setq next
`(lambda ()
242 ;; A user-defined key.
243 (if (funcall (aref def
0) elt
) ;Call its function.
244 ;; The function has eaten this object.
245 (setq actions
(1+ actions
))
246 ;; Regurgitated; try again.
247 (setq next
`(lambda ()
251 (eq (car char
) 'switch-frame
))
252 ;; switch-frame event. Put it off until we're done.
253 (setq delayed-switch-frame char
)
254 (setq next
`(lambda ()
259 (message "Type %s for help."
260 (key-description (vector help-char
)))
263 (setq next
`(lambda ()
268 (setq actions
(1+ actions
))))))
269 (if delayed-switch-frame
270 (setq unread-command-events
271 (cons delayed-switch-frame unread-command-events
))))
272 ;; Clear the last prompt from the minibuffer.
273 (let ((message-log-max nil
))
275 ;; Return the number of actions that were taken.
278 ;; arch-tag: 1d0a3201-a151-4c10-b231-4da47c9e6dc3
279 ;;; map-ynp.el ends here