[bpt/emacs.git] / lisp / map-ynp.el

;;; map-ynp.el --- general-purpose boolean question-asker

;; Copyright (C) 1991, 1992, 1993, 1994, 1995, 2000 Free Software Foundation, Inc.

;; Author: Roland McGrath <roland@gnu.org>
;; Maintainer: FSF
;; Keywords: lisp, extensions

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;; map-y-or-n-p is a general-purpose question-asking function.
;; It asks a series of y/n questions (a la y-or-n-p), and decides to
;; apply an action to each element of a list based on the answer.
;; The nice thing is that you also get some other possible answers
;; to use, reminiscent of query-replace: ! to answer y to all remaining
;; questions; ESC or q to answer n to all remaining questions; . to answer
;; y once and then n for the remainder; and you can get help with C-h.

;;; Code:

(defun map-y-or-n-p (prompter actor list &optional help action-alist
			      no-cursor-in-echo-area)
  "Ask a series of boolean questions.
Takes args PROMPTER ACTOR LIST, and optional args HELP and ACTION-ALIST.

LIST is a list of objects, or a function of no arguments to return the next
object or nil.

If PROMPTER is a string, the prompt is \(format PROMPTER OBJECT\).  If not
a string, PROMPTER is a function of one arg (an object from LIST), which
returns a string to be used as the prompt for that object.  If the return
value is not a string, it may be nil to ignore the object or non-nil to act
on the object without asking the user.

ACTOR is a function of one arg (an object from LIST),
which gets called with each object that the user answers `yes' for.

If HELP is given, it is a list (OBJECT OBJECTS ACTION),
where OBJECT is a string giving the singular noun for an elt of LIST;
OBJECTS is the plural noun for elts of LIST, and ACTION is a transitive
verb describing ACTOR.  The default is \(\"object\" \"objects\" \"act on\"\).

At the prompts, the user may enter y, Y, or SPC to act on that object;
n, N, or DEL to skip that object; ! to act on all following objects;
ESC or q to exit (skip all following objects); . (period) to act on the
current object and then exit; or \\[help-command] to get help.

If ACTION-ALIST is given, it is an alist (KEY FUNCTION HELP) of extra keys
that will be accepted.  KEY is a character; FUNCTION is a function of one
arg (an object from LIST); HELP is a string.  When the user hits KEY,
FUNCTION is called.  If it returns non-nil, the object is considered
\"acted upon\", and the next object from LIST is processed.  If it returns
nil, the prompt is repeated for the same object.

Final optional argument NO-CURSOR-IN-ECHO-AREA non-nil says not to set
`cursor-in-echo-area' while prompting.

This function uses `query-replace-map' to define the standard responses,
but not all of the responses which `query-replace' understands
are meaningful here.

Returns the number of actions taken."
  (let* ((actions 0)
	 user-keys mouse-event map prompt char elt tail def
	 ;; Non-nil means we should use mouse menus to ask.
	 use-menus
	 delayed-switch-frame
	 (next (if (or (and list (symbolp list))
		       (subrp list)
		       (byte-code-function-p list)
		       (and (consp list)
			    (eq (car list) 'lambda)))
		   (function (lambda ()
			       (setq elt (funcall list))))
		 (function (lambda ()
			     (if list
				 (progn
				   (setq elt (car list)
					 list (cdr list))
				   t)
			       nil))))))
    (if (and (listp last-nonmenu-event)
	     use-dialog-box)
	;; Make a list describing a dialog box.
	(let ((object (if help (capitalize (nth 0 help))))
	      (objects (if help (capitalize (nth 1 help))))
	      (action (if help (capitalize (nth 2 help)))))
	  (setq map `(("Yes" . act) ("No" . skip) ("Quit" . exit)
		      (,(if help (concat action " " object " And Quit")
			  "Do it and Quit") . act-and-exit)
		      (,(if help (concat action " All " objects)
			  "Do All") . automatic)
		      ,@(mapcar (lambda (elt)
				  (cons (capitalize (nth 2 elt))
					(vector (nth 1 elt))))
				action-alist))
		use-menus t
		mouse-event last-nonmenu-event))
      (setq user-keys (if action-alist
			  (concat (mapconcat (function
					      (lambda (elt)
						(key-description
						 (char-to-string (car elt)))))
					     action-alist ", ")
				  " ")
			"")
	    ;; Make a map that defines each user key as a vector containing
	    ;; its definition.
	    map (cons 'keymap
		      (append (mapcar (lambda (elt)
					(cons (car elt) (vector (nth 1 elt))))
				      action-alist)
			      query-replace-map))))
    (unwind-protect
	(progn
	  (if (stringp prompter)
	      (setq prompter `(lambda (object)
				(format ,prompter object))))
	  (while (funcall next)
	    (setq prompt (funcall prompter elt))
	    (cond ((stringp prompt)
		   ;; Prompt the user about this object.
		   (setq quit-flag nil)
		   (if use-menus
		       (setq def (or (x-popup-dialog (or mouse-event use-menus)
						     (cons prompt map))
				     'quit))
		     ;; Prompt in the echo area.
		     (let ((cursor-in-echo-area (not no-cursor-in-echo-area))
			   (message-log-max nil))
		       (message "%s(y, n, !, ., q, %sor %s) "
				prompt user-keys
				(key-description (vector help-char)))
		       (if minibuffer-auto-raise
			   (raise-frame (window-frame (minibuffer-window))))
		       (while (progn
				(setq char (read-event))
				;; If we get -1, from end of keyboard
				;; macro, try again.
                                (equal char -1)))
		       ;; Show the answer to the question.
		       (message "%s(y, n, !, ., q, %sor %s) %s"
				prompt user-keys
				(key-description (vector help-char))
				(single-key-description char)))
		     (setq def (lookup-key map (vector char))))
		   (cond ((eq def 'exit)
			  (setq next (function (lambda () nil))))
			 ((eq def 'act)
			  ;; Act on the object.
			  (funcall actor elt)
			  (setq actions (1+ actions)))
			 ((eq def 'skip)
			  ;; Skip the object.
			  )
			 ((eq def 'act-and-exit)
			  ;; Act on the object and then exit.
			  (funcall actor elt)
			  (setq actions (1+ actions)
				next (function (lambda () nil))))
			 ((or (eq def 'quit) (eq def 'exit-prefix))
			  (setq quit-flag t)
			  (setq next `(lambda ()
					(setq next ',next)
					',elt)))
			 ((eq def 'automatic)
			  ;; Act on this and all following objects.
			  (if (funcall prompter elt)
			      (progn
				(funcall actor elt)
				(setq actions (1+ actions))))
			  (while (funcall next)
			    (if (funcall prompter elt)
				(progn
				  (funcall actor elt)
				  (setq actions (1+ actions))))))
			 ((eq def 'help)
			  (with-output-to-temp-buffer "*Help*"
			    (princ
			     (let ((object (if help (nth 0 help) "object"))
				   (objects (if help (nth 1 help) "objects"))
				   (action (if help (nth 2 help) "act on")))
			       (concat
				(format "Type SPC or `y' to %s the current %s;
DEL or `n' to skip the current %s;
RET or `q' to exit (skip all remaining %s);
! to %s all remaining %s;
ESC or `q' to exit;\n"
					action object object objects action
					objects)
				(mapconcat (function
					    (lambda (elt)
					      (format "%c to %s"
						      (nth 0 elt)
						      (nth 2 elt))))
					   action-alist
					   ";\n")
				(if action-alist ";\n")
				(format "or . (period) to %s \
the current %s and exit."
					action object))))
			    (save-excursion
			      (set-buffer standard-output)
			      (help-mode)))

			  (setq next `(lambda ()
				       (setq next ',next)
				       ',elt)))
			 ((vectorp def)
			  ;; A user-defined key.
			  (if (funcall (aref def 0) elt) ;Call its function.
			      ;; The function has eaten this object.
			      (setq actions (1+ actions))
			    ;; Regurgitated; try again.
			    (setq next `(lambda ()
					 (setq next ',next)
					 ',elt))))
			 ((and (consp char)
			       (eq (car char) 'switch-frame))
			  ;; switch-frame event.  Put it off until we're done.
			  (setq delayed-switch-frame char)
			  (setq next `(lambda ()
				       (setq next ',next)
				       ',elt)))
			 (t
			  ;; Random char.
			  (message "Type %s for help."
				   (key-description (vector help-char)))
			  (beep)
			  (sit-for 1)
			  (setq next `(lambda ()
				       (setq next ',next)
				       ',elt)))))
		  (prompt
		   (funcall actor elt)
		   (setq actions (1+ actions))))))
      (if delayed-switch-frame
	  (setq unread-command-events
		(cons delayed-switch-frame unread-command-events))))
    ;; Clear the last prompt from the minibuffer.
    (let ((message-log-max nil))
      (message ""))
    ;; Return the number of actions that were taken.
    actions))

;;; map-ynp.el ends here
Commit	Line	Data
55535639	1	;;; map-ynp.el --- general-purpose boolean question-asker
6594deb0	2
b9b1c3a9	3	;; Copyright (C) 1991, 1992, 1993, 1994, 1995, 2000 Free Software Foundation, Inc.
eea8d4ef	4
5762abec	5	;; Author: Roland McGrath <roland@gnu.org>
5027054f	6	;; Maintainer: FSF
fd7fa35a	7	;; Keywords: lisp, extensions
e5167999	8
b578f267 EN	9	;; This file is part of GNU Emacs.
	10
	11	;; GNU Emacs is free software; you can redistribute it and/or modify
	12	;; it under the terms of the GNU General Public License as published by
	13	;; the Free Software Foundation; either version 2, or (at your option)
	14	;; any later version.
	15
	16	;; GNU Emacs is distributed in the hope that it will be useful,
	17	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	;; GNU General Public License for more details.
	20
	21	;; You should have received a copy of the GNU General Public License
	22	;; along with GNU Emacs; see the file COPYING. If not, write to the
	23	;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	24	;; Boston, MA 02111-1307, USA.
e5167999 ER	25
	26	;;; Commentary:
	27
b578f267 EN	28	;; map-y-or-n-p is a general-purpose question-asking function.
b578f267 EN	29	;; It asks a series of y/n questions (a la y-or-n-p), and decides to
68e3e5f5	30	;; apply an action to each element of a list based on the answer.
b578f267 EN	31	;; The nice thing is that you also get some other possible answers
	32	;; to use, reminiscent of query-replace: ! to answer y to all remaining
	33	;; questions; ESC or q to answer n to all remaining questions; . to answer
	34	;; y once and then n for the remainder; and you can get help with C-h.
60205e0b	35
e5167999 ER	36	;;; Code:
e5167999 ER	37
fd95709e RM	38	(defun map-y-or-n-p (prompter actor list &optional help action-alist
fd95709e RM	39	no-cursor-in-echo-area)
60205e0b	40	"Ask a series of boolean questions.
907482b9	41	Takes args PROMPTER ACTOR LIST, and optional args HELP and ACTION-ALIST.
60205e0b RM	42
	43	LIST is a list of objects, or a function of no arguments to return the next
	44	object or nil.
	45
9fd54390	46	If PROMPTER is a string, the prompt is \(format PROMPTER OBJECT\). If not
03759fe0 RM	47	a string, PROMPTER is a function of one arg (an object from LIST), which
03759fe0 RM	48	returns a string to be used as the prompt for that object. If the return
933fb957 RM	49	value is not a string, it may be nil to ignore the object or non-nil to act
933fb957 RM	50	on the object without asking the user.
03759fe0	51
60205e0b RM	52	ACTOR is a function of one arg (an object from LIST),
	53	which gets called with each object that the user answers `yes' for.
	54
	55	If HELP is given, it is a list (OBJECT OBJECTS ACTION),
	56	where OBJECT is a string giving the singular noun for an elt of LIST;
	57	OBJECTS is the plural noun for elts of LIST, and ACTION is a transitive
	58	verb describing ACTOR. The default is \(\"object\" \"objects\" \"act on\"\).
	59
	60	At the prompts, the user may enter y, Y, or SPC to act on that object;
	61	n, N, or DEL to skip that object; ! to act on all following objects;
	62	ESC or q to exit (skip all following objects); . (period) to act on the
	63	current object and then exit; or \\[help-command] to get help.
	64
907482b9 RM	65	If ACTION-ALIST is given, it is an alist (KEY FUNCTION HELP) of extra keys
	66	that will be accepted. KEY is a character; FUNCTION is a function of one
	67	arg (an object from LIST); HELP is a string. When the user hits KEY,
	68	FUNCTION is called. If it returns non-nil, the object is considered
	69	\"acted upon\", and the next object from LIST is processed. If it returns
	70	nil, the prompt is repeated for the same object.
	71
fd95709e RM	72	Final optional argument NO-CURSOR-IN-ECHO-AREA non-nil says not to set
	73	`cursor-in-echo-area' while prompting.
	74
0a2eb25e RS	75	This function uses `query-replace-map' to define the standard responses,
	76	but not all of the responses which `query-replace' understands
	77	are meaningful here.
	78
60205e0b	79	Returns the number of actions taken."
c5068ec5 RM	80	(let* ((actions 0)
c5068ec5 RM	81	user-keys mouse-event map prompt char elt tail def
5233c7f5 RS	82	;; Non-nil means we should use mouse menus to ask.
5233c7f5 RS	83	use-menus
c5068ec5	84	delayed-switch-frame
fba98516	85	(next (if (or (and list (symbolp list))
aa228418	86	(subrp list)
dbc4e1c1	87	(byte-code-function-p list)
aa228418 JB	88	(and (consp list)
	89	(eq (car list) 'lambda)))
	90	(function (lambda ()
	91	(setq elt (funcall list))))
	92	(function (lambda ()
	93	(if list
	94	(progn
	95	(setq elt (car list)
	96	list (cdr list))
	97	t)
	98	nil))))))
b9b1c3a9 DL	99	(if (and (listp last-nonmenu-event)
b9b1c3a9 DL	100	use-dialog-box)
c5068ec5	101	;; Make a list describing a dialog box.
b9b1c3a9 DL	102	(let ((object (if help (capitalize (nth 0 help))))
	103	(objects (if help (capitalize (nth 1 help))))
	104	(action (if help (capitalize (nth 2 help)))))
	105	(setq map `(("Yes" . act) ("No" . skip) ("Quit" . exit)
	106	(,(if help (concat action " " object " And Quit")
	107	"Do it and Quit") . act-and-exit)
	108	(,(if help (concat action " All " objects)
	109	"Do All") . automatic)
	110	,@(mapcar (lambda (elt)
	111	(cons (capitalize (nth 2 elt))
	112	(vector (nth 1 elt))))
	113	action-alist))
5233c7f5	114	use-menus t
4f837d3b	115	mouse-event last-nonmenu-event))
c5068ec5 RM	116	(setq user-keys (if action-alist
	117	(concat (mapconcat (function
	118	(lambda (elt)
	119	(key-description
	120	(char-to-string (car elt)))))
	121	action-alist ", ")
	122	" ")
	123	"")
	124	;; Make a map that defines each user key as a vector containing
	125	;; its definition.
	126	map (cons 'keymap
	127	(append (mapcar (lambda (elt)
	128	(cons (car elt) (vector (nth 1 elt))))
	129	action-alist)
	130	query-replace-map))))
3eea8aa2 JB	131	(unwind-protect
	132	(progn
	133	(if (stringp prompter)
b9b1c3a9 DL	134	(setq prompter `(lambda (object)
b9b1c3a9 DL	135	(format ,prompter object))))
3eea8aa2 JB	136	(while (funcall next)
3eea8aa2 JB	137	(setq prompt (funcall prompter elt))
933fb957 RM	138	(cond ((stringp prompt)
	139	;; Prompt the user about this object.
	140	(setq quit-flag nil)
5233c7f5 RS	141	(if use-menus
5233c7f5 RS	142	(setq def (or (x-popup-dialog (or mouse-event use-menus)
933fb957 RM	143	(cons prompt map))
	144	'quit))
	145	;; Prompt in the echo area.
	146	(let ((cursor-in-echo-area (not no-cursor-in-echo-area))
	147	(message-log-max nil))
	148	(message "%s(y, n, !, ., q, %sor %s) "
	149	prompt user-keys
	150	(key-description (vector help-char)))
55b4b20a RS	151	(if minibuffer-auto-raise
55b4b20a RS	152	(raise-frame (window-frame (minibuffer-window))))
3f72fac8 PR	153	(while (progn
	154	(setq char (read-event))
	155	;; If we get -1, from end of keyboard
	156	;; macro, try again.
03d50ed6	157	(equal char -1)))
933fb957 RM	158	;; Show the answer to the question.
	159	(message "%s(y, n, !, ., q, %sor %s) %s"
	160	prompt user-keys
	161	(key-description (vector help-char))
	162	(single-key-description char)))
	163	(setq def (lookup-key map (vector char))))
	164	(cond ((eq def 'exit)
	165	(setq next (function (lambda () nil))))
	166	((eq def 'act)
	167	;; Act on the object.
	168	(funcall actor elt)
	169	(setq actions (1+ actions)))
	170	((eq def 'skip)
	171	;; Skip the object.
	172	)
	173	((eq def 'act-and-exit)
	174	;; Act on the object and then exit.
	175	(funcall actor elt)
	176	(setq actions (1+ actions)
	177	next (function (lambda () nil))))
	178	((or (eq def 'quit) (eq def 'exit-prefix))
	179	(setq quit-flag t)
b9b1c3a9 DL	180	(setq next `(lambda ()
	181	(setq next ',next)
	182	',elt)))
933fb957 RM	183	((eq def 'automatic)
	184	;; Act on this and all following objects.
	185	(if (funcall prompter elt)
	186	(progn
	187	(funcall actor elt)
	188	(setq actions (1+ actions))))
	189	(while (funcall next)
	190	(if (funcall prompter elt)
	191	(progn
	192	(funcall actor elt)
	193	(setq actions (1+ actions))))))
	194	((eq def 'help)
	195	(with-output-to-temp-buffer "Help"
	196	(princ
	197	(let ((object (if help (nth 0 help) "object"))
	198	(objects (if help (nth 1 help) "objects"))
	199	(action (if help (nth 2 help) "act on")))
	200	(concat
	201	(format "Type SPC or `y' to %s the current %s;
0a2eb25e	202	DEL or `n' to skip the current %s;
c733d4ce	203	RET or `q' to exit (skip all remaining %s);
0a2eb25e RS	204	! to %s all remaining %s;
0a2eb25e RS	205	ESC or `q' to exit;\n"
c733d4ce DL	206	action object object objects action
c733d4ce DL	207	objects)
933fb957 RM	208	(mapconcat (function
	209	(lambda (elt)
	210	(format "%c to %s"
	211	(nth 0 elt)
	212	(nth 2 elt))))
	213	action-alist
	214	";\n")
	215	(if action-alist ";\n")
	216	(format "or . (period) to %s \
0a2eb25e	217	the current %s and exit."
933fb957 RM	218	action object))))
	219	(save-excursion
	220	(set-buffer standard-output)
	221	(help-mode)))
	222
4f837d3b	223	(setq next `(lambda ()
b9b1c3a9 DL	224	(setq next ',next)
b9b1c3a9 DL	225	',elt)))
933fb957 RM	226	((vectorp def)
	227	;; A user-defined key.
	228	(if (funcall (aref def 0) elt) ;Call its function.
	229	;; The function has eaten this object.
	230	(setq actions (1+ actions))
	231	;; Regurgitated; try again.
4f837d3b	232	(setq next `(lambda ()
b9b1c3a9 DL	233	(setq next ',next)
b9b1c3a9 DL	234	',elt))))
933fb957 RM	235	((and (consp char)
	236	(eq (car char) 'switch-frame))
	237	;; switch-frame event. Put it off until we're done.
	238	(setq delayed-switch-frame char)
4f837d3b	239	(setq next `(lambda ()
b9b1c3a9 DL	240	(setq next ',next)
b9b1c3a9 DL	241	',elt)))
933fb957 RM	242	(t
	243	;; Random char.
	244	(message "Type %s for help."
	245	(key-description (vector help-char)))
	246	(beep)
	247	(sit-for 1)
4f837d3b	248	(setq next `(lambda ()
b9b1c3a9 DL	249	(setq next ',next)
b9b1c3a9 DL	250	',elt)))))
933fb957 RM	251	(prompt
	252	(funcall actor elt)
	253	(setq actions (1+ actions))))))
3eea8aa2 JB	254	(if delayed-switch-frame
	255	(setq unread-command-events
	256	(cons delayed-switch-frame unread-command-events))))
60205e0b	257	;; Clear the last prompt from the minibuffer.
a66839ce KH	258	(let ((message-log-max nil))
a66839ce KH	259	(message ""))
60205e0b RM	260	;; Return the number of actions that were taken.
60205e0b RM	261	actions))
6594deb0 ER	262
6594deb0 ER	263	;;; map-ynp.el ends here