Mercurial > hg > xemacs-beta
annotate lisp/map-ynp.el @ 4810:6ee5e50a8772
Add a compiler macro for #'map, where CL-TYPE is constant and understood.
2010-01-07 Aidan Kehoe <kehoea@parhasard.net>
* cl-macs.el (map):
Add a compiler macro for this function, for cases where CL-TYPE is
constant and understood.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Thu, 07 Jan 2010 21:50:39 +0000 |
| parents | e29fcfd8df5f |
| children | 308d34e9f07d |
| rev | line source |
|---|---|
| 428 | 1 ;;; map-ynp.el --- General-purpose boolean question-asker. |
| 2 | |
| 3 ;; Copyright (C) 1991-1995, 1997 Free Software Foundation, Inc. | |
| 4 | |
| 5 ;; Author: Roland McGrath <roland@gnu.ai.mit.edu> | |
| 6 ;; Keywords: lisp, extensions, dumped | |
| 7 | |
| 8 ;; This file is part of XEmacs. | |
| 9 | |
| 10 ;; XEmacs is free software; you can redistribute it and/or modify it | |
| 11 ;; under the terms of the GNU General Public License as published by | |
| 12 ;; the Free Software Foundation; either version 2, or (at your option) | |
| 13 ;; any later version. | |
| 14 | |
| 15 ;; XEmacs is distributed in the hope that it will be useful, but | |
| 16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 18 ;; General Public License for more details. | |
| 19 | |
| 20 ;; You should have received a copy of the GNU General Public License | |
| 21 ;; along with XEmacs; see the file COPYING. If not, write to the Free | |
| 22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
| 23 ;; 02111-1307, USA. | |
| 24 | |
| 25 ;;; Synched up with: Emacs/Mule zeta. | |
| 26 | |
| 27 ;;; Commentary: | |
| 28 | |
| 29 ;; This file is dumped with XEmacs. | |
| 30 | |
| 31 ;; map-y-or-n-p is a general-purpose question-asking function. | |
| 32 ;; It asks a series of y/n questions (a la y-or-n-p), and decides to | |
| 2757 | 33 ;; apply an action to each element of a list based on the answer. |
| 428 | 34 ;; The nice thing is that you also get some other possible answers |
| 35 ;; to use, reminiscent of query-replace: ! to answer y to all remaining | |
| 36 ;; questions; ESC or q to answer n to all remaining questions; . to answer | |
| 37 ;; y once and then n for the remainder; and you can get help with C-h. | |
| 38 | |
| 39 ;;; Code: | |
| 40 | |
| 41 (defun map-y-or-n-p (prompter actor list &optional help action-alist | |
| 42 no-cursor-in-echo-area) | |
| 43 "Ask a series of boolean questions. | |
| 44 Takes args PROMPTER ACTOR LIST, and optional args HELP and ACTION-ALIST. | |
| 45 | |
| 46 LIST is a list of objects, or a function of no arguments to return the next | |
| 47 object or nil. | |
| 48 | |
| 49 If PROMPTER is a string, the prompt is \(format PROMPTER OBJECT\). If not | |
| 50 a string, PROMPTER is a function of one arg (an object from LIST), which | |
| 51 returns a string to be used as the prompt for that object. If the return | |
| 52 value is not a string, it may be nil to ignore the object or non-nil to act | |
| 53 on the object without asking the user. | |
| 54 | |
| 55 ACTOR is a function of one arg (an object from LIST), | |
| 56 which gets called with each object that the user answers `yes' for. | |
| 57 | |
| 58 If HELP is given, it is a list (OBJECT OBJECTS ACTION), | |
| 59 where OBJECT is a string giving the singular noun for an elt of LIST; | |
| 60 OBJECTS is the plural noun for elts of LIST, and ACTION is a transitive | |
| 61 verb describing ACTOR. The default is \(\"object\" \"objects\" \"act on\"\). | |
| 62 | |
| 63 At the prompts, the user may enter y, Y, or SPC to act on that object; | |
| 64 n, N, or DEL to skip that object; ! to act on all following objects; | |
| 65 ESC or q to exit (skip all following objects); . (period) to act on the | |
| 66 current object and then exit; or \\[help-command] to get help. | |
| 67 | |
| 68 If ACTION-ALIST is given, it is an alist (KEY FUNCTION HELP) of extra keys | |
| 69 that will be accepted. KEY is a character; FUNCTION is a function of one | |
| 70 arg (an object from LIST); HELP is a string. When the user hits KEY, | |
| 71 FUNCTION is called. If it returns non-nil, the object is considered | |
| 72 \"acted upon\", and the next object from LIST is processed. If it returns | |
| 73 nil, the prompt is repeated for the same object. | |
| 74 | |
| 75 Final optional argument NO-CURSOR-IN-ECHO-AREA non-nil says not to set | |
| 76 `cursor-in-echo-area' while prompting. | |
| 77 | |
| 78 This function uses `query-replace-map' to define the standard responses, | |
| 79 but not all of the responses which `query-replace' understands | |
| 80 are meaningful here. | |
| 81 | |
| 82 Returns the number of actions taken." | |
| 83 (let* ((actions 0) | |
| 84 user-keys mouse-event map prompt char elt def | |
| 85 ;; Non-nil means we should use mouse menus to ask. | |
| 86 ;; use-menus | |
| 87 ;;delayed-switch-frame | |
| 88 (next (if (or (and list (symbolp list)) | |
| 89 (subrp list) | |
| 90 (compiled-function-p list) | |
| 91 (and (consp list) | |
| 92 (eq (car list) 'lambda))) | |
| 93 #'(lambda () (setq elt (funcall list))) | |
| 94 #'(lambda () | |
| 95 (if list | |
| 96 (progn | |
| 97 (setq elt (car list) | |
| 98 list (cdr list)) | |
| 99 t) | |
| 100 nil))))) | |
| 101 (if (should-use-dialog-box-p) | |
| 102 ;; Make a list describing a dialog box. | |
| 103 (let (;; (object (capitalize (or (nth 0 help) "object"))) | |
| 104 ;; (objects (capitalize (or (nth 1 help) "objects"))) | |
| 105 ;; (action (capitalize (or (nth 2 help) "act on"))) | |
| 106 ) | |
| 442 | 107 (setq map `(("%_Yes" . act) ("%_No" . skip) |
| 428 | 108 ; bogus crap. --ben |
| 109 ; ((, (if help | |
| 110 ; (capitalize | |
| 111 ; (or (nth 3 help) | |
| 112 ; (concat action " All " objects))) | |
| 113 ; "Do All")) . automatic) | |
| 114 ; ((, (if help | |
| 115 ; (capitalize | |
| 116 ; (or (nth 4 help) | |
| 117 ; (concat action " " object " And Quit"))) | |
| 118 ; "Do it and Quit")) . act-and-exit) | |
| 119 ; ((, (capitalize | |
| 120 ; (or (and help (nth 5 help)) "Quit"))) | |
| 121 ; . exit) | |
| 442 | 122 ("Yes %_All" . automatic) |
| 123 ("No A%_ll" . exit) | |
| 124 ("%_Cancel" . quit) | |
| 428 | 125 ,@(mapcar #'(lambda (elt) |
| 126 (cons (capitalize (nth 2 elt)) | |
| 127 (vector (nth 1 elt)))) | |
| 128 action-alist)) | |
| 129 mouse-event last-command-event)) | |
| 130 (setq user-keys (if action-alist | |
| 131 (concat (mapconcat #'(lambda (elt) | |
| 132 (key-description | |
| 133 (if (characterp (car elt)) | |
| 134 ;; XEmacs | |
| 135 (char-to-string (car elt)) | |
| 136 (car elt)))) | |
| 137 action-alist ", ") | |
| 138 " ") | |
| 139 "") | |
| 140 ;; Make a map that defines each user key as a vector containing | |
| 141 ;; its definition. | |
| 142 ;; XEmacs | |
| 143 map (let ((foomap (make-sparse-keymap))) | |
|
4783
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4222
diff
changeset
|
144 (mapc #'(lambda (elt) |
|
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4222
diff
changeset
|
145 (define-key |
|
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4222
diff
changeset
|
146 foomap |
|
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4222
diff
changeset
|
147 (if (characterp (car elt)) |
|
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4222
diff
changeset
|
148 (char-to-string (car elt)) |
|
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4222
diff
changeset
|
149 (car elt)) |
|
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4222
diff
changeset
|
150 (vector (nth 1 elt)))) |
|
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4222
diff
changeset
|
151 action-alist) |
| 428 | 152 (set-keymap-parents foomap (list query-replace-map)) |
| 153 foomap))) | |
| 154 (unwind-protect | |
| 155 (progn | |
| 156 (if (stringp prompter) | |
| 157 (setq prompter `(lambda (object) | |
| 158 (format ,prompter object)))) | |
| 159 (while (funcall next) | |
| 160 (setq prompt (funcall prompter elt)) | |
| 161 (cond ((stringp prompt) | |
| 162 ;; Prompt the user about this object. | |
| 163 (setq quit-flag nil) | |
| 164 (if mouse-event ; XEmacs | |
| 4222 | 165 (setq def (or (and-fboundp |
| 166 #'get-dialog-box-response | |
| 167 (get-dialog-box-response | |
| 168 mouse-event | |
| 169 (cons prompt map))) | |
| 428 | 170 'quit)) |
| 171 ;; Prompt in the echo area. | |
| 172 (let ((cursor-in-echo-area (not no-cursor-in-echo-area))) | |
| 173 (display-message | |
| 174 'prompt | |
| 175 (format "%s(y, n, !, ., q, %sor %s) " | |
| 176 prompt user-keys | |
| 177 (key-description (vector help-char)))) | |
| 178 (setq char (next-command-event)) | |
| 179 ;; Show the answer to the question. | |
| 180 (display-message | |
| 181 'prompt | |
| 182 (format | |
| 183 "%s(y, n, !, ., q, %sor %s) %s" | |
| 184 prompt user-keys | |
| 185 (key-description (vector help-char)) | |
| 186 (single-key-description char)))) | |
| 187 (setq def (lookup-key map (vector char)))) | |
| 188 (cond ((eq def 'exit) | |
| 189 (setq next #'(lambda () nil))) | |
| 190 ((eq def 'act) | |
| 191 ;; Act on the object. | |
| 192 (funcall actor elt) | |
| 193 (setq actions (1+ actions))) | |
| 194 ((eq def 'skip) | |
| 195 ;; Skip the object. | |
| 196 ) | |
| 197 ((eq def 'act-and-exit) | |
| 198 ;; Act on the object and then exit. | |
| 199 (funcall actor elt) | |
| 200 (setq actions (1+ actions) | |
| 201 next (function (lambda () nil)))) | |
| 202 ((or (eq def 'quit) (eq def 'exit-prefix)) | |
| 203 (setq quit-flag t) | |
| 204 (setq next `(lambda () | |
| 205 (setq next ',next) | |
| 206 ',elt))) | |
| 207 ((eq def 'automatic) | |
| 208 ;; Act on this and all following objects. | |
| 209 ;; (if (funcall prompter elt) ; Emacs | |
| 210 (if (eval (funcall prompter elt)) | |
| 211 (progn | |
| 212 (funcall actor elt) | |
| 213 (setq actions (1+ actions)))) | |
| 214 (while (funcall next) | |
| 215 ;; (funcall prompter elt) ; Emacs | |
| 216 (if (eval (funcall prompter elt)) | |
| 217 (progn | |
| 218 (funcall actor elt) | |
| 219 (setq actions (1+ actions)))))) | |
| 220 ((eq def 'help) | |
| 221 (with-output-to-temp-buffer "*Help*" | |
| 222 (princ | |
| 223 (let ((object (if help (nth 0 help) "object")) | |
| 224 (objects (if help (nth 1 help) "objects")) | |
| 225 (action (if help (nth 2 help) "act on"))) | |
| 226 (concat | |
| 227 (format "Type SPC or `y' to %s the current %s; | |
| 228 DEL or `n' to skip the current %s; | |
| 229 ! to %s all remaining %s; | |
| 230 ESC or `q' to exit;\n" | |
| 231 action object object action objects) | |
| 232 (mapconcat (function | |
| 233 (lambda (elt) | |
| 234 (format "%c to %s" | |
| 235 (nth 0 elt) | |
| 2545 | 236 (downcase |
| 237 (normalize-menu-text | |
| 238 (nth 2 elt)))))) | |
| 428 | 239 action-alist |
| 240 ";\n") | |
| 241 (if action-alist ";\n") | |
| 242 (format "or . (period) to %s \ | |
| 243 the current %s and exit." | |
| 244 action object)))) | |
| 245 (save-excursion | |
| 246 (set-buffer standard-output) | |
| 247 (help-mode))) | |
| 248 | |
| 249 (setq next `(lambda () | |
| 250 (setq next ',next) | |
| 251 ',elt))) | |
| 252 ((vectorp def) | |
| 253 ;; A user-defined key. | |
| 254 (if (funcall (aref def 0) elt) ;Call its function. | |
| 255 ;; The function has eaten this object. | |
| 256 (setq actions (1+ actions)) | |
| 257 ;; Regurgitated; try again. | |
| 258 (setq next `(lambda () | |
| 259 (setq next ',next) | |
| 260 ',elt)))) | |
| 261 ;((and (consp char) ; Emacs | |
| 262 ; (eq (car char) 'switch-frame)) | |
| 263 ; ;; switch-frame event. Put it off until we're done. | |
| 264 ; (setq delayed-switch-frame char) | |
| 265 ; (setq next `(lambda () | |
| 266 ; (setq next ',next) | |
| 267 ; ',elt))) | |
| 268 (t | |
| 269 ;; Random char. | |
| 270 (message "Type %s for help." | |
| 271 (key-description (vector help-char))) | |
| 272 (beep) | |
| 273 (sit-for 1) | |
| 274 (setq next `(lambda () | |
| 275 (setq next ',next) | |
| 276 ',elt))))) | |
| 277 ((eval prompt) | |
| 278 (progn | |
| 279 (funcall actor elt) | |
| 280 (setq actions (1+ actions))))))) | |
| 281 ;;(if delayed-switch-frame | |
| 282 ;; (setq unread-command-events | |
| 283 ;; (cons delayed-switch-frame unread-command-events)))) | |
| 284 ;; ((eval prompt) | |
| 285 ;; (progn | |
| 286 ;; (funcall actor elt) | |
| 287 ;; (setq actions (1+ actions))))) | |
| 288 ) | |
| 289 ;; Clear the last prompt from the minibuffer. | |
| 290 (clear-message 'prompt) | |
| 291 ;; Return the number of actions that were taken. | |
| 292 actions)) | |
| 293 | |
| 294 ;;; map-ynp.el ends here |