* editfns.c (Ftranspose_regions): Doc fix (Bug#3248).
[bpt/emacs.git] / lisp / emacs-lisp / cl-macs.el
CommitLineData
bc8ce89b 1;;; cl-macs.el --- Common Lisp macros
fcd73769 2
ae940284 3;; Copyright (C) 1993, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
d59c3137 4;; Free Software Foundation, Inc.
fcd73769
RS
5
6;; Author: Dave Gillespie <daveg@synaptics.com>
7;; Version: 2.02
8;; Keywords: extensions
9
10;; This file is part of GNU Emacs.
11
d6cba7ae 12;; GNU Emacs is free software: you can redistribute it and/or modify
fcd73769 13;; it under the terms of the GNU General Public License as published by
d6cba7ae
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
fcd73769
RS
16
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.
21
22;; You should have received a copy of the GNU General Public License
d6cba7ae 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
fcd73769 24
07b3798c 25;;; Commentary:
fcd73769
RS
26
27;; These are extensions to Emacs Lisp that provide a degree of
28;; Common Lisp compatibility, beyond what is already built-in
29;; in Emacs Lisp.
30;;
31;; This package was written by Dave Gillespie; it is a complete
32;; rewrite of Cesar Quiroz's original cl.el package of December 1986.
33;;
fcd73769
RS
34;; Bug reports, comments, and suggestions are welcome!
35
36;; This file contains the portions of the Common Lisp extensions
37;; package which should be autoloaded, but need only be present
38;; if the compiler or interpreter is used---this file is not
39;; necessary for executing compiled code.
40
41;; See cl.el for Change Log.
42
43
07b3798c 44;;; Code:
fcd73769 45
56565c74 46(require 'cl)
fcd73769 47
fcd73769
RS
48(defmacro cl-pop2 (place)
49 (list 'prog1 (list 'car (list 'cdr place))
50 (list 'setq place (list 'cdr (list 'cdr place)))))
fcd73769
RS
51(put 'cl-pop2 'edebug-form-spec 'edebug-sexps)
52
fcd73769
RS
53(defvar cl-optimize-safety)
54(defvar cl-optimize-speed)
55
56
d0aa0542
SM
57;; This kludge allows macros which use cl-transform-function-property
58;; to be called at compile-time.
fcd73769
RS
59
60(require
61 (progn
fcd73769
RS
62 (or (fboundp 'cl-transform-function-property)
63 (defalias 'cl-transform-function-property
64 (function (lambda (n p f)
65 (list 'put (list 'quote n) (list 'quote p)
66 (list 'function (cons 'lambda f)))))))
67 (car (or features (setq features (list 'cl-kludge))))))
68
69
70;;; Initialization.
71
72(defvar cl-old-bc-file-form nil)
73
b7b95a1e
DL
74;;; Some predicates for analyzing Lisp forms. These are used by various
75;;; macro expanders to optimize the results in certain common cases.
76
77(defconst cl-simple-funcs '(car cdr nth aref elt if and or + - 1+ 1- min max
78 car-safe cdr-safe progn prog1 prog2))
79(defconst cl-safe-funcs '(* / % length memq list vector vectorp
80 < > <= >= = error))
81
82;;; Check if no side effects, and executes quickly.
83(defun cl-simple-expr-p (x &optional size)
84 (or size (setq size 10))
85 (if (and (consp x) (not (memq (car x) '(quote function function*))))
86 (and (symbolp (car x))
87 (or (memq (car x) cl-simple-funcs)
88 (get (car x) 'side-effect-free))
89 (progn
90 (setq size (1- size))
91 (while (and (setq x (cdr x))
92 (setq size (cl-simple-expr-p (car x) size))))
93 (and (null x) (>= size 0) size)))
94 (and (> size 0) (1- size))))
95
96(defun cl-simple-exprs-p (xs)
97 (while (and xs (cl-simple-expr-p (car xs)))
98 (setq xs (cdr xs)))
99 (not xs))
100
101;;; Check if no side effects.
102(defun cl-safe-expr-p (x)
103 (or (not (and (consp x) (not (memq (car x) '(quote function function*)))))
104 (and (symbolp (car x))
105 (or (memq (car x) cl-simple-funcs)
106 (memq (car x) cl-safe-funcs)
107 (get (car x) 'side-effect-free))
108 (progn
109 (while (and (setq x (cdr x)) (cl-safe-expr-p (car x))))
110 (null x)))))
111
112;;; Check if constant (i.e., no side effects or dependencies).
113(defun cl-const-expr-p (x)
114 (cond ((consp x)
115 (or (eq (car x) 'quote)
116 (and (memq (car x) '(function function*))
117 (or (symbolp (nth 1 x))
118 (and (eq (car-safe (nth 1 x)) 'lambda) 'func)))))
119 ((symbolp x) (and (memq x '(nil t)) t))
120 (t t)))
121
122(defun cl-const-exprs-p (xs)
123 (while (and xs (cl-const-expr-p (car xs)))
124 (setq xs (cdr xs)))
125 (not xs))
126
127(defun cl-const-expr-val (x)
128 (and (eq (cl-const-expr-p x) t) (if (consp x) (nth 1 x) x)))
129
130(defun cl-expr-access-order (x v)
131 (if (cl-const-expr-p x) v
132 (if (consp x)
133 (progn
134 (while (setq x (cdr x)) (setq v (cl-expr-access-order (car x) v)))
135 v)
136 (if (eq x (car v)) (cdr v) '(t)))))
137
138;;; Count number of times X refers to Y. Return nil for 0 times.
139(defun cl-expr-contains (x y)
140 (cond ((equal y x) 1)
141 ((and (consp x) (not (memq (car-safe x) '(quote function function*))))
142 (let ((sum 0))
143 (while x
144 (setq sum (+ sum (or (cl-expr-contains (pop x) y) 0))))
145 (and (> sum 0) sum)))
146 (t nil)))
147
148(defun cl-expr-contains-any (x y)
149 (while (and y (not (cl-expr-contains x (car y)))) (pop y))
150 y)
151
152;;; Check whether X may depend on any of the symbols in Y.
153(defun cl-expr-depends-p (x y)
154 (and (not (cl-const-expr-p x))
155 (or (not (cl-safe-expr-p x)) (cl-expr-contains-any x y))))
156
fcd73769
RS
157;;; Symbols.
158
159(defvar *gensym-counter*)
ebacfcc6 160;;;###autoload
a766dfa1 161(defun gensym (&optional prefix)
fcd73769
RS
162 "Generate a new uninterned symbol.
163The name is made by appending a number to PREFIX, default \"G\"."
a766dfa1
JB
164 (let ((pfix (if (stringp prefix) prefix "G"))
165 (num (if (integerp prefix) prefix
fcd73769
RS
166 (prog1 *gensym-counter*
167 (setq *gensym-counter* (1+ *gensym-counter*))))))
a766dfa1 168 (make-symbol (format "%s%d" pfix num))))
fcd73769 169
ebacfcc6 170;;;###autoload
a766dfa1 171(defun gentemp (&optional prefix)
fcd73769
RS
172 "Generate a new interned symbol with a unique name.
173The name is made by appending a number to PREFIX, default \"G\"."
a766dfa1 174 (let ((pfix (if (stringp prefix) prefix "G"))
fcd73769 175 name)
a766dfa1 176 (while (intern-soft (setq name (format "%s%d" pfix *gensym-counter*)))
fcd73769
RS
177 (setq *gensym-counter* (1+ *gensym-counter*)))
178 (intern name)))
179
180
181;;; Program structure.
182
ebacfcc6 183;;;###autoload
fcd73769 184(defmacro defun* (name args &rest body)
69d8fb1e 185 "Define NAME as a function.
fcd73769 186Like normal `defun', except ARGLIST allows full Common Lisp conventions,
69d8fb1e
SM
187and BODY is implicitly surrounded by (block NAME ...).
188
189\(fn NAME ARGLIST [DOCSTRING] BODY...)"
fcd73769
RS
190 (let* ((res (cl-transform-lambda (cons args body) name))
191 (form (list* 'defun name (cdr res))))
192 (if (car res) (list 'progn (car res) form) form)))
193
ebacfcc6 194;;;###autoload
fcd73769 195(defmacro defmacro* (name args &rest body)
69d8fb1e 196 "Define NAME as a macro.
fcd73769 197Like normal `defmacro', except ARGLIST allows full Common Lisp conventions,
69d8fb1e
SM
198and BODY is implicitly surrounded by (block NAME ...).
199
200\(fn NAME ARGLIST [DOCSTRING] BODY...)"
fcd73769
RS
201 (let* ((res (cl-transform-lambda (cons args body) name))
202 (form (list* 'defmacro name (cdr res))))
203 (if (car res) (list 'progn (car res) form) form)))
204
ebacfcc6 205;;;###autoload
fcd73769 206(defmacro function* (func)
64a4c526 207 "Introduce a function.
3187ba1c
JB
208Like normal `function', except that if argument is a lambda form,
209its argument list allows full Common Lisp conventions."
fcd73769
RS
210 (if (eq (car-safe func) 'lambda)
211 (let* ((res (cl-transform-lambda (cdr func) 'cl-none))
212 (form (list 'function (cons 'lambda (cdr res)))))
213 (if (car res) (list 'progn (car res) form) form))
214 (list 'function func)))
215
216(defun cl-transform-function-property (func prop form)
217 (let ((res (cl-transform-lambda form func)))
218 (append '(progn) (cdr (cdr (car res)))
219 (list (list 'put (list 'quote func) (list 'quote prop)
220 (list 'function (cons 'lambda (cdr res))))))))
221
222(defconst lambda-list-keywords
223 '(&optional &rest &key &allow-other-keys &aux &whole &body &environment))
224
225(defvar cl-macro-environment nil)
226(defvar bind-block) (defvar bind-defs) (defvar bind-enquote)
227(defvar bind-inits) (defvar bind-lets) (defvar bind-forms)
228
229(defun cl-transform-lambda (form bind-block)
69d8fb1e 230 (let* ((args (car form)) (body (cdr form)) (orig-args args)
fcd73769
RS
231 (bind-defs nil) (bind-enquote nil)
232 (bind-inits nil) (bind-lets nil) (bind-forms nil)
233 (header nil) (simple-args nil))
a5ad278d
EZ
234 (while (or (stringp (car body))
235 (memq (car-safe (car body)) '(interactive declare)))
69d8fb1e 236 (push (pop body) header))
fcd73769
RS
237 (setq args (if (listp args) (copy-list args) (list '&rest args)))
238 (let ((p (last args))) (if (cdr p) (setcdr p (list '&rest (cdr p)))))
239 (if (setq bind-defs (cadr (memq '&cl-defs args)))
240 (setq args (delq '&cl-defs (delq bind-defs args))
241 bind-defs (cadr bind-defs)))
242 (if (setq bind-enquote (memq '&cl-quote args))
243 (setq args (delq '&cl-quote args)))
244 (if (memq '&whole args) (error "&whole not currently implemented"))
245 (let* ((p (memq '&environment args)) (v (cadr p)))
246 (if p (setq args (nconc (delq (car p) (delq v args))
247 (list '&aux (list v 'cl-macro-environment))))))
248 (while (and args (symbolp (car args))
249 (not (memq (car args) '(nil &rest &body &key &aux)))
250 (not (and (eq (car args) '&optional)
251 (or bind-defs (consp (cadr args))))))
69d8fb1e 252 (push (pop args) simple-args))
fcd73769
RS
253 (or (eq bind-block 'cl-none)
254 (setq body (list (list* 'block bind-block body))))
255 (if (null args)
256 (list* nil (nreverse simple-args) (nconc (nreverse header) body))
69d8fb1e 257 (if (memq '&optional simple-args) (push '&optional args))
fcd73769
RS
258 (cl-do-arglist args nil (- (length simple-args)
259 (if (memq '&optional simple-args) 1 0)))
260 (setq bind-lets (nreverse bind-lets))
261 (list* (and bind-inits (list* 'eval-when '(compile load eval)
262 (nreverse bind-inits)))
263 (nconc (nreverse simple-args)
69d8fb1e
SM
264 (list '&rest (car (pop bind-lets))))
265 (nconc (let ((hdr (nreverse header)))
4d78a860
SM
266 ;; Macro expansion can take place in the middle of
267 ;; apparently harmless computation, so it should not
268 ;; touch the match-data.
269 (save-match-data
270 (require 'help-fns)
271 (cons (help-add-fundoc-usage
272 (if (stringp (car hdr)) (pop hdr))
273 ;; orig-args can contain &cl-defs (an internal
274 ;; CL thingy I don't understand), so remove it.
275 (let ((x (memq '&cl-defs orig-args)))
276 (if (null x) orig-args
277 (delq (car x) (remq (cadr x) orig-args)))))
278 hdr)))
fcd73769
RS
279 (list (nconc (list 'let* bind-lets)
280 (nreverse bind-forms) body)))))))
281
282(defun cl-do-arglist (args expr &optional num) ; uses bind-*
283 (if (nlistp args)
284 (if (or (memq args lambda-list-keywords) (not (symbolp args)))
285 (error "Invalid argument name: %s" args)
69d8fb1e 286 (push (list args expr) bind-lets))
fcd73769
RS
287 (setq args (copy-list args))
288 (let ((p (last args))) (if (cdr p) (setcdr p (list '&rest (cdr p)))))
289 (let ((p (memq '&body args))) (if p (setcar p '&rest)))
290 (if (memq '&environment args) (error "&environment used incorrectly"))
291 (let ((save-args args)
292 (restarg (memq '&rest args))
293 (safety (if (cl-compiling-file) cl-optimize-safety 3))
294 (keys nil)
295 (laterarg nil) (exactarg nil) minarg)
296 (or num (setq num 0))
297 (if (listp (cadr restarg))
e542ea4b 298 (setq restarg (make-symbol "--cl-rest--"))
fcd73769 299 (setq restarg (cadr restarg)))
69d8fb1e 300 (push (list restarg expr) bind-lets)
fcd73769 301 (if (eq (car args) '&whole)
69d8fb1e 302 (push (list (cl-pop2 args) restarg) bind-lets))
fcd73769
RS
303 (let ((p args))
304 (setq minarg restarg)
305 (while (and p (not (memq (car p) lambda-list-keywords)))
306 (or (eq p args) (setq minarg (list 'cdr minarg)))
307 (setq p (cdr p)))
308 (if (memq (car p) '(nil &aux))
309 (setq minarg (list '= (list 'length restarg)
310 (length (ldiff args p)))
311 exactarg (not (eq args p)))))
312 (while (and args (not (memq (car args) lambda-list-keywords)))
313 (let ((poparg (list (if (or (cdr args) (not exactarg)) 'pop 'car)
314 restarg)))
315 (cl-do-arglist
69d8fb1e 316 (pop args)
fcd73769
RS
317 (if (or laterarg (= safety 0)) poparg
318 (list 'if minarg poparg
319 (list 'signal '(quote wrong-number-of-arguments)
320 (list 'list (and (not (eq bind-block 'cl-none))
321 (list 'quote bind-block))
322 (list 'length restarg)))))))
323 (setq num (1+ num) laterarg t))
69d8fb1e 324 (while (and (eq (car args) '&optional) (pop args))
fcd73769 325 (while (and args (not (memq (car args) lambda-list-keywords)))
69d8fb1e 326 (let ((arg (pop args)))
fcd73769
RS
327 (or (consp arg) (setq arg (list arg)))
328 (if (cddr arg) (cl-do-arglist (nth 2 arg) (list 'and restarg t)))
329 (let ((def (if (cdr arg) (nth 1 arg)
330 (or (car bind-defs)
331 (nth 1 (assq (car arg) bind-defs)))))
332 (poparg (list 'pop restarg)))
333 (and def bind-enquote (setq def (list 'quote def)))
334 (cl-do-arglist (car arg)
335 (if def (list 'if restarg poparg def) poparg))
336 (setq num (1+ num))))))
337 (if (eq (car args) '&rest)
338 (let ((arg (cl-pop2 args)))
339 (if (consp arg) (cl-do-arglist arg restarg)))
340 (or (eq (car args) '&key) (= safety 0) exactarg
69d8fb1e 341 (push (list 'if restarg
fcd73769
RS
342 (list 'signal '(quote wrong-number-of-arguments)
343 (list 'list
344 (and (not (eq bind-block 'cl-none))
345 (list 'quote bind-block))
346 (list '+ num (list 'length restarg)))))
347 bind-forms)))
69d8fb1e 348 (while (and (eq (car args) '&key) (pop args))
fcd73769 349 (while (and args (not (memq (car args) lambda-list-keywords)))
69d8fb1e 350 (let ((arg (pop args)))
dd441b46 351 (or (consp arg) (setq arg (list arg)))
fcd73769
RS
352 (let* ((karg (if (consp (car arg)) (caar arg)
353 (intern (format ":%s" (car arg)))))
354 (varg (if (consp (car arg)) (cadar arg) (car arg)))
355 (def (if (cdr arg) (cadr arg)
356 (or (car bind-defs) (cadr (assq varg bind-defs)))))
dd441b46 357 (look (list 'memq (list 'quote karg) restarg)))
fcd73769
RS
358 (and def bind-enquote (setq def (list 'quote def)))
359 (if (cddr arg)
e542ea4b 360 (let* ((temp (or (nth 2 arg) (make-symbol "--cl-var--")))
fcd73769
RS
361 (val (list 'car (list 'cdr temp))))
362 (cl-do-arglist temp look)
363 (cl-do-arglist varg
364 (list 'if temp
365 (list 'prog1 val (list 'setq temp t))
366 def)))
367 (cl-do-arglist
368 varg
369 (list 'car
370 (list 'cdr
371 (if (null def)
372 look
373 (list 'or look
374 (if (eq (cl-const-expr-p def) t)
375 (list
376 'quote
377 (list nil (cl-const-expr-val def)))
378 (list 'list nil def))))))))
69d8fb1e 379 (push karg keys)))))
fcd73769 380 (setq keys (nreverse keys))
69d8fb1e 381 (or (and (eq (car args) '&allow-other-keys) (pop args))
fcd73769 382 (null keys) (= safety 0)
e542ea4b 383 (let* ((var (make-symbol "--cl-keys--"))
fcd73769
RS
384 (allow '(:allow-other-keys))
385 (check (list
386 'while var
387 (list
388 'cond
389 (list (list 'memq (list 'car var)
390 (list 'quote (append keys allow)))
391 (list 'setq var (list 'cdr (list 'cdr var))))
dd441b46
GM
392 (list (list 'car
393 (list 'cdr
394 (list 'memq (cons 'quote allow)
395 restarg)))
fcd73769
RS
396 (list 'setq var nil))
397 (list t
398 (list
399 'error
400 (format "Keyword argument %%s not one of %s"
401 keys)
402 (list 'car var)))))))
69d8fb1e
SM
403 (push (list 'let (list (list var restarg)) check) bind-forms)))
404 (while (and (eq (car args) '&aux) (pop args))
fcd73769
RS
405 (while (and args (not (memq (car args) lambda-list-keywords)))
406 (if (consp (car args))
407 (if (and bind-enquote (cadar args))
408 (cl-do-arglist (caar args)
69d8fb1e
SM
409 (list 'quote (cadr (pop args))))
410 (cl-do-arglist (caar args) (cadr (pop args))))
411 (cl-do-arglist (pop args) nil))))
fcd73769
RS
412 (if args (error "Malformed argument list %s" save-args)))))
413
414(defun cl-arglist-args (args)
415 (if (nlistp args) (list args)
416 (let ((res nil) (kind nil) arg)
417 (while (consp args)
69d8fb1e 418 (setq arg (pop args))
fcd73769 419 (if (memq arg lambda-list-keywords) (setq kind arg)
69d8fb1e 420 (if (eq arg '&cl-defs) (pop args)
fcd73769
RS
421 (and (consp arg) kind (setq arg (car arg)))
422 (and (consp arg) (cdr arg) (eq kind '&key) (setq arg (cadr arg)))
423 (setq res (nconc res (cl-arglist-args arg))))))
424 (nconc res (and args (list args))))))
425
ebacfcc6 426;;;###autoload
fcd73769
RS
427(defmacro destructuring-bind (args expr &rest body)
428 (let* ((bind-lets nil) (bind-forms nil) (bind-inits nil)
429 (bind-defs nil) (bind-block 'cl-none))
430 (cl-do-arglist (or args '(&aux)) expr)
431 (append '(progn) bind-inits
432 (list (nconc (list 'let* (nreverse bind-lets))
433 (nreverse bind-forms) body)))))
434
435
436;;; The `eval-when' form.
437
438(defvar cl-not-toplevel nil)
439
ebacfcc6 440;;;###autoload
fcd73769 441(defmacro eval-when (when &rest body)
69d8fb1e 442 "Control when BODY is evaluated.
fcd73769
RS
443If `compile' is in WHEN, BODY is evaluated when compiled at top-level.
444If `load' is in WHEN, BODY is evaluated when loaded after top-level compile.
69d8fb1e
SM
445If `eval' is in WHEN, BODY is evaluated when interpreted or at non-top-level.
446
447\(fn (WHEN...) BODY...)"
fcd73769
RS
448 (if (and (fboundp 'cl-compiling-file) (cl-compiling-file)
449 (not cl-not-toplevel) (not (boundp 'for-effect))) ; horrible kludge
64a4c526 450 (let ((comp (or (memq 'compile when) (memq :compile-toplevel when)))
fcd73769 451 (cl-not-toplevel t))
64a4c526 452 (if (or (memq 'load when) (memq :load-toplevel when))
fcd73769
RS
453 (if comp (cons 'progn (mapcar 'cl-compile-time-too body))
454 (list* 'if nil nil body))
455 (progn (if comp (eval (cons 'progn body))) nil)))
64a4c526 456 (and (or (memq 'eval when) (memq :execute when))
fcd73769
RS
457 (cons 'progn body))))
458
459(defun cl-compile-time-too (form)
460 (or (and (symbolp (car-safe form)) (get (car-safe form) 'byte-hunk-handler))
461 (setq form (macroexpand
462 form (cons '(eval-when) byte-compile-macro-environment))))
463 (cond ((eq (car-safe form) 'progn)
464 (cons 'progn (mapcar 'cl-compile-time-too (cdr form))))
465 ((eq (car-safe form) 'eval-when)
466 (let ((when (nth 1 form)))
64a4c526 467 (if (or (memq 'eval when) (memq :execute when))
fcd73769
RS
468 (list* 'eval-when (cons 'compile when) (cddr form))
469 form)))
470 (t (eval form) form)))
471
ebacfcc6 472;;;###autoload
fcd73769
RS
473(defmacro load-time-value (form &optional read-only)
474 "Like `progn', but evaluates the body at load time.
475The result of the body appears to the compiler as a quoted constant."
476 (if (cl-compiling-file)
477 (let* ((temp (gentemp "--cl-load-time--"))
478 (set (list 'set (list 'quote temp) form)))
479 (if (and (fboundp 'byte-compile-file-form-defmumble)
480 (boundp 'this-kind) (boundp 'that-one))
481 (fset 'byte-compile-file-form
482 (list 'lambda '(form)
483 (list 'fset '(quote byte-compile-file-form)
484 (list 'quote
485 (symbol-function 'byte-compile-file-form)))
486 (list 'byte-compile-file-form (list 'quote set))
487 '(byte-compile-file-form form)))
488 (print set (symbol-value 'outbuffer)))
489 (list 'symbol-value (list 'quote temp)))
490 (list 'quote (eval form))))
491
492
493;;; Conditional control structures.
494
ebacfcc6 495;;;###autoload
fcd73769 496(defmacro case (expr &rest clauses)
3187ba1c 497 "Eval EXPR and choose among clauses on that value.
fcd73769
RS
498Each clause looks like (KEYLIST BODY...). EXPR is evaluated and compared
499against each key in each KEYLIST; the corresponding BODY is evaluated.
500If no clause succeeds, case returns nil. A single atom may be used in
a8ea72a0 501place of a KEYLIST of one atom. A KEYLIST of t or `otherwise' is
fcd73769 502allowed only in the final clause, and matches if no other keys match.
3187ba1c
JB
503Key values are compared by `eql'.
504\n(fn EXPR (KEYLIST BODY...)...)"
e542ea4b 505 (let* ((temp (if (cl-simple-expr-p expr 3) expr (make-symbol "--cl-var--")))
fcd73769
RS
506 (head-list nil)
507 (body (cons
508 'cond
509 (mapcar
510 (function
511 (lambda (c)
512 (cons (cond ((memq (car c) '(t otherwise)) t)
513 ((eq (car c) 'ecase-error-flag)
514 (list 'error "ecase failed: %s, %s"
515 temp (list 'quote (reverse head-list))))
516 ((listp (car c))
517 (setq head-list (append (car c) head-list))
518 (list 'member* temp (list 'quote (car c))))
519 (t
520 (if (memq (car c) head-list)
521 (error "Duplicate key in case: %s"
522 (car c)))
69d8fb1e 523 (push (car c) head-list)
fcd73769
RS
524 (list 'eql temp (list 'quote (car c)))))
525 (or (cdr c) '(nil)))))
526 clauses))))
527 (if (eq temp expr) body
528 (list 'let (list (list temp expr)) body))))
529
ebacfcc6 530;;;###autoload
fcd73769 531(defmacro ecase (expr &rest clauses)
64a4c526 532 "Like `case', but error if no case fits.
3187ba1c
JB
533`otherwise'-clauses are not allowed.
534\n(fn EXPR (KEYLIST BODY...)...)"
fcd73769
RS
535 (list* 'case expr (append clauses '((ecase-error-flag)))))
536
ebacfcc6 537;;;###autoload
fcd73769 538(defmacro typecase (expr &rest clauses)
3187ba1c 539 "Evals EXPR, chooses among clauses on that value.
fcd73769
RS
540Each clause looks like (TYPE BODY...). EXPR is evaluated and, if it
541satisfies TYPE, the corresponding BODY is evaluated. If no clause succeeds,
a8ea72a0 542typecase returns nil. A TYPE of t or `otherwise' is allowed only in the
3187ba1c
JB
543final clause, and matches if no other keys match.
544\n(fn EXPR (TYPE BODY...)...)"
e542ea4b 545 (let* ((temp (if (cl-simple-expr-p expr 3) expr (make-symbol "--cl-var--")))
fcd73769
RS
546 (type-list nil)
547 (body (cons
548 'cond
549 (mapcar
550 (function
551 (lambda (c)
552 (cons (cond ((eq (car c) 'otherwise) t)
553 ((eq (car c) 'ecase-error-flag)
554 (list 'error "etypecase failed: %s, %s"
555 temp (list 'quote (reverse type-list))))
556 (t
69d8fb1e 557 (push (car c) type-list)
fcd73769
RS
558 (cl-make-type-test temp (car c))))
559 (or (cdr c) '(nil)))))
560 clauses))))
561 (if (eq temp expr) body
562 (list 'let (list (list temp expr)) body))))
563
ebacfcc6 564;;;###autoload
fcd73769 565(defmacro etypecase (expr &rest clauses)
64a4c526 566 "Like `typecase', but error if no case fits.
3187ba1c
JB
567`otherwise'-clauses are not allowed.
568\n(fn EXPR (TYPE BODY...)...)"
fcd73769
RS
569 (list* 'typecase expr (append clauses '((ecase-error-flag)))))
570
571
572;;; Blocks and exits.
573
ebacfcc6 574;;;###autoload
fcd73769 575(defmacro block (name &rest body)
64a4c526 576 "Define a lexically-scoped block named NAME.
fcd73769
RS
577NAME may be any symbol. Code inside the BODY forms can call `return-from'
578to jump prematurely out of the block. This differs from `catch' and `throw'
579in two respects: First, the NAME is an unevaluated symbol rather than a
580quoted symbol or other form; and second, NAME is lexically rather than
581dynamically scoped: Only references to it within BODY will work. These
582references may appear inside macro expansions, but not inside functions
583called from BODY."
584 (if (cl-safe-expr-p (cons 'progn body)) (cons 'progn body)
585 (list 'cl-block-wrapper
586 (list* 'catch (list 'quote (intern (format "--cl-block-%s--" name)))
587 body))))
588
589(defvar cl-active-block-names nil)
590
591(put 'cl-block-wrapper 'byte-compile 'cl-byte-compile-block)
592(defun cl-byte-compile-block (cl-form)
593 (if (fboundp 'byte-compile-form-do-effect) ; Check for optimizing compiler
594 (progn
595 (let* ((cl-entry (cons (nth 1 (nth 1 (nth 1 cl-form))) nil))
596 (cl-active-block-names (cons cl-entry cl-active-block-names))
597 (cl-body (byte-compile-top-level
598 (cons 'progn (cddr (nth 1 cl-form))))))
599 (if (cdr cl-entry)
600 (byte-compile-form (list 'catch (nth 1 (nth 1 cl-form)) cl-body))
601 (byte-compile-form cl-body))))
602 (byte-compile-form (nth 1 cl-form))))
603
604(put 'cl-block-throw 'byte-compile 'cl-byte-compile-throw)
605(defun cl-byte-compile-throw (cl-form)
606 (let ((cl-found (assq (nth 1 (nth 1 cl-form)) cl-active-block-names)))
607 (if cl-found (setcdr cl-found t)))
608 (byte-compile-normal-call (cons 'throw (cdr cl-form))))
609
ebacfcc6 610;;;###autoload
64a4c526
DL
611(defmacro return (&optional result)
612 "Return from the block named nil.
fcd73769 613This is equivalent to `(return-from nil RESULT)'."
64a4c526 614 (list 'return-from nil result))
fcd73769 615
ebacfcc6 616;;;###autoload
64a4c526
DL
617(defmacro return-from (name &optional result)
618 "Return from the block named NAME.
fcd73769
RS
619This jump out to the innermost enclosing `(block NAME ...)' form,
620returning RESULT from that form (or nil if RESULT is omitted).
621This is compatible with Common Lisp, but note that `defun' and
622`defmacro' do not create implicit blocks as they do in Common Lisp."
623 (let ((name2 (intern (format "--cl-block-%s--" name))))
64a4c526 624 (list 'cl-block-throw (list 'quote name2) result)))
fcd73769
RS
625
626
627;;; The "loop" macro.
628
629(defvar args) (defvar loop-accum-var) (defvar loop-accum-vars)
630(defvar loop-bindings) (defvar loop-body) (defvar loop-destr-temps)
631(defvar loop-finally) (defvar loop-finish-flag) (defvar loop-first-flag)
632(defvar loop-initially) (defvar loop-map-form) (defvar loop-name)
633(defvar loop-result) (defvar loop-result-explicit)
634(defvar loop-result-var) (defvar loop-steps) (defvar loop-symbol-macs)
635
ebacfcc6 636;;;###autoload
fcd73769 637(defmacro loop (&rest args)
69d8fb1e 638 "The Common Lisp `loop' macro.
fcd73769
RS
639Valid clauses are:
640 for VAR from/upfrom/downfrom NUM to/upto/downto/above/below NUM by NUM,
641 for VAR in LIST by FUNC, for VAR on LIST by FUNC, for VAR = INIT then EXPR,
642 for VAR across ARRAY, repeat NUM, with VAR = INIT, while COND, until COND,
643 always COND, never COND, thereis COND, collect EXPR into VAR,
644 append EXPR into VAR, nconc EXPR into VAR, sum EXPR into VAR,
645 count EXPR into VAR, maximize EXPR into VAR, minimize EXPR into VAR,
646 if COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...],
647 unless COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...],
648 do EXPRS..., initially EXPRS..., finally EXPRS..., return EXPR,
69d8fb1e
SM
649 finally return EXPR, named NAME.
650
651\(fn CLAUSE...)"
fcd73769
RS
652 (if (not (memq t (mapcar 'symbolp (delq nil (delq t (copy-list args))))))
653 (list 'block nil (list* 'while t args))
654 (let ((loop-name nil) (loop-bindings nil)
655 (loop-body nil) (loop-steps nil)
656 (loop-result nil) (loop-result-explicit nil)
657 (loop-result-var nil) (loop-finish-flag nil)
658 (loop-accum-var nil) (loop-accum-vars nil)
659 (loop-initially nil) (loop-finally nil)
660 (loop-map-form nil) (loop-first-flag nil)
661 (loop-destr-temps nil) (loop-symbol-macs nil))
662 (setq args (append args '(cl-end-loop)))
663 (while (not (eq (car args) 'cl-end-loop)) (cl-parse-loop-clause))
664 (if loop-finish-flag
e542ea4b 665 (push `((,loop-finish-flag t)) loop-bindings))
fcd73769 666 (if loop-first-flag
e542ea4b
SM
667 (progn (push `((,loop-first-flag t)) loop-bindings)
668 (push `(setq ,loop-first-flag nil) loop-steps)))
fcd73769
RS
669 (let* ((epilogue (nconc (nreverse loop-finally)
670 (list (or loop-result-explicit loop-result))))
671 (ands (cl-loop-build-ands (nreverse loop-body)))
672 (while-body (nconc (cadr ands) (nreverse loop-steps)))
673 (body (append
674 (nreverse loop-initially)
675 (list (if loop-map-form
676 (list 'block '--cl-finish--
677 (subst
678 (if (eq (car ands) t) while-body
e542ea4b
SM
679 (cons `(or ,(car ands)
680 (return-from --cl-finish--
681 nil))
fcd73769
RS
682 while-body))
683 '--cl-map loop-map-form))
684 (list* 'while (car ands) while-body)))
685 (if loop-finish-flag
686 (if (equal epilogue '(nil)) (list loop-result-var)
e542ea4b
SM
687 `((if ,loop-finish-flag
688 (progn ,@epilogue) ,loop-result-var)))
fcd73769 689 epilogue))))
69d8fb1e 690 (if loop-result-var (push (list loop-result-var) loop-bindings))
fcd73769
RS
691 (while loop-bindings
692 (if (cdar loop-bindings)
69d8fb1e 693 (setq body (list (cl-loop-let (pop loop-bindings) body t)))
fcd73769
RS
694 (let ((lets nil))
695 (while (and loop-bindings
696 (not (cdar loop-bindings)))
69d8fb1e 697 (push (car (pop loop-bindings)) lets))
fcd73769
RS
698 (setq body (list (cl-loop-let lets body nil))))))
699 (if loop-symbol-macs
700 (setq body (list (list* 'symbol-macrolet loop-symbol-macs body))))
701 (list* 'block loop-name body)))))
702
e542ea4b 703(defun cl-parse-loop-clause () ; uses args, loop-*
69d8fb1e 704 (let ((word (pop args))
fcd73769
RS
705 (hash-types '(hash-key hash-keys hash-value hash-values))
706 (key-types '(key-code key-codes key-seq key-seqs
707 key-binding key-bindings)))
708 (cond
709
710 ((null args)
711 (error "Malformed `loop' macro"))
712
713 ((eq word 'named)
69d8fb1e 714 (setq loop-name (pop args)))
fcd73769
RS
715
716 ((eq word 'initially)
69d8fb1e 717 (if (memq (car args) '(do doing)) (pop args))
fcd73769
RS
718 (or (consp (car args)) (error "Syntax error on `initially' clause"))
719 (while (consp (car args))
69d8fb1e 720 (push (pop args) loop-initially)))
fcd73769
RS
721
722 ((eq word 'finally)
723 (if (eq (car args) 'return)
724 (setq loop-result-explicit (or (cl-pop2 args) '(quote nil)))
69d8fb1e 725 (if (memq (car args) '(do doing)) (pop args))
fcd73769
RS
726 (or (consp (car args)) (error "Syntax error on `finally' clause"))
727 (if (and (eq (caar args) 'return) (null loop-name))
69d8fb1e 728 (setq loop-result-explicit (or (nth 1 (pop args)) '(quote nil)))
fcd73769 729 (while (consp (car args))
69d8fb1e 730 (push (pop args) loop-finally)))))
fcd73769
RS
731
732 ((memq word '(for as))
733 (let ((loop-for-bindings nil) (loop-for-sets nil) (loop-for-steps nil)
734 (ands nil))
735 (while
443b961a
SM
736 ;; Use `gensym' rather than `make-symbol'. It's important that
737 ;; (not (eq (symbol-name var1) (symbol-name var2))) because
738 ;; these vars get added to the cl-macro-environment.
739 (let ((var (or (pop args) (gensym "--cl-var--"))))
69d8fb1e
SM
740 (setq word (pop args))
741 (if (eq word 'being) (setq word (pop args)))
742 (if (memq word '(the each)) (setq word (pop args)))
fcd73769
RS
743 (if (memq word '(buffer buffers))
744 (setq word 'in args (cons '(buffer-list) args)))
745 (cond
746
747 ((memq word '(from downfrom upfrom to downto upto
748 above below by))
69d8fb1e 749 (push word args)
fcd73769
RS
750 (if (memq (car args) '(downto above))
751 (error "Must specify `from' value for downward loop"))
752 (let* ((down (or (eq (car args) 'downfrom)
753 (memq (caddr args) '(downto above))))
754 (excl (or (memq (car args) '(above below))
755 (memq (caddr args) '(above below))))
756 (start (and (memq (car args) '(from upfrom downfrom))
757 (cl-pop2 args)))
758 (end (and (memq (car args)
759 '(to upto downto above below))
760 (cl-pop2 args)))
761 (step (and (eq (car args) 'by) (cl-pop2 args)))
e542ea4b
SM
762 (end-var (and (not (cl-const-expr-p end))
763 (make-symbol "--cl-var--")))
fcd73769 764 (step-var (and (not (cl-const-expr-p step))
e542ea4b 765 (make-symbol "--cl-var--"))))
fcd73769
RS
766 (and step (numberp step) (<= step 0)
767 (error "Loop `by' value is not positive: %s" step))
69d8fb1e
SM
768 (push (list var (or start 0)) loop-for-bindings)
769 (if end-var (push (list end-var end) loop-for-bindings))
770 (if step-var (push (list step-var step)
e542ea4b 771 loop-for-bindings))
fcd73769 772 (if end
69d8fb1e 773 (push (list
e542ea4b
SM
774 (if down (if excl '> '>=) (if excl '< '<=))
775 var (or end-var end)) loop-body))
69d8fb1e 776 (push (list var (list (if down '- '+) var
e542ea4b
SM
777 (or step-var step 1)))
778 loop-for-steps)))
fcd73769
RS
779
780 ((memq word '(in in-ref on))
781 (let* ((on (eq word 'on))
e542ea4b
SM
782 (temp (if (and on (symbolp var))
783 var (make-symbol "--cl-var--"))))
69d8fb1e
SM
784 (push (list temp (pop args)) loop-for-bindings)
785 (push (list 'consp temp) loop-body)
fcd73769 786 (if (eq word 'in-ref)
69d8fb1e 787 (push (list var (list 'car temp)) loop-symbol-macs)
fcd73769
RS
788 (or (eq temp var)
789 (progn
69d8fb1e
SM
790 (push (list var nil) loop-for-bindings)
791 (push (list var (if on temp (list 'car temp)))
e542ea4b 792 loop-for-sets))))
69d8fb1e 793 (push (list temp
e542ea4b
SM
794 (if (eq (car args) 'by)
795 (let ((step (cl-pop2 args)))
796 (if (and (memq (car-safe step)
797 '(quote function
798 function*))
799 (symbolp (nth 1 step)))
800 (list (nth 1 step) temp)
801 (list 'funcall step temp)))
802 (list 'cdr temp)))
803 loop-for-steps)))
fcd73769
RS
804
805 ((eq word '=)
69d8fb1e 806 (let* ((start (pop args))
fcd73769 807 (then (if (eq (car args) 'then) (cl-pop2 args) start)))
69d8fb1e 808 (push (list var nil) loop-for-bindings)
fcd73769
RS
809 (if (or ands (eq (car args) 'and))
810 (progn
e542ea4b
SM
811 (push `(,var
812 (if ,(or loop-first-flag
813 (setq loop-first-flag
814 (make-symbol "--cl-var--")))
815 ,start ,var))
816 loop-for-sets)
69d8fb1e
SM
817 (push (list var then) loop-for-steps))
818 (push (list var
e542ea4b
SM
819 (if (eq start then) start
820 `(if ,(or loop-first-flag
821 (setq loop-first-flag
822 (make-symbol "--cl-var--")))
823 ,start ,then)))
824 loop-for-sets))))
fcd73769
RS
825
826 ((memq word '(across across-ref))
e542ea4b
SM
827 (let ((temp-vec (make-symbol "--cl-vec--"))
828 (temp-idx (make-symbol "--cl-idx--")))
69d8fb1e
SM
829 (push (list temp-vec (pop args)) loop-for-bindings)
830 (push (list temp-idx -1) loop-for-bindings)
831 (push (list '< (list 'setq temp-idx (list '1+ temp-idx))
e542ea4b 832 (list 'length temp-vec)) loop-body)
fcd73769 833 (if (eq word 'across-ref)
69d8fb1e 834 (push (list var (list 'aref temp-vec temp-idx))
e542ea4b 835 loop-symbol-macs)
69d8fb1e
SM
836 (push (list var nil) loop-for-bindings)
837 (push (list var (list 'aref temp-vec temp-idx))
e542ea4b 838 loop-for-sets))))
fcd73769
RS
839
840 ((memq word '(element elements))
841 (let ((ref (or (memq (car args) '(in-ref of-ref))
842 (and (not (memq (car args) '(in of)))
843 (error "Expected `of'"))))
844 (seq (cl-pop2 args))
e542ea4b 845 (temp-seq (make-symbol "--cl-seq--"))
fcd73769
RS
846 (temp-idx (if (eq (car args) 'using)
847 (if (and (= (length (cadr args)) 2)
848 (eq (caadr args) 'index))
849 (cadr (cl-pop2 args))
850 (error "Bad `using' clause"))
e542ea4b 851 (make-symbol "--cl-idx--"))))
69d8fb1e
SM
852 (push (list temp-seq seq) loop-for-bindings)
853 (push (list temp-idx 0) loop-for-bindings)
fcd73769 854 (if ref
e542ea4b 855 (let ((temp-len (make-symbol "--cl-len--")))
69d8fb1e 856 (push (list temp-len (list 'length temp-seq))
e542ea4b 857 loop-for-bindings)
69d8fb1e 858 (push (list var (list 'elt temp-seq temp-idx))
e542ea4b 859 loop-symbol-macs)
69d8fb1e
SM
860 (push (list '< temp-idx temp-len) loop-body))
861 (push (list var nil) loop-for-bindings)
862 (push (list 'and temp-seq
e542ea4b
SM
863 (list 'or (list 'consp temp-seq)
864 (list '< temp-idx
865 (list 'length temp-seq))))
866 loop-body)
69d8fb1e 867 (push (list var (list 'if (list 'consp temp-seq)
e542ea4b
SM
868 (list 'pop temp-seq)
869 (list 'aref temp-seq temp-idx)))
870 loop-for-sets))
69d8fb1e 871 (push (list temp-idx (list '1+ temp-idx))
e542ea4b 872 loop-for-steps)))
fcd73769
RS
873
874 ((memq word hash-types)
875 (or (memq (car args) '(in of)) (error "Expected `of'"))
876 (let* ((table (cl-pop2 args))
877 (other (if (eq (car args) 'using)
878 (if (and (= (length (cadr args)) 2)
879 (memq (caadr args) hash-types)
880 (not (eq (caadr args) word)))
881 (cadr (cl-pop2 args))
882 (error "Bad `using' clause"))
e542ea4b 883 (make-symbol "--cl-var--"))))
fcd73769
RS
884 (if (memq word '(hash-value hash-values))
885 (setq var (prog1 other (setq other var))))
886 (setq loop-map-form
e542ea4b 887 `(maphash (lambda (,var ,other) . --cl-map) ,table))))
fcd73769
RS
888
889 ((memq word '(symbol present-symbol external-symbol
890 symbols present-symbols external-symbols))
891 (let ((ob (and (memq (car args) '(in of)) (cl-pop2 args))))
892 (setq loop-map-form
e542ea4b 893 `(mapatoms (lambda (,var) . --cl-map) ,ob))))
fcd73769
RS
894
895 ((memq word '(overlay overlays extent extents))
896 (let ((buf nil) (from nil) (to nil))
897 (while (memq (car args) '(in of from to))
898 (cond ((eq (car args) 'from) (setq from (cl-pop2 args)))
899 ((eq (car args) 'to) (setq to (cl-pop2 args)))
900 (t (setq buf (cl-pop2 args)))))
901 (setq loop-map-form
e542ea4b
SM
902 `(cl-map-extents
903 (lambda (,var ,(make-symbol "--cl-var--"))
904 (progn . --cl-map) nil)
905 ,buf ,from ,to))))
fcd73769
RS
906
907 ((memq word '(interval intervals))
908 (let ((buf nil) (prop nil) (from nil) (to nil)
e542ea4b
SM
909 (var1 (make-symbol "--cl-var1--"))
910 (var2 (make-symbol "--cl-var2--")))
fcd73769
RS
911 (while (memq (car args) '(in of property from to))
912 (cond ((eq (car args) 'from) (setq from (cl-pop2 args)))
913 ((eq (car args) 'to) (setq to (cl-pop2 args)))
914 ((eq (car args) 'property)
915 (setq prop (cl-pop2 args)))
916 (t (setq buf (cl-pop2 args)))))
917 (if (and (consp var) (symbolp (car var)) (symbolp (cdr var)))
918 (setq var1 (car var) var2 (cdr var))
69d8fb1e 919 (push (list var (list 'cons var1 var2)) loop-for-sets))
fcd73769 920 (setq loop-map-form
e542ea4b
SM
921 `(cl-map-intervals
922 (lambda (,var1 ,var2) . --cl-map)
923 ,buf ,prop ,from ,to))))
fcd73769
RS
924
925 ((memq word key-types)
926 (or (memq (car args) '(in of)) (error "Expected `of'"))
927 (let ((map (cl-pop2 args))
928 (other (if (eq (car args) 'using)
929 (if (and (= (length (cadr args)) 2)
930 (memq (caadr args) key-types)
931 (not (eq (caadr args) word)))
932 (cadr (cl-pop2 args))
933 (error "Bad `using' clause"))
e542ea4b 934 (make-symbol "--cl-var--"))))
fcd73769
RS
935 (if (memq word '(key-binding key-bindings))
936 (setq var (prog1 other (setq other var))))
937 (setq loop-map-form
e542ea4b
SM
938 `(,(if (memq word '(key-seq key-seqs))
939 'cl-map-keymap-recursively 'map-keymap)
940 (lambda (,var ,other) . --cl-map) ,map))))
fcd73769
RS
941
942 ((memq word '(frame frames screen screens))
e542ea4b 943 (let ((temp (make-symbol "--cl-var--")))
69d8fb1e 944 (push (list var '(selected-frame))
e542ea4b 945 loop-for-bindings)
69d8fb1e
SM
946 (push (list temp nil) loop-for-bindings)
947 (push (list 'prog1 (list 'not (list 'eq var temp))
e542ea4b
SM
948 (list 'or temp (list 'setq temp var)))
949 loop-body)
69d8fb1e 950 (push (list var (list 'next-frame var))
e542ea4b 951 loop-for-steps)))
fcd73769
RS
952
953 ((memq word '(window windows))
954 (let ((scr (and (memq (car args) '(in of)) (cl-pop2 args)))
e542ea4b 955 (temp (make-symbol "--cl-var--")))
69d8fb1e 956 (push (list var (if scr
e542ea4b
SM
957 (list 'frame-selected-window scr)
958 '(selected-window)))
959 loop-for-bindings)
69d8fb1e
SM
960 (push (list temp nil) loop-for-bindings)
961 (push (list 'prog1 (list 'not (list 'eq var temp))
e542ea4b
SM
962 (list 'or temp (list 'setq temp var)))
963 loop-body)
69d8fb1e 964 (push (list var (list 'next-window var)) loop-for-steps)))
fcd73769
RS
965
966 (t
967 (let ((handler (and (symbolp word)
968 (get word 'cl-loop-for-handler))))
969 (if handler
970 (funcall handler var)
971 (error "Expected a `for' preposition, found %s" word)))))
972 (eq (car args) 'and))
973 (setq ands t)
69d8fb1e 974 (pop args))
fcd73769 975 (if (and ands loop-for-bindings)
69d8fb1e 976 (push (nreverse loop-for-bindings) loop-bindings)
fcd73769
RS
977 (setq loop-bindings (nconc (mapcar 'list loop-for-bindings)
978 loop-bindings)))
979 (if loop-for-sets
69d8fb1e 980 (push (list 'progn
e542ea4b
SM
981 (cl-loop-let (nreverse loop-for-sets) 'setq ands)
982 t) loop-body))
fcd73769 983 (if loop-for-steps
69d8fb1e 984 (push (cons (if ands 'psetq 'setq)
e542ea4b
SM
985 (apply 'append (nreverse loop-for-steps)))
986 loop-steps))))
fcd73769
RS
987
988 ((eq word 'repeat)
e542ea4b 989 (let ((temp (make-symbol "--cl-var--")))
69d8fb1e
SM
990 (push (list (list temp (pop args))) loop-bindings)
991 (push (list '>= (list 'setq temp (list '1- temp)) 0) loop-body)))
fcd73769 992
ae1aa776 993 ((memq word '(collect collecting))
69d8fb1e 994 (let ((what (pop args))
fcd73769
RS
995 (var (cl-loop-handle-accum nil 'nreverse)))
996 (if (eq var loop-accum-var)
69d8fb1e
SM
997 (push (list 'progn (list 'push what var) t) loop-body)
998 (push (list 'progn
e542ea4b
SM
999 (list 'setq var (list 'nconc var (list 'list what)))
1000 t) loop-body))))
fcd73769
RS
1001
1002 ((memq word '(nconc nconcing append appending))
69d8fb1e 1003 (let ((what (pop args))
fcd73769 1004 (var (cl-loop-handle-accum nil 'nreverse)))
69d8fb1e 1005 (push (list 'progn
e542ea4b
SM
1006 (list 'setq var
1007 (if (eq var loop-accum-var)
1008 (list 'nconc
1009 (list (if (memq word '(nconc nconcing))
1010 'nreverse 'reverse)
1011 what)
1012 var)
1013 (list (if (memq word '(nconc nconcing))
1014 'nconc 'append)
1015 var what))) t) loop-body)))
fcd73769
RS
1016
1017 ((memq word '(concat concating))
69d8fb1e 1018 (let ((what (pop args))
fcd73769 1019 (var (cl-loop-handle-accum "")))
69d8fb1e 1020 (push (list 'progn (list 'callf 'concat var what) t) loop-body)))
fcd73769
RS
1021
1022 ((memq word '(vconcat vconcating))
69d8fb1e 1023 (let ((what (pop args))
fcd73769 1024 (var (cl-loop-handle-accum [])))
69d8fb1e 1025 (push (list 'progn (list 'callf 'vconcat var what) t) loop-body)))
fcd73769
RS
1026
1027 ((memq word '(sum summing))
69d8fb1e 1028 (let ((what (pop args))
fcd73769 1029 (var (cl-loop-handle-accum 0)))
69d8fb1e 1030 (push (list 'progn (list 'incf var what) t) loop-body)))
fcd73769
RS
1031
1032 ((memq word '(count counting))
69d8fb1e 1033 (let ((what (pop args))
fcd73769 1034 (var (cl-loop-handle-accum 0)))
69d8fb1e 1035 (push (list 'progn (list 'if what (list 'incf var)) t) loop-body)))
fcd73769
RS
1036
1037 ((memq word '(minimize minimizing maximize maximizing))
69d8fb1e 1038 (let* ((what (pop args))
e542ea4b 1039 (temp (if (cl-simple-expr-p what) what (make-symbol "--cl-var--")))
fcd73769
RS
1040 (var (cl-loop-handle-accum nil))
1041 (func (intern (substring (symbol-name word) 0 3)))
1042 (set (list 'setq var (list 'if var (list func var temp) temp))))
69d8fb1e 1043 (push (list 'progn (if (eq temp what) set
e542ea4b
SM
1044 (list 'let (list (list temp what)) set))
1045 t) loop-body)))
fcd73769
RS
1046
1047 ((eq word 'with)
1048 (let ((bindings nil))
69d8fb1e 1049 (while (progn (push (list (pop args)
e542ea4b
SM
1050 (and (eq (car args) '=) (cl-pop2 args)))
1051 bindings)
fcd73769 1052 (eq (car args) 'and))
69d8fb1e
SM
1053 (pop args))
1054 (push (nreverse bindings) loop-bindings)))
fcd73769
RS
1055
1056 ((eq word 'while)
69d8fb1e 1057 (push (pop args) loop-body))
fcd73769
RS
1058
1059 ((eq word 'until)
69d8fb1e 1060 (push (list 'not (pop args)) loop-body))
fcd73769
RS
1061
1062 ((eq word 'always)
e542ea4b 1063 (or loop-finish-flag (setq loop-finish-flag (make-symbol "--cl-flag--")))
69d8fb1e 1064 (push (list 'setq loop-finish-flag (pop args)) loop-body)
fcd73769
RS
1065 (setq loop-result t))
1066
1067 ((eq word 'never)
e542ea4b 1068 (or loop-finish-flag (setq loop-finish-flag (make-symbol "--cl-flag--")))
69d8fb1e 1069 (push (list 'setq loop-finish-flag (list 'not (pop args)))
e542ea4b 1070 loop-body)
fcd73769
RS
1071 (setq loop-result t))
1072
1073 ((eq word 'thereis)
e542ea4b
SM
1074 (or loop-finish-flag (setq loop-finish-flag (make-symbol "--cl-flag--")))
1075 (or loop-result-var (setq loop-result-var (make-symbol "--cl-var--")))
69d8fb1e 1076 (push (list 'setq loop-finish-flag
e542ea4b
SM
1077 (list 'not (list 'setq loop-result-var (pop args))))
1078 loop-body))
fcd73769
RS
1079
1080 ((memq word '(if when unless))
69d8fb1e 1081 (let* ((cond (pop args))
fcd73769
RS
1082 (then (let ((loop-body nil))
1083 (cl-parse-loop-clause)
1084 (cl-loop-build-ands (nreverse loop-body))))
1085 (else (let ((loop-body nil))
1086 (if (eq (car args) 'else)
69d8fb1e 1087 (progn (pop args) (cl-parse-loop-clause)))
fcd73769
RS
1088 (cl-loop-build-ands (nreverse loop-body))))
1089 (simple (and (eq (car then) t) (eq (car else) t))))
69d8fb1e 1090 (if (eq (car args) 'end) (pop args))
fcd73769
RS
1091 (if (eq word 'unless) (setq then (prog1 else (setq else then))))
1092 (let ((form (cons (if simple (cons 'progn (nth 1 then)) (nth 2 then))
1093 (if simple (nth 1 else) (list (nth 2 else))))))
1094 (if (cl-expr-contains form 'it)
e542ea4b 1095 (let ((temp (make-symbol "--cl-var--")))
69d8fb1e 1096 (push (list temp) loop-bindings)
fcd73769
RS
1097 (setq form (list* 'if (list 'setq temp cond)
1098 (subst temp 'it form))))
1099 (setq form (list* 'if cond form)))
69d8fb1e 1100 (push (if simple (list 'progn form t) form) loop-body))))
fcd73769
RS
1101
1102 ((memq word '(do doing))
1103 (let ((body nil))
1104 (or (consp (car args)) (error "Syntax error on `do' clause"))
69d8fb1e
SM
1105 (while (consp (car args)) (push (pop args) body))
1106 (push (cons 'progn (nreverse (cons t body))) loop-body)))
fcd73769
RS
1107
1108 ((eq word 'return)
e542ea4b
SM
1109 (or loop-finish-flag (setq loop-finish-flag (make-symbol "--cl-var--")))
1110 (or loop-result-var (setq loop-result-var (make-symbol "--cl-var--")))
69d8fb1e 1111 (push (list 'setq loop-result-var (pop args)
e542ea4b 1112 loop-finish-flag nil) loop-body))
fcd73769
RS
1113
1114 (t
1115 (let ((handler (and (symbolp word) (get word 'cl-loop-handler))))
1116 (or handler (error "Expected a loop keyword, found %s" word))
1117 (funcall handler))))
1118 (if (eq (car args) 'and)
69d8fb1e 1119 (progn (pop args) (cl-parse-loop-clause)))))
fcd73769
RS
1120
1121(defun cl-loop-let (specs body par) ; uses loop-*
1122 (let ((p specs) (temps nil) (new nil))
1123 (while (and p (or (symbolp (car-safe (car p))) (null (cadar p))))
1124 (setq p (cdr p)))
1125 (and par p
1126 (progn
1127 (setq par nil p specs)
1128 (while p
1129 (or (cl-const-expr-p (cadar p))
e542ea4b 1130 (let ((temp (make-symbol "--cl-var--")))
69d8fb1e 1131 (push (list temp (cadar p)) temps)
fcd73769
RS
1132 (setcar (cdar p) temp)))
1133 (setq p (cdr p)))))
1134 (while specs
1135 (if (and (consp (car specs)) (listp (caar specs)))
1136 (let* ((spec (caar specs)) (nspecs nil)
69d8fb1e 1137 (expr (cadr (pop specs)))
fcd73769 1138 (temp (cdr (or (assq spec loop-destr-temps)
69d8fb1e 1139 (car (push (cons spec (or (last spec 0)
e542ea4b
SM
1140 (make-symbol "--cl-var--")))
1141 loop-destr-temps))))))
69d8fb1e 1142 (push (list temp expr) new)
fcd73769 1143 (while (consp spec)
69d8fb1e 1144 (push (list (pop spec)
fcd73769
RS
1145 (and expr (list (if spec 'pop 'car) temp)))
1146 nspecs))
1147 (setq specs (nconc (nreverse nspecs) specs)))
69d8fb1e 1148 (push (pop specs) new)))
fcd73769
RS
1149 (if (eq body 'setq)
1150 (let ((set (cons (if par 'psetq 'setq) (apply 'nconc (nreverse new)))))
1151 (if temps (list 'let* (nreverse temps) set) set))
1152 (list* (if par 'let 'let*)
1153 (nconc (nreverse temps) (nreverse new)) body))))
1154
1155(defun cl-loop-handle-accum (def &optional func) ; uses args, loop-*
1156 (if (eq (car args) 'into)
1157 (let ((var (cl-pop2 args)))
1158 (or (memq var loop-accum-vars)
69d8fb1e
SM
1159 (progn (push (list (list var def)) loop-bindings)
1160 (push var loop-accum-vars)))
fcd73769
RS
1161 var)
1162 (or loop-accum-var
1163 (progn
e542ea4b 1164 (push (list (list (setq loop-accum-var (make-symbol "--cl-var--")) def))
fcd73769
RS
1165 loop-bindings)
1166 (setq loop-result (if func (list func loop-accum-var)
1167 loop-accum-var))
1168 loop-accum-var))))
1169
1170(defun cl-loop-build-ands (clauses)
1171 (let ((ands nil)
1172 (body nil))
1173 (while clauses
1174 (if (and (eq (car-safe (car clauses)) 'progn)
1175 (eq (car (last (car clauses))) t))
1176 (if (cdr clauses)
1177 (setq clauses (cons (nconc (butlast (car clauses))
1178 (if (eq (car-safe (cadr clauses))
1179 'progn)
1180 (cdadr clauses)
1181 (list (cadr clauses))))
1182 (cddr clauses)))
69d8fb1e
SM
1183 (setq body (cdr (butlast (pop clauses)))))
1184 (push (pop clauses) ands)))
fcd73769
RS
1185 (setq ands (or (nreverse ands) (list t)))
1186 (list (if (cdr ands) (cons 'and ands) (car ands))
1187 body
1188 (let ((full (if body
1189 (append ands (list (cons 'progn (append body '(t)))))
1190 ands)))
1191 (if (cdr full) (cons 'and full) (car full))))))
1192
1193
1194;;; Other iteration control structures.
1195
ebacfcc6 1196;;;###autoload
fcd73769
RS
1197(defmacro do (steps endtest &rest body)
1198 "The Common Lisp `do' loop.
a766dfa1
JB
1199
1200\(fn ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)"
fcd73769
RS
1201 (cl-expand-do-loop steps endtest body nil))
1202
ebacfcc6 1203;;;###autoload
fcd73769
RS
1204(defmacro do* (steps endtest &rest body)
1205 "The Common Lisp `do*' loop.
a766dfa1
JB
1206
1207\(fn ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)"
fcd73769
RS
1208 (cl-expand-do-loop steps endtest body t))
1209
1210(defun cl-expand-do-loop (steps endtest body star)
1211 (list 'block nil
1212 (list* (if star 'let* 'let)
1213 (mapcar (function (lambda (c)
1214 (if (consp c) (list (car c) (nth 1 c)) c)))
1215 steps)
1216 (list* 'while (list 'not (car endtest))
1217 (append body
1218 (let ((sets (mapcar
1219 (function
1220 (lambda (c)
1221 (and (consp c) (cdr (cdr c))
1222 (list (car c) (nth 2 c)))))
1223 steps)))
1224 (setq sets (delq nil sets))
1225 (and sets
1226 (list (cons (if (or star (not (cdr sets)))
1227 'setq 'psetq)
1228 (apply 'append sets)))))))
1229 (or (cdr endtest) '(nil)))))
1230
ebacfcc6 1231;;;###autoload
63744c0f 1232(defmacro dolist (spec &rest body)
69d8fb1e 1233 "Loop over a list.
63744c0f 1234Evaluate BODY with VAR bound to each `car' from LIST, in turn.
69d8fb1e
SM
1235Then evaluate RESULT to get return value, default nil.
1236
1237\(fn (VAR LIST [RESULT]) BODY...)"
e542ea4b 1238 (let ((temp (make-symbol "--cl-dolist-temp--")))
63744c0f
DL
1239 (list 'block nil
1240 (list* 'let (list (list temp (nth 1 spec)) (car spec))
1241 (list* 'while temp (list 'setq (car spec) (list 'car temp))
1242 (append body (list (list 'setq temp
1243 (list 'cdr temp)))))
1244 (if (cdr (cdr spec))
1245 (cons (list 'setq (car spec) nil) (cdr (cdr spec)))
1246 '(nil))))))
1247
ebacfcc6 1248;;;###autoload
63744c0f 1249(defmacro dotimes (spec &rest body)
69d8fb1e 1250 "Loop a certain number of times.
63744c0f
DL
1251Evaluate BODY with VAR bound to successive integers from 0, inclusive,
1252to COUNT, exclusive. Then evaluate RESULT to get return value, default
69d8fb1e
SM
1253nil.
1254
1255\(fn (VAR COUNT [RESULT]) BODY...)"
e542ea4b 1256 (let ((temp (make-symbol "--cl-dotimes-temp--")))
63744c0f
DL
1257 (list 'block nil
1258 (list* 'let (list (list temp (nth 1 spec)) (list (car spec) 0))
1259 (list* 'while (list '< (car spec) temp)
1260 (append body (list (list 'incf (car spec)))))
1261 (or (cdr (cdr spec)) '(nil))))))
1262
ebacfcc6 1263;;;###autoload
fcd73769 1264(defmacro do-symbols (spec &rest body)
69d8fb1e 1265 "Loop over all symbols.
fcd73769 1266Evaluate BODY with VAR bound to each interned symbol, or to each symbol
69d8fb1e
SM
1267from OBARRAY.
1268
1269\(fn (VAR [OBARRAY [RESULT]]) BODY...)"
fcd73769
RS
1270 ;; Apparently this doesn't have an implicit block.
1271 (list 'block nil
1272 (list 'let (list (car spec))
1273 (list* 'mapatoms
1274 (list 'function (list* 'lambda (list (car spec)) body))
1275 (and (cadr spec) (list (cadr spec))))
1276 (caddr spec))))
1277
ebacfcc6 1278;;;###autoload
fcd73769
RS
1279(defmacro do-all-symbols (spec &rest body)
1280 (list* 'do-symbols (list (car spec) nil (cadr spec)) body))
1281
1282
1283;;; Assignments.
1284
ebacfcc6 1285;;;###autoload
fcd73769 1286(defmacro psetq (&rest args)
69d8fb1e 1287 "Set SYMs to the values VALs in parallel.
fcd73769 1288This is like `setq', except that all VAL forms are evaluated (in order)
69d8fb1e
SM
1289before assigning any symbols SYM to the corresponding values.
1290
1291\(fn SYM VAL SYM VAL ...)"
fcd73769
RS
1292 (cons 'psetf args))
1293
1294
1295;;; Binding control structures.
1296
ebacfcc6 1297;;;###autoload
fcd73769 1298(defmacro progv (symbols values &rest body)
64a4c526 1299 "Bind SYMBOLS to VALUES dynamically in BODY.
fcd73769 1300The forms SYMBOLS and VALUES are evaluated, and must evaluate to lists.
3187ba1c 1301Each symbol in the first list is bound to the corresponding value in the
fcd73769
RS
1302second list (or made unbound if VALUES is shorter than SYMBOLS); then the
1303BODY forms are executed and their result is returned. This is much like
1304a `let' form, except that the list of symbols can be computed at run-time."
1305 (list 'let '((cl-progv-save nil))
1306 (list 'unwind-protect
1307 (list* 'progn (list 'cl-progv-before symbols values) body)
1308 '(cl-progv-after))))
1309
1310;;; This should really have some way to shadow 'byte-compile properties, etc.
ebacfcc6 1311;;;###autoload
fcd73769 1312(defmacro flet (bindings &rest body)
3187ba1c 1313 "Make temporary function definitions.
fcd73769
RS
1314This is an analogue of `let' that operates on the function cell of FUNC
1315rather than its value cell. The FORMs are evaluated with the specified
1316function definitions in place, then the definitions are undone (the FUNCs
69d8fb1e
SM
1317go back to their previous definitions, or lack thereof).
1318
1319\(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
fcd73769
RS
1320 (list* 'letf*
1321 (mapcar
1322 (function
1323 (lambda (x)
36f0f2b1
RS
1324 (if (or (and (fboundp (car x))
1325 (eq (car-safe (symbol-function (car x))) 'macro))
1326 (cdr (assq (car x) cl-macro-environment)))
1327 (error "Use `labels', not `flet', to rebind macro names"))
fcd73769
RS
1328 (let ((func (list 'function*
1329 (list 'lambda (cadr x)
1330 (list* 'block (car x) (cddr x))))))
0ee35e51
GM
1331 (when (cl-compiling-file)
1332 ;; Bug#411. It would be nice to fix this.
1333 (and (get (car x) 'byte-compile)
1334 (error "Byte-compiling a redefinition of `%s' \
1335will not work - use `labels' instead" (symbol-name (car x))))
a54fdddb
GM
1336 ;; FIXME This affects the rest of the file, when it
1337 ;; should be restricted to the flet body.
0ee35e51
GM
1338 (and (boundp 'byte-compile-function-environment)
1339 (push (cons (car x) (eval func))
1340 byte-compile-function-environment)))
fcd73769
RS
1341 (list (list 'symbol-function (list 'quote (car x))) func))))
1342 bindings)
1343 body))
1344
ebacfcc6 1345;;;###autoload
36f0f2b1 1346(defmacro labels (bindings &rest body)
3187ba1c 1347 "Make temporary function bindings.
36f0f2b1 1348This is like `flet', except the bindings are lexical instead of dynamic.
69d8fb1e
SM
1349Unlike `flet', this macro is fully compliant with the Common Lisp standard.
1350
1351\(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
36f0f2b1
RS
1352 (let ((vars nil) (sets nil) (cl-macro-environment cl-macro-environment))
1353 (while bindings
443b961a
SM
1354 ;; Use `gensym' rather than `make-symbol'. It's important that
1355 ;; (not (eq (symbol-name var1) (symbol-name var2))) because these
1356 ;; vars get added to the cl-macro-environment.
1357 (let ((var (gensym "--cl-var--")))
69d8fb1e
SM
1358 (push var vars)
1359 (push (list 'function* (cons 'lambda (cdar bindings))) sets)
1360 (push var sets)
1361 (push (list (car (pop bindings)) 'lambda '(&rest cl-labels-args)
36f0f2b1
RS
1362 (list 'list* '(quote funcall) (list 'quote var)
1363 'cl-labels-args))
1364 cl-macro-environment)))
1365 (cl-macroexpand-all (list* 'lexical-let vars (cons (cons 'setq sets) body))
1366 cl-macro-environment)))
fcd73769
RS
1367
1368;; The following ought to have a better definition for use with newer
1369;; byte compilers.
ebacfcc6 1370;;;###autoload
fcd73769 1371(defmacro macrolet (bindings &rest body)
4342e957 1372 "Make temporary macro definitions.
69d8fb1e
SM
1373This is like `flet', but for macros instead of functions.
1374
1375\(fn ((NAME ARGLIST BODY...) ...) FORM...)"
fcd73769
RS
1376 (if (cdr bindings)
1377 (list 'macrolet
1378 (list (car bindings)) (list* 'macrolet (cdr bindings) body))
1379 (if (null bindings) (cons 'progn body)
1380 (let* ((name (caar bindings))
1381 (res (cl-transform-lambda (cdar bindings) name)))
1382 (eval (car res))
1383 (cl-macroexpand-all (cons 'progn body)
1384 (cons (list* name 'lambda (cdr res))
1385 cl-macro-environment))))))
1386
ebacfcc6 1387;;;###autoload
fcd73769 1388(defmacro symbol-macrolet (bindings &rest body)
4342e957 1389 "Make symbol macro definitions.
fcd73769 1390Within the body FORMs, references to the variable NAME will be replaced
69d8fb1e
SM
1391by EXPANSION, and (setq NAME ...) will act like (setf EXPANSION ...).
1392
1393\(fn ((NAME EXPANSION) ...) FORM...)"
fcd73769
RS
1394 (if (cdr bindings)
1395 (list 'symbol-macrolet
1396 (list (car bindings)) (list* 'symbol-macrolet (cdr bindings) body))
1397 (if (null bindings) (cons 'progn body)
1398 (cl-macroexpand-all (cons 'progn body)
1399 (cons (list (symbol-name (caar bindings))
1400 (cadar bindings))
1401 cl-macro-environment)))))
1402
1403(defvar cl-closure-vars nil)
ebacfcc6 1404;;;###autoload
fcd73769 1405(defmacro lexical-let (bindings &rest body)
64a4c526 1406 "Like `let', but lexically scoped.
fcd73769 1407The main visible difference is that lambdas inside BODY will create
3187ba1c
JB
1408lexical closures as in Common Lisp.
1409\n(fn VARLIST BODY)"
fcd73769
RS
1410 (let* ((cl-closure-vars cl-closure-vars)
1411 (vars (mapcar (function
1412 (lambda (x)
1413 (or (consp x) (setq x (list x)))
e542ea4b
SM
1414 (push (make-symbol (format "--cl-%s--" (car x)))
1415 cl-closure-vars)
70a036cf 1416 (set (car cl-closure-vars) [bad-lexical-ref])
fcd73769
RS
1417 (list (car x) (cadr x) (car cl-closure-vars))))
1418 bindings))
a1506d29 1419 (ebody
fcd73769
RS
1420 (cl-macroexpand-all
1421 (cons 'progn body)
1422 (nconc (mapcar (function (lambda (x)
1423 (list (symbol-name (car x))
1424 (list 'symbol-value (caddr x))
1425 t))) vars)
1426 (list '(defun . cl-defun-expander))
1427 cl-macro-environment))))
1428 (if (not (get (car (last cl-closure-vars)) 'used))
1429 (list 'let (mapcar (function (lambda (x)
1430 (list (caddr x) (cadr x)))) vars)
1431 (sublis (mapcar (function (lambda (x)
1432 (cons (caddr x)
1433 (list 'quote (caddr x)))))
1434 vars)
1435 ebody))
1436 (list 'let (mapcar (function (lambda (x)
1437 (list (caddr x)
1438 (list 'make-symbol
1439 (format "--%s--" (car x))))))
1440 vars)
1441 (apply 'append '(setf)
1442 (mapcar (function
1443 (lambda (x)
1444 (list (list 'symbol-value (caddr x)) (cadr x))))
1445 vars))
1446 ebody))))
1447
ebacfcc6 1448;;;###autoload
fcd73769 1449(defmacro lexical-let* (bindings &rest body)
64a4c526 1450 "Like `let*', but lexically scoped.
fcd73769 1451The main visible difference is that lambdas inside BODY will create
3187ba1c
JB
1452lexical closures as in Common Lisp.
1453\n(fn VARLIST BODY)"
fcd73769
RS
1454 (if (null bindings) (cons 'progn body)
1455 (setq bindings (reverse bindings))
1456 (while bindings
69d8fb1e 1457 (setq body (list (list* 'lexical-let (list (pop bindings)) body))))
fcd73769
RS
1458 (car body)))
1459
1460(defun cl-defun-expander (func &rest rest)
1461 (list 'progn
1462 (list 'defalias (list 'quote func)
1463 (list 'function (cons 'lambda rest)))
1464 (list 'quote func)))
1465
1466
1467;;; Multiple values.
1468
ebacfcc6 1469;;;###autoload
fcd73769 1470(defmacro multiple-value-bind (vars form &rest body)
69d8fb1e 1471 "Collect multiple return values.
fcd73769
RS
1472FORM must return a list; the BODY is then executed with the first N elements
1473of this list bound (`let'-style) to each of the symbols SYM in turn. This
1474is analogous to the Common Lisp `multiple-value-bind' macro, using lists to
1475simulate true multiple return values. For compatibility, (values A B C) is
69d8fb1e
SM
1476a synonym for (list A B C).
1477
3187ba1c 1478\(fn (SYM...) FORM BODY)"
e542ea4b 1479 (let ((temp (make-symbol "--cl-var--")) (n -1))
fcd73769
RS
1480 (list* 'let* (cons (list temp form)
1481 (mapcar (function
1482 (lambda (v)
1483 (list v (list 'nth (setq n (1+ n)) temp))))
1484 vars))
1485 body)))
1486
ebacfcc6 1487;;;###autoload
fcd73769 1488(defmacro multiple-value-setq (vars form)
69d8fb1e 1489 "Collect multiple return values.
fcd73769
RS
1490FORM must return a list; the first N elements of this list are stored in
1491each of the symbols SYM in turn. This is analogous to the Common Lisp
1492`multiple-value-setq' macro, using lists to simulate true multiple return
69d8fb1e
SM
1493values. For compatibility, (values A B C) is a synonym for (list A B C).
1494
3187ba1c 1495\(fn (SYM...) FORM)"
fcd73769
RS
1496 (cond ((null vars) (list 'progn form nil))
1497 ((null (cdr vars)) (list 'setq (car vars) (list 'car form)))
1498 (t
e542ea4b 1499 (let* ((temp (make-symbol "--cl-var--")) (n 0))
fcd73769 1500 (list 'let (list (list temp form))
69d8fb1e 1501 (list 'prog1 (list 'setq (pop vars) (list 'car temp))
fcd73769
RS
1502 (cons 'setq (apply 'nconc
1503 (mapcar (function
1504 (lambda (v)
1505 (list v (list
1506 'nth
1507 (setq n (1+ n))
1508 temp))))
1509 vars)))))))))
1510
1511
1512;;; Declarations.
1513
ebacfcc6 1514;;;###autoload
fcd73769 1515(defmacro locally (&rest body) (cons 'progn body))
ebacfcc6 1516;;;###autoload
fcd73769
RS
1517(defmacro the (type form) form)
1518
1519(defvar cl-proclaim-history t) ; for future compilers
1520(defvar cl-declare-stack t) ; for future compilers
1521
1522(defun cl-do-proclaim (spec hist)
69d8fb1e 1523 (and hist (listp cl-proclaim-history) (push spec cl-proclaim-history))
fcd73769
RS
1524 (cond ((eq (car-safe spec) 'special)
1525 (if (boundp 'byte-compile-bound-variables)
1526 (setq byte-compile-bound-variables
1527 (append (cdr spec) byte-compile-bound-variables))))
1528
1529 ((eq (car-safe spec) 'inline)
1530 (while (setq spec (cdr spec))
1531 (or (memq (get (car spec) 'byte-optimizer)
1532 '(nil byte-compile-inline-expand))
1533 (error "%s already has a byte-optimizer, can't make it inline"
1534 (car spec)))
1535 (put (car spec) 'byte-optimizer 'byte-compile-inline-expand)))
1536
1537 ((eq (car-safe spec) 'notinline)
1538 (while (setq spec (cdr spec))
1539 (if (eq (get (car spec) 'byte-optimizer)
1540 'byte-compile-inline-expand)
1541 (put (car spec) 'byte-optimizer nil))))
1542
1543 ((eq (car-safe spec) 'optimize)
1544 (let ((speed (assq (nth 1 (assq 'speed (cdr spec)))
1545 '((0 nil) (1 t) (2 t) (3 t))))
1546 (safety (assq (nth 1 (assq 'safety (cdr spec)))
1547 '((0 t) (1 t) (2 t) (3 nil)))))
1548 (if speed (setq cl-optimize-speed (car speed)
1549 byte-optimize (nth 1 speed)))
1550 (if safety (setq cl-optimize-safety (car safety)
1551 byte-compile-delete-errors (nth 1 safety)))))
1552
1553 ((and (eq (car-safe spec) 'warn) (boundp 'byte-compile-warnings))
fcd73769
RS
1554 (while (setq spec (cdr spec))
1555 (if (consp (car spec))
1556 (if (eq (cadar spec) 0)
bc8ce89b
GM
1557 (byte-compile-disable-warning (caar spec))
1558 (byte-compile-enable-warning (caar spec)))))))
fcd73769
RS
1559 nil)
1560
1561;;; Process any proclamations made before cl-macs was loaded.
1562(defvar cl-proclaims-deferred)
1563(let ((p (reverse cl-proclaims-deferred)))
69d8fb1e 1564 (while p (cl-do-proclaim (pop p) t))
fcd73769
RS
1565 (setq cl-proclaims-deferred nil))
1566
ebacfcc6 1567;;;###autoload
fcd73769
RS
1568(defmacro declare (&rest specs)
1569 (if (cl-compiling-file)
1570 (while specs
69d8fb1e
SM
1571 (if (listp cl-declare-stack) (push (car specs) cl-declare-stack))
1572 (cl-do-proclaim (pop specs) nil)))
fcd73769
RS
1573 nil)
1574
1575
1576
1577;;; Generalized variables.
1578
ebacfcc6 1579;;;###autoload
fcd73769 1580(defmacro define-setf-method (func args &rest body)
69d8fb1e 1581 "Define a `setf' method.
fcd73769
RS
1582This method shows how to handle `setf's to places of the form (NAME ARGS...).
1583The argument forms ARGS are bound according to ARGLIST, as if NAME were
1584going to be expanded as a macro, then the BODY forms are executed and must
1585return a list of five elements: a temporary-variables list, a value-forms
1586list, a store-variables list (of length one), a store-form, and an access-
69d8fb1e
SM
1587form. See `defsetf' for a simpler way to define most setf-methods.
1588
1589\(fn NAME ARGLIST BODY...)"
fcd73769
RS
1590 (append '(eval-when (compile load eval))
1591 (if (stringp (car body))
1592 (list (list 'put (list 'quote func) '(quote setf-documentation)
69d8fb1e 1593 (pop body))))
fcd73769
RS
1594 (list (cl-transform-function-property
1595 func 'setf-method (cons args body)))))
6a78f30f 1596(defalias 'define-setf-expander 'define-setf-method)
fcd73769 1597
ebacfcc6 1598;;;###autoload
fcd73769 1599(defmacro defsetf (func arg1 &rest args)
d0aa0542 1600 "Define a `setf' method.
fcd73769
RS
1601This macro is an easy-to-use substitute for `define-setf-method' that works
1602well for simple place forms. In the simple `defsetf' form, `setf's of
1603the form (setf (NAME ARGS...) VAL) are transformed to function or macro
358e4d6d
JB
1604calls of the form (FUNC ARGS... VAL). Example:
1605
1606 (defsetf aref aset)
1607
fcd73769
RS
1608Alternate form: (defsetf NAME ARGLIST (STORE) BODY...).
1609Here, the above `setf' call is expanded by binding the argument forms ARGS
1610according to ARGLIST, binding the value form VAL to STORE, then executing
1611BODY, which must return a Lisp form that does the necessary `setf' operation.
1612Actually, ARGLIST and STORE may be bound to temporary variables which are
1613introduced automatically to preserve proper execution order of the arguments.
358e4d6d
JB
1614Example:
1615
1616 (defsetf nth (n x) (v) (list 'setcar (list 'nthcdr n x) v))
1617
1618\(fn NAME [FUNC | ARGLIST (STORE) BODY...])"
cb7d9531 1619 (if (and (listp arg1) (consp args))
fcd73769
RS
1620 (let* ((largs nil) (largsr nil)
1621 (temps nil) (tempsr nil)
1622 (restarg nil) (rest-temps nil)
1623 (store-var (car (prog1 (car args) (setq args (cdr args)))))
1624 (store-temp (intern (format "--%s--temp--" store-var)))
1625 (lets1 nil) (lets2 nil)
1626 (docstr nil) (p arg1))
1627 (if (stringp (car args))
1628 (setq docstr (prog1 (car args) (setq args (cdr args)))))
1629 (while (and p (not (eq (car p) '&aux)))
1630 (if (eq (car p) '&rest)
1631 (setq p (cdr p) restarg (car p))
1632 (or (memq (car p) '(&optional &key &allow-other-keys))
1633 (setq largs (cons (if (consp (car p)) (car (car p)) (car p))
1634 largs)
1635 temps (cons (intern (format "--%s--temp--" (car largs)))
1636 temps))))
1637 (setq p (cdr p)))
1638 (setq largs (nreverse largs) temps (nreverse temps))
1639 (if restarg
1640 (setq largsr (append largs (list restarg))
1641 rest-temps (intern (format "--%s--temp--" restarg))
1642 tempsr (append temps (list rest-temps)))
1643 (setq largsr largs tempsr temps))
1644 (let ((p1 largs) (p2 temps))
1645 (while p1
e542ea4b
SM
1646 (setq lets1 (cons `(,(car p2)
1647 (make-symbol ,(format "--cl-%s--" (car p1))))
fcd73769
RS
1648 lets1)
1649 lets2 (cons (list (car p1) (car p2)) lets2)
1650 p1 (cdr p1) p2 (cdr p2))))
1651 (if restarg (setq lets2 (cons (list restarg rest-temps) lets2)))
e542ea4b
SM
1652 `(define-setf-method ,func ,arg1
1653 ,@(and docstr (list docstr))
1654 (let*
1655 ,(nreverse
1656 (cons `(,store-temp
1657 (make-symbol ,(format "--cl-%s--" store-var)))
1658 (if restarg
1659 `((,rest-temps
1660 (mapcar (lambda (_) (make-symbol "--cl-var--"))
1661 ,restarg))
1662 ,@lets1)
1663 lets1)))
1664 (list ; 'values
1665 (,(if restarg 'list* 'list) ,@tempsr)
1666 (,(if restarg 'list* 'list) ,@largsr)
1667 (list ,store-temp)
1668 (let*
1669 ,(nreverse
1670 (cons (list store-var store-temp)
1671 lets2))
1672 ,@args)
1673 (,(if restarg 'list* 'list)
1674 ,@(cons (list 'quote func) tempsr))))))
1675 `(defsetf ,func (&rest args) (store)
1676 ,(let ((call `(cons ',arg1
1677 (append args (list store)))))
1678 (if (car args)
1679 `(list 'progn ,call store)
1680 call)))))
fcd73769
RS
1681
1682;;; Some standard place types from Common Lisp.
1683(defsetf aref aset)
1684(defsetf car setcar)
1685(defsetf cdr setcdr)
c382fb0a
GM
1686(defsetf caar (x) (val) (list 'setcar (list 'car x) val))
1687(defsetf cadr (x) (val) (list 'setcar (list 'cdr x) val))
1688(defsetf cdar (x) (val) (list 'setcdr (list 'car x) val))
1689(defsetf cddr (x) (val) (list 'setcdr (list 'cdr x) val))
fcd73769
RS
1690(defsetf elt (seq n) (store)
1691 (list 'if (list 'listp seq) (list 'setcar (list 'nthcdr n seq) store)
1692 (list 'aset seq n store)))
1693(defsetf get put)
1694(defsetf get* (x y &optional d) (store) (list 'put x y store))
69d8fb1e 1695(defsetf gethash (x h &optional d) (store) (list 'puthash x store h))
fcd73769
RS
1696(defsetf nth (n x) (store) (list 'setcar (list 'nthcdr n x) store))
1697(defsetf subseq (seq start &optional end) (new)
64a4c526 1698 (list 'progn (list 'replace seq new :start1 start :end1 end) new))
fcd73769
RS
1699(defsetf symbol-function fset)
1700(defsetf symbol-plist setplist)
1701(defsetf symbol-value set)
1702
1703;;; Various car/cdr aliases. Note that `cadr' is handled specially.
1704(defsetf first setcar)
1705(defsetf second (x) (store) (list 'setcar (list 'cdr x) store))
1706(defsetf third (x) (store) (list 'setcar (list 'cddr x) store))
1707(defsetf fourth (x) (store) (list 'setcar (list 'cdddr x) store))
1708(defsetf fifth (x) (store) (list 'setcar (list 'nthcdr 4 x) store))
1709(defsetf sixth (x) (store) (list 'setcar (list 'nthcdr 5 x) store))
1710(defsetf seventh (x) (store) (list 'setcar (list 'nthcdr 6 x) store))
1711(defsetf eighth (x) (store) (list 'setcar (list 'nthcdr 7 x) store))
1712(defsetf ninth (x) (store) (list 'setcar (list 'nthcdr 8 x) store))
1713(defsetf tenth (x) (store) (list 'setcar (list 'nthcdr 9 x) store))
1714(defsetf rest setcdr)
1715
1716;;; Some more Emacs-related place types.
1717(defsetf buffer-file-name set-visited-file-name t)
8146c81d
RS
1718(defsetf buffer-modified-p (&optional buf) (flag)
1719 (list 'with-current-buffer buf
1720 (list 'set-buffer-modified-p flag)))
fcd73769
RS
1721(defsetf buffer-name rename-buffer t)
1722(defsetf buffer-string () (store)
1723 (list 'progn '(erase-buffer) (list 'insert store)))
1724(defsetf buffer-substring cl-set-buffer-substring)
1725(defsetf current-buffer set-buffer)
1726(defsetf current-case-table set-case-table)
1727(defsetf current-column move-to-column t)
1728(defsetf current-global-map use-global-map t)
1729(defsetf current-input-mode () (store)
1730 (list 'progn (list 'apply 'set-input-mode store) store))
1731(defsetf current-local-map use-local-map t)
1732(defsetf current-window-configuration set-window-configuration t)
1733(defsetf default-file-modes set-default-file-modes t)
1734(defsetf default-value set-default)
1735(defsetf documentation-property put)
1736(defsetf extent-data set-extent-data)
1737(defsetf extent-face set-extent-face)
1738(defsetf extent-priority set-extent-priority)
1739(defsetf extent-end-position (ext) (store)
1740 (list 'progn (list 'set-extent-endpoints (list 'extent-start-position ext)
1741 store) store))
1742(defsetf extent-start-position (ext) (store)
1743 (list 'progn (list 'set-extent-endpoints store
1744 (list 'extent-end-position ext)) store))
1745(defsetf face-background (f &optional s) (x) (list 'set-face-background f x s))
1746(defsetf face-background-pixmap (f &optional s) (x)
1747 (list 'set-face-background-pixmap f x s))
1748(defsetf face-font (f &optional s) (x) (list 'set-face-font f x s))
1749(defsetf face-foreground (f &optional s) (x) (list 'set-face-foreground f x s))
1750(defsetf face-underline-p (f &optional s) (x)
1751 (list 'set-face-underline-p f x s))
1752(defsetf file-modes set-file-modes t)
1753(defsetf frame-height set-screen-height t)
1754(defsetf frame-parameters modify-frame-parameters t)
1755(defsetf frame-visible-p cl-set-frame-visible-p)
1756(defsetf frame-width set-screen-width t)
a15b3f43 1757(defsetf frame-parameter set-frame-parameter t)
fcd73769
RS
1758(defsetf getenv setenv t)
1759(defsetf get-register set-register)
1760(defsetf global-key-binding global-set-key)
1761(defsetf keymap-parent set-keymap-parent)
1762(defsetf local-key-binding local-set-key)
1763(defsetf mark set-mark t)
1764(defsetf mark-marker set-mark t)
1765(defsetf marker-position set-marker t)
cdef3323 1766(defsetf match-data set-match-data t)
fcd73769
RS
1767(defsetf mouse-position (scr) (store)
1768 (list 'set-mouse-position scr (list 'car store) (list 'cadr store)
1769 (list 'cddr store)))
1770(defsetf overlay-get overlay-put)
1771(defsetf overlay-start (ov) (store)
1772 (list 'progn (list 'move-overlay ov store (list 'overlay-end ov)) store))
1773(defsetf overlay-end (ov) (store)
1774 (list 'progn (list 'move-overlay ov (list 'overlay-start ov) store) store))
1775(defsetf point goto-char)
1776(defsetf point-marker goto-char t)
1777(defsetf point-max () (store)
1778 (list 'progn (list 'narrow-to-region '(point-min) store) store))
1779(defsetf point-min () (store)
1780 (list 'progn (list 'narrow-to-region store '(point-max)) store))
1781(defsetf process-buffer set-process-buffer)
1782(defsetf process-filter set-process-filter)
1783(defsetf process-sentinel set-process-sentinel)
7bd4aefb 1784(defsetf process-get process-put)
fcd73769
RS
1785(defsetf read-mouse-position (scr) (store)
1786 (list 'set-mouse-position scr (list 'car store) (list 'cdr store)))
1787(defsetf screen-height set-screen-height t)
1788(defsetf screen-width set-screen-width t)
1789(defsetf selected-window select-window)
1790(defsetf selected-screen select-screen)
1791(defsetf selected-frame select-frame)
1792(defsetf standard-case-table set-standard-case-table)
1793(defsetf syntax-table set-syntax-table)
1794(defsetf visited-file-modtime set-visited-file-modtime t)
1795(defsetf window-buffer set-window-buffer t)
1796(defsetf window-display-table set-window-display-table t)
1797(defsetf window-dedicated-p set-window-dedicated-p t)
1798(defsetf window-height () (store)
1799 (list 'progn (list 'enlarge-window (list '- store '(window-height))) store))
1800(defsetf window-hscroll set-window-hscroll)
1801(defsetf window-point set-window-point)
1802(defsetf window-start set-window-start)
1803(defsetf window-width () (store)
1804 (list 'progn (list 'enlarge-window (list '- store '(window-width)) t) store))
1805(defsetf x-get-cutbuffer x-store-cutbuffer t)
1806(defsetf x-get-cut-buffer x-store-cut-buffer t) ; groan.
1807(defsetf x-get-secondary-selection x-own-secondary-selection t)
1808(defsetf x-get-selection x-own-selection t)
1809
1810;;; More complex setf-methods.
1811;;; These should take &environment arguments, but since full arglists aren't
1812;;; available while compiling cl-macs, we fake it by referring to the global
1813;;; variable cl-macro-environment directly.
1814
1815(define-setf-method apply (func arg1 &rest rest)
1816 (or (and (memq (car-safe func) '(quote function function*))
1817 (symbolp (car-safe (cdr-safe func))))
1818 (error "First arg to apply in setf is not (function SYM): %s" func))
1819 (let* ((form (cons (nth 1 func) (cons arg1 rest)))
1820 (method (get-setf-method form cl-macro-environment)))
1821 (list (car method) (nth 1 method) (nth 2 method)
1822 (cl-setf-make-apply (nth 3 method) (cadr func) (car method))
1823 (cl-setf-make-apply (nth 4 method) (cadr func) (car method)))))
1824
1825(defun cl-setf-make-apply (form func temps)
1826 (if (eq (car form) 'progn)
1827 (list* 'progn (cl-setf-make-apply (cadr form) func temps) (cddr form))
1828 (or (equal (last form) (last temps))
1829 (error "%s is not suitable for use with setf-of-apply" func))
1830 (list* 'apply (list 'quote (car form)) (cdr form))))
1831
1832(define-setf-method nthcdr (n place)
1833 (let ((method (get-setf-method place cl-macro-environment))
e542ea4b
SM
1834 (n-temp (make-symbol "--cl-nthcdr-n--"))
1835 (store-temp (make-symbol "--cl-nthcdr-store--")))
fcd73769
RS
1836 (list (cons n-temp (car method))
1837 (cons n (nth 1 method))
1838 (list store-temp)
1839 (list 'let (list (list (car (nth 2 method))
1840 (list 'cl-set-nthcdr n-temp (nth 4 method)
1841 store-temp)))
1842 (nth 3 method) store-temp)
1843 (list 'nthcdr n-temp (nth 4 method)))))
1844
1845(define-setf-method getf (place tag &optional def)
1846 (let ((method (get-setf-method place cl-macro-environment))
e542ea4b
SM
1847 (tag-temp (make-symbol "--cl-getf-tag--"))
1848 (def-temp (make-symbol "--cl-getf-def--"))
1849 (store-temp (make-symbol "--cl-getf-store--")))
fcd73769
RS
1850 (list (append (car method) (list tag-temp def-temp))
1851 (append (nth 1 method) (list tag def))
1852 (list store-temp)
1853 (list 'let (list (list (car (nth 2 method))
1854 (list 'cl-set-getf (nth 4 method)
1855 tag-temp store-temp)))
1856 (nth 3 method) store-temp)
1857 (list 'getf (nth 4 method) tag-temp def-temp))))
1858
1859(define-setf-method substring (place from &optional to)
1860 (let ((method (get-setf-method place cl-macro-environment))
e542ea4b
SM
1861 (from-temp (make-symbol "--cl-substring-from--"))
1862 (to-temp (make-symbol "--cl-substring-to--"))
1863 (store-temp (make-symbol "--cl-substring-store--")))
fcd73769
RS
1864 (list (append (car method) (list from-temp to-temp))
1865 (append (nth 1 method) (list from to))
1866 (list store-temp)
1867 (list 'let (list (list (car (nth 2 method))
1868 (list 'cl-set-substring (nth 4 method)
1869 from-temp to-temp store-temp)))
1870 (nth 3 method) store-temp)
1871 (list 'substring (nth 4 method) from-temp to-temp))))
1872
1873;;; Getting and optimizing setf-methods.
ebacfcc6 1874;;;###autoload
fcd73769
RS
1875(defun get-setf-method (place &optional env)
1876 "Return a list of five values describing the setf-method for PLACE.
1877PLACE may be any Lisp form which can appear as the PLACE argument to
1878a macro like `setf' or `incf'."
1879 (if (symbolp place)
e542ea4b 1880 (let ((temp (make-symbol "--cl-setf--")))
fcd73769
RS
1881 (list nil nil (list temp) (list 'setq place temp) place))
1882 (or (and (symbolp (car place))
1883 (let* ((func (car place))
1884 (name (symbol-name func))
1885 (method (get func 'setf-method))
1886 (case-fold-search nil))
1887 (or (and method
1888 (let ((cl-macro-environment env))
1889 (setq method (apply method (cdr place))))
1890 (if (and (consp method) (= (length method) 5))
1891 method
1892 (error "Setf-method for %s returns malformed method"
1893 func)))
20e3d3f1 1894 (and (string-match-p "\\`c[ad][ad][ad]?[ad]?r\\'" name)
fcd73769
RS
1895 (get-setf-method (compiler-macroexpand place)))
1896 (and (eq func 'edebug-after)
1897 (get-setf-method (nth (1- (length place)) place)
1898 env)))))
1899 (if (eq place (setq place (macroexpand place env)))
1900 (if (and (symbolp (car place)) (fboundp (car place))
1901 (symbolp (symbol-function (car place))))
1902 (get-setf-method (cons (symbol-function (car place))
1903 (cdr place)) env)
1904 (error "No setf-method known for %s" (car place)))
1905 (get-setf-method place env)))))
1906
1907(defun cl-setf-do-modify (place opt-expr)
1908 (let* ((method (get-setf-method place cl-macro-environment))
1909 (temps (car method)) (values (nth 1 method))
1910 (lets nil) (subs nil)
1911 (optimize (and (not (eq opt-expr 'no-opt))
1912 (or (and (not (eq opt-expr 'unsafe))
1913 (cl-safe-expr-p opt-expr))
1914 (cl-setf-simple-store-p (car (nth 2 method))
1915 (nth 3 method)))))
1916 (simple (and optimize (consp place) (cl-simple-exprs-p (cdr place)))))
1917 (while values
1918 (if (or simple (cl-const-expr-p (car values)))
69d8fb1e
SM
1919 (push (cons (pop temps) (pop values)) subs)
1920 (push (list (pop temps) (pop values)) lets)))
fcd73769
RS
1921 (list (nreverse lets)
1922 (cons (car (nth 2 method)) (sublis subs (nth 3 method)))
1923 (sublis subs (nth 4 method)))))
1924
1925(defun cl-setf-do-store (spec val)
1926 (let ((sym (car spec))
1927 (form (cdr spec)))
1928 (if (or (cl-const-expr-p val)
1929 (and (cl-simple-expr-p val) (eq (cl-expr-contains form sym) 1))
1930 (cl-setf-simple-store-p sym form))
1931 (subst val sym form)
1932 (list 'let (list (list sym val)) form))))
1933
1934(defun cl-setf-simple-store-p (sym form)
1935 (and (consp form) (eq (cl-expr-contains form sym) 1)
1936 (eq (nth (1- (length form)) form) sym)
1937 (symbolp (car form)) (fboundp (car form))
1938 (not (eq (car-safe (symbol-function (car form))) 'macro))))
1939
1940;;; The standard modify macros.
ebacfcc6 1941;;;###autoload
fcd73769 1942(defmacro setf (&rest args)
69d8fb1e 1943 "Set each PLACE to the value of its VAL.
fcd73769
RS
1944This is a generalized version of `setq'; the PLACEs may be symbolic
1945references such as (car x) or (aref x i), as well as plain symbols.
1946For example, (setf (cadar x) y) is equivalent to (setcar (cdar x) y).
69d8fb1e
SM
1947The return value is the last VAL in the list.
1948
1949\(fn PLACE VAL PLACE VAL ...)"
fcd73769
RS
1950 (if (cdr (cdr args))
1951 (let ((sets nil))
69d8fb1e 1952 (while args (push (list 'setf (pop args) (pop args)) sets))
fcd73769
RS
1953 (cons 'progn (nreverse sets)))
1954 (if (symbolp (car args))
1955 (and args (cons 'setq args))
1956 (let* ((method (cl-setf-do-modify (car args) (nth 1 args)))
1957 (store (cl-setf-do-store (nth 1 method) (nth 1 args))))
1958 (if (car method) (list 'let* (car method) store) store)))))
1959
ebacfcc6 1960;;;###autoload
fcd73769 1961(defmacro psetf (&rest args)
69d8fb1e 1962 "Set PLACEs to the values VALs in parallel.
fcd73769 1963This is like `setf', except that all VAL forms are evaluated (in order)
69d8fb1e
SM
1964before assigning any PLACEs to the corresponding values.
1965
1966\(fn PLACE VAL PLACE VAL ...)"
fcd73769
RS
1967 (let ((p args) (simple t) (vars nil))
1968 (while p
1969 (if (or (not (symbolp (car p))) (cl-expr-depends-p (nth 1 p) vars))
1970 (setq simple nil))
1971 (if (memq (car p) vars)
1972 (error "Destination duplicated in psetf: %s" (car p)))
69d8fb1e 1973 (push (pop p) vars)
fcd73769 1974 (or p (error "Odd number of arguments to psetf"))
69d8fb1e 1975 (pop p))
fcd73769
RS
1976 (if simple
1977 (list 'progn (cons 'setf args) nil)
1978 (setq args (reverse args))
1979 (let ((expr (list 'setf (cadr args) (car args))))
1980 (while (setq args (cddr args))
1981 (setq expr (list 'setf (cadr args) (list 'prog1 (car args) expr))))
1982 (list 'progn expr nil)))))
1983
ebacfcc6 1984;;;###autoload
fcd73769
RS
1985(defun cl-do-pop (place)
1986 (if (cl-simple-expr-p place)
1987 (list 'prog1 (list 'car place) (list 'setf place (list 'cdr place)))
1988 (let* ((method (cl-setf-do-modify place t))
e542ea4b 1989 (temp (make-symbol "--cl-pop--")))
fcd73769
RS
1990 (list 'let*
1991 (append (car method)
1992 (list (list temp (nth 2 method))))
1993 (list 'prog1
1994 (list 'car temp)
1995 (cl-setf-do-store (nth 1 method) (list 'cdr temp)))))))
1996
ebacfcc6 1997;;;###autoload
fcd73769 1998(defmacro remf (place tag)
64a4c526 1999 "Remove TAG from property list PLACE.
fcd73769
RS
2000PLACE may be a symbol, or any generalized variable allowed by `setf'.
2001The form returns true if TAG was found and removed, nil otherwise."
2002 (let* ((method (cl-setf-do-modify place t))
e542ea4b 2003 (tag-temp (and (not (cl-const-expr-p tag)) (make-symbol "--cl-remf-tag--")))
fcd73769 2004 (val-temp (and (not (cl-simple-expr-p place))
e542ea4b 2005 (make-symbol "--cl-remf-place--")))
fcd73769
RS
2006 (ttag (or tag-temp tag))
2007 (tval (or val-temp (nth 2 method))))
2008 (list 'let*
2009 (append (car method)
2010 (and val-temp (list (list val-temp (nth 2 method))))
2011 (and tag-temp (list (list tag-temp tag))))
2012 (list 'if (list 'eq ttag (list 'car tval))
2013 (list 'progn
2014 (cl-setf-do-store (nth 1 method) (list 'cddr tval))
2015 t)
2016 (list 'cl-do-remf tval ttag)))))
2017
ebacfcc6 2018;;;###autoload
fcd73769 2019(defmacro shiftf (place &rest args)
69d8fb1e 2020 "Shift left among PLACEs.
fcd73769 2021Example: (shiftf A B C) sets A to B, B to C, and returns the old A.
69d8fb1e
SM
2022Each PLACE may be a symbol, or any generalized variable allowed by `setf'.
2023
3187ba1c 2024\(fn PLACE... VAL)"
2fa5eef4
SM
2025 (cond
2026 ((null args) place)
2027 ((symbolp place) `(prog1 ,place (setq ,place (shiftf ,@args))))
2028 (t
2029 (let ((method (cl-setf-do-modify place 'unsafe)))
2030 `(let* ,(car method)
2031 (prog1 ,(nth 2 method)
2032 ,(cl-setf-do-store (nth 1 method) `(shiftf ,@args))))))))
fcd73769 2033
ebacfcc6 2034;;;###autoload
fcd73769 2035(defmacro rotatef (&rest args)
69d8fb1e 2036 "Rotate left among PLACEs.
fcd73769 2037Example: (rotatef A B C) sets A to B, B to C, and C to A. It returns nil.
69d8fb1e
SM
2038Each PLACE may be a symbol, or any generalized variable allowed by `setf'.
2039
2040\(fn PLACE...)"
fcd73769
RS
2041 (if (not (memq nil (mapcar 'symbolp args)))
2042 (and (cdr args)
2043 (let ((sets nil)
2044 (first (car args)))
2045 (while (cdr args)
69d8fb1e 2046 (setq sets (nconc sets (list (pop args) (car args)))))
fcd73769
RS
2047 (nconc (list 'psetf) sets (list (car args) first))))
2048 (let* ((places (reverse args))
e542ea4b 2049 (temp (make-symbol "--cl-rotatef--"))
fcd73769
RS
2050 (form temp))
2051 (while (cdr places)
69d8fb1e 2052 (let ((method (cl-setf-do-modify (pop places) 'unsafe)))
fcd73769
RS
2053 (setq form (list 'let* (car method)
2054 (list 'prog1 (nth 2 method)
2055 (cl-setf-do-store (nth 1 method) form))))))
2056 (let ((method (cl-setf-do-modify (car places) 'unsafe)))
2057 (list 'let* (append (car method) (list (list temp (nth 2 method))))
2058 (cl-setf-do-store (nth 1 method) form) nil)))))
2059
ebacfcc6 2060;;;###autoload
fcd73769 2061(defmacro letf (bindings &rest body)
69d8fb1e 2062 "Temporarily bind to PLACEs.
fcd73769
RS
2063This is the analogue of `let', but with generalized variables (in the
2064sense of `setf') for the PLACEs. Each PLACE is set to the corresponding
2065VALUE, then the BODY forms are executed. On exit, either normally or
2066because of a `throw' or error, the PLACEs are set back to their original
2067values. Note that this macro is *not* available in Common Lisp.
2068As a special case, if `(PLACE)' is used instead of `(PLACE VALUE)',
69d8fb1e
SM
2069the PLACE is not modified before executing BODY.
2070
2071\(fn ((PLACE VALUE) ...) BODY...)"
fcd73769
RS
2072 (if (and (not (cdr bindings)) (cdar bindings) (symbolp (caar bindings)))
2073 (list* 'let bindings body)
2074 (let ((lets nil) (sets nil)
2075 (unsets nil) (rev (reverse bindings)))
2076 (while rev
2077 (let* ((place (if (symbolp (caar rev))
2078 (list 'symbol-value (list 'quote (caar rev)))
2079 (caar rev)))
2080 (value (cadar rev))
2081 (method (cl-setf-do-modify place 'no-opt))
e542ea4b 2082 (save (make-symbol "--cl-letf-save--"))
fcd73769 2083 (bound (and (memq (car place) '(symbol-value symbol-function))
e542ea4b 2084 (make-symbol "--cl-letf-bound--")))
fcd73769 2085 (temp (and (not (cl-const-expr-p value)) (cdr bindings)
e542ea4b 2086 (make-symbol "--cl-letf-val--"))))
fcd73769
RS
2087 (setq lets (nconc (car method)
2088 (if bound
2089 (list (list bound
2090 (list (if (eq (car place)
2091 'symbol-value)
2092 'boundp 'fboundp)
2093 (nth 1 (nth 2 method))))
2094 (list save (list 'and bound
2095 (nth 2 method))))
2096 (list (list save (nth 2 method))))
2097 (and temp (list (list temp value)))
2098 lets)
2099 body (list
2100 (list 'unwind-protect
2101 (cons 'progn
2102 (if (cdr (car rev))
2103 (cons (cl-setf-do-store (nth 1 method)
2104 (or temp value))
2105 body)
2106 body))
2107 (if bound
2108 (list 'if bound
2109 (cl-setf-do-store (nth 1 method) save)
2110 (list (if (eq (car place) 'symbol-value)
2111 'makunbound 'fmakunbound)
2112 (nth 1 (nth 2 method))))
2113 (cl-setf-do-store (nth 1 method) save))))
2114 rev (cdr rev))))
2115 (list* 'let* lets body))))
2116
ebacfcc6 2117;;;###autoload
fcd73769 2118(defmacro letf* (bindings &rest body)
69d8fb1e 2119 "Temporarily bind to PLACEs.
fcd73769
RS
2120This is the analogue of `let*', but with generalized variables (in the
2121sense of `setf') for the PLACEs. Each PLACE is set to the corresponding
2122VALUE, then the BODY forms are executed. On exit, either normally or
2123because of a `throw' or error, the PLACEs are set back to their original
2124values. Note that this macro is *not* available in Common Lisp.
2125As a special case, if `(PLACE)' is used instead of `(PLACE VALUE)',
69d8fb1e
SM
2126the PLACE is not modified before executing BODY.
2127
2128\(fn ((PLACE VALUE) ...) BODY...)"
fcd73769
RS
2129 (if (null bindings)
2130 (cons 'progn body)
2131 (setq bindings (reverse bindings))
2132 (while bindings
69d8fb1e 2133 (setq body (list (list* 'letf (list (pop bindings)) body))))
fcd73769
RS
2134 (car body)))
2135
ebacfcc6 2136;;;###autoload
fcd73769 2137(defmacro callf (func place &rest args)
69d8fb1e 2138 "Set PLACE to (FUNC PLACE ARGS...).
fcd73769 2139FUNC should be an unquoted function name. PLACE may be a symbol,
69d8fb1e
SM
2140or any generalized variable allowed by `setf'.
2141
2142\(fn FUNC PLACE ARGS...)"
fcd73769
RS
2143 (let* ((method (cl-setf-do-modify place (cons 'list args)))
2144 (rargs (cons (nth 2 method) args)))
2145 (list 'let* (car method)
2146 (cl-setf-do-store (nth 1 method)
2147 (if (symbolp func) (cons func rargs)
2148 (list* 'funcall (list 'function func)
2149 rargs))))))
2150
ebacfcc6 2151;;;###autoload
fcd73769 2152(defmacro callf2 (func arg1 place &rest args)
69d8fb1e
SM
2153 "Set PLACE to (FUNC ARG1 PLACE ARGS...).
2154Like `callf', but PLACE is the second argument of FUNC, not the first.
2155
2156\(fn FUNC ARG1 PLACE ARGS...)"
fcd73769
RS
2157 (if (and (cl-safe-expr-p arg1) (cl-simple-expr-p place) (symbolp func))
2158 (list 'setf place (list* func arg1 place args))
2159 (let* ((method (cl-setf-do-modify place (cons 'list args)))
e542ea4b 2160 (temp (and (not (cl-const-expr-p arg1)) (make-symbol "--cl-arg1--")))
fcd73769
RS
2161 (rargs (list* (or temp arg1) (nth 2 method) args)))
2162 (list 'let* (append (and temp (list (list temp arg1))) (car method))
2163 (cl-setf-do-store (nth 1 method)
2164 (if (symbolp func) (cons func rargs)
2165 (list* 'funcall (list 'function func)
2166 rargs)))))))
2167
ebacfcc6 2168;;;###autoload
fcd73769 2169(defmacro define-modify-macro (name arglist func &optional doc)
64a4c526 2170 "Define a `setf'-like modify macro.
fcd73769
RS
2171If NAME is called, it combines its PLACE argument with the other arguments
2172from ARGLIST using FUNC: (define-modify-macro incf (&optional (n 1)) +)"
2173 (if (memq '&key arglist) (error "&key not allowed in define-modify-macro"))
e542ea4b 2174 (let ((place (make-symbol "--cl-place--")))
fcd73769
RS
2175 (list 'defmacro* name (cons place arglist) doc
2176 (list* (if (memq '&rest arglist) 'list* 'list)
2177 '(quote callf) (list 'quote func) place
2178 (cl-arglist-args arglist)))))
2179
2180
2181;;; Structures.
2182
ebacfcc6 2183;;;###autoload
fcd73769 2184(defmacro defstruct (struct &rest descs)
69d8fb1e 2185 "Define a struct type.
fcd73769
RS
2186This macro defines a new Lisp data type called NAME, which contains data
2187stored in SLOTs. This defines a `make-NAME' constructor, a `copy-NAME'
69d8fb1e
SM
2188copier, a `NAME-p' predicate, and setf-able `NAME-SLOT' accessors.
2189
2190\(fn (NAME OPTIONS...) (SLOT SLOT-OPTS...)...)"
fcd73769
RS
2191 (let* ((name (if (consp struct) (car struct) struct))
2192 (opts (cdr-safe struct))
2193 (slots nil)
2194 (defaults nil)
2195 (conc-name (concat (symbol-name name) "-"))
2196 (constructor (intern (format "make-%s" name)))
2197 (constrs nil)
2198 (copier (intern (format "copy-%s" name)))
2199 (predicate (intern (format "%s-p" name)))
2200 (print-func nil) (print-auto nil)
2201 (safety (if (cl-compiling-file) cl-optimize-safety 3))
2202 (include nil)
2203 (tag (intern (format "cl-struct-%s" name)))
2204 (tag-symbol (intern (format "cl-struct-%s-tags" name)))
2205 (include-descs nil)
fcd73769
RS
2206 (side-eff nil)
2207 (type nil)
2208 (named nil)
2209 (forms nil)
2210 pred-form pred-check)
2211 (if (stringp (car descs))
69d8fb1e
SM
2212 (push (list 'put (list 'quote name) '(quote structure-documentation)
2213 (pop descs)) forms))
fcd73769
RS
2214 (setq descs (cons '(cl-tag-slot)
2215 (mapcar (function (lambda (x) (if (consp x) x (list x))))
2216 descs)))
2217 (while opts
2218 (let ((opt (if (consp (car opts)) (caar opts) (car opts)))
69d8fb1e 2219 (args (cdr-safe (pop opts))))
64a4c526 2220 (cond ((eq opt :conc-name)
fcd73769
RS
2221 (if args
2222 (setq conc-name (if (car args)
2223 (symbol-name (car args)) ""))))
64a4c526 2224 ((eq opt :constructor)
fcd73769 2225 (if (cdr args)
40e8a6c3
SM
2226 (progn
2227 ;; If this defines a constructor of the same name as
2228 ;; the default one, don't define the default.
2229 (if (eq (car args) constructor)
2230 (setq constructor nil))
2231 (push args constrs))
fcd73769 2232 (if args (setq constructor (car args)))))
64a4c526 2233 ((eq opt :copier)
fcd73769 2234 (if args (setq copier (car args))))
64a4c526 2235 ((eq opt :predicate)
fcd73769 2236 (if args (setq predicate (car args))))
64a4c526 2237 ((eq opt :include)
fcd73769
RS
2238 (setq include (car args)
2239 include-descs (mapcar (function
2240 (lambda (x)
2241 (if (consp x) x (list x))))
36f0f2b1 2242 (cdr args))))
64a4c526 2243 ((eq opt :print-function)
fcd73769 2244 (setq print-func (car args)))
64a4c526 2245 ((eq opt :type)
fcd73769 2246 (setq type (car args)))
64a4c526 2247 ((eq opt :named)
fcd73769 2248 (setq named t))
64a4c526 2249 ((eq opt :initial-offset)
fcd73769
RS
2250 (setq descs (nconc (make-list (car args) '(cl-skip-slot))
2251 descs)))
2252 (t
2253 (error "Slot option %s unrecognized" opt)))))
2254 (if print-func
2255 (setq print-func (list 'progn
2256 (list 'funcall (list 'function print-func)
2257 'cl-x 'cl-s 'cl-n) t))
2258 (or type (and include (not (get include 'cl-struct-print)))
2259 (setq print-auto t
2260 print-func (and (or (not (or include type)) (null print-func))
2261 (list 'progn
2262 (list 'princ (format "#S(%s" name)
2263 'cl-s))))))
2264 (if include
2265 (let ((inc-type (get include 'cl-struct-type))
2266 (old-descs (get include 'cl-struct-slots)))
2267 (or inc-type (error "%s is not a struct name" include))
2268 (and type (not (eq (car inc-type) type))
2269 (error ":type disagrees with :include for %s" name))
2270 (while include-descs
2271 (setcar (memq (or (assq (caar include-descs) old-descs)
2272 (error "No slot %s in included struct %s"
2273 (caar include-descs) include))
2274 old-descs)
69d8fb1e 2275 (pop include-descs)))
fcd73769
RS
2276 (setq descs (append old-descs (delq (assq 'cl-tag-slot descs) descs))
2277 type (car inc-type)
2278 named (assq 'cl-tag-slot descs))
2279 (if (cadr inc-type) (setq tag name named t))
36f0f2b1
RS
2280 (let ((incl include))
2281 (while incl
69d8fb1e 2282 (push (list 'pushnew (list 'quote tag)
36f0f2b1
RS
2283 (intern (format "cl-struct-%s-tags" incl)))
2284 forms)
2285 (setq incl (get incl 'cl-struct-include)))))
fcd73769
RS
2286 (if type
2287 (progn
2288 (or (memq type '(vector list))
4920bd1e 2289 (error "Invalid :type specifier: %s" type))
fcd73769
RS
2290 (if named (setq tag name)))
2291 (setq type 'vector named 'true)))
2292 (or named (setq descs (delq (assq 'cl-tag-slot descs) descs)))
69d8fb1e 2293 (push (list 'defvar tag-symbol) forms)
fcd73769
RS
2294 (setq pred-form (and named
2295 (let ((pos (- (length descs)
2296 (length (memq (assq 'cl-tag-slot descs)
2297 descs)))))
2298 (if (eq type 'vector)
2299 (list 'and '(vectorp cl-x)
2300 (list '>= '(length cl-x) (length descs))
2301 (list 'memq (list 'aref 'cl-x pos)
2302 tag-symbol))
2303 (if (= pos 0)
2304 (list 'memq '(car-safe cl-x) tag-symbol)
2305 (list 'and '(consp cl-x)
2306 (list 'memq (list 'nth pos 'cl-x)
2307 tag-symbol))))))
2308 pred-check (and pred-form (> safety 0)
2309 (if (and (eq (caadr pred-form) 'vectorp)
2310 (= safety 1))
2311 (cons 'and (cdddr pred-form)) pred-form)))
2312 (let ((pos 0) (descp descs))
2313 (while descp
69d8fb1e 2314 (let* ((desc (pop descp))
fcd73769
RS
2315 (slot (car desc)))
2316 (if (memq slot '(cl-tag-slot cl-skip-slot))
2317 (progn
69d8fb1e
SM
2318 (push nil slots)
2319 (push (and (eq slot 'cl-tag-slot) (list 'quote tag))
fcd73769
RS
2320 defaults))
2321 (if (assq slot descp)
2322 (error "Duplicate slots named %s in %s" slot name))
2323 (let ((accessor (intern (format "%s%s" conc-name slot))))
69d8fb1e
SM
2324 (push slot slots)
2325 (push (nth 1 desc) defaults)
2326 (push (list*
fcd73769
RS
2327 'defsubst* accessor '(cl-x)
2328 (append
2329 (and pred-check
2330 (list (list 'or pred-check
2331 (list 'error
2332 (format "%s accessing a non-%s"
6b61353c 2333 accessor name)))))
fcd73769
RS
2334 (list (if (eq type 'vector) (list 'aref 'cl-x pos)
2335 (if (= pos 0) '(car cl-x)
2336 (list 'nth pos 'cl-x)))))) forms)
69d8fb1e
SM
2337 (push (cons accessor t) side-eff)
2338 (push (list 'define-setf-method accessor '(cl-x)
64a4c526 2339 (if (cadr (memq :read-only (cddr desc)))
fcd73769
RS
2340 (list 'error (format "%s is a read-only slot"
2341 accessor))
b9b14938
RS
2342 ;; If cl is loaded only for compilation,
2343 ;; the call to cl-struct-setf-expander would
2344 ;; cause a warning because it may not be
2345 ;; defined at run time. Suppress that warning.
2346 (list 'with-no-warnings
2347 (list 'cl-struct-setf-expander 'cl-x
2348 (list 'quote name) (list 'quote accessor)
2349 (and pred-check (list 'quote pred-check))
2350 pos))))
fcd73769
RS
2351 forms)
2352 (if print-auto
2353 (nconc print-func
2354 (list (list 'princ (format " %s" slot) 'cl-s)
2355 (list 'prin1 (list accessor 'cl-x) 'cl-s)))))))
2356 (setq pos (1+ pos))))
2357 (setq slots (nreverse slots)
2358 defaults (nreverse defaults))
2359 (and predicate pred-form
69d8fb1e 2360 (progn (push (list 'defsubst* predicate '(cl-x)
fcd73769
RS
2361 (if (eq (car pred-form) 'and)
2362 (append pred-form '(t))
2363 (list 'and pred-form t))) forms)
69d8fb1e 2364 (push (cons predicate 'error-free) side-eff)))
fcd73769 2365 (and copier
69d8fb1e
SM
2366 (progn (push (list 'defun copier '(x) '(copy-sequence x)) forms)
2367 (push (cons copier t) side-eff)))
fcd73769 2368 (if constructor
69d8fb1e 2369 (push (list constructor
fcd73769
RS
2370 (cons '&key (delq nil (copy-sequence slots))))
2371 constrs))
2372 (while constrs
2373 (let* ((name (caar constrs))
69d8fb1e 2374 (args (cadr (pop constrs)))
fcd73769
RS
2375 (anames (cl-arglist-args args))
2376 (make (mapcar* (function (lambda (s d) (if (memq s anames) s d)))
2377 slots defaults)))
69d8fb1e 2378 (push (list 'defsubst* name
fcd73769
RS
2379 (list* '&cl-defs (list 'quote (cons nil descs)) args)
2380 (cons type make)) forms)
2381 (if (cl-safe-expr-p (cons 'progn (mapcar 'second descs)))
69d8fb1e 2382 (push (cons name t) side-eff))))
fcd73769
RS
2383 (if print-auto (nconc print-func (list '(princ ")" cl-s) t)))
2384 (if print-func
69d8fb1e 2385 (push (list 'push
fcd73769
RS
2386 (list 'function
2387 (list 'lambda '(cl-x cl-s cl-n)
2388 (list 'and pred-form print-func)))
2389 'custom-print-functions) forms))
69d8fb1e
SM
2390 (push (list 'setq tag-symbol (list 'list (list 'quote tag))) forms)
2391 (push (list* 'eval-when '(compile load eval)
fcd73769
RS
2392 (list 'put (list 'quote name) '(quote cl-struct-slots)
2393 (list 'quote descs))
2394 (list 'put (list 'quote name) '(quote cl-struct-type)
2395 (list 'quote (list type (eq named t))))
36f0f2b1
RS
2396 (list 'put (list 'quote name) '(quote cl-struct-include)
2397 (list 'quote include))
fcd73769
RS
2398 (list 'put (list 'quote name) '(quote cl-struct-print)
2399 print-auto)
2400 (mapcar (function (lambda (x)
2401 (list 'put (list 'quote (car x))
2402 '(quote side-effect-free)
2403 (list 'quote (cdr x)))))
2404 side-eff))
2405 forms)
2406 (cons 'progn (nreverse (cons (list 'quote name) forms)))))
2407
ebacfcc6 2408;;;###autoload
fcd73769 2409(defun cl-struct-setf-expander (x name accessor pred-form pos)
e542ea4b 2410 (let* ((temp (make-symbol "--cl-x--")) (store (make-symbol "--cl-store--")))
fcd73769
RS
2411 (list (list temp) (list x) (list store)
2412 (append '(progn)
2413 (and pred-form
2414 (list (list 'or (subst temp 'cl-x pred-form)
2415 (list 'error
2416 (format
6b61353c 2417 "%s storing a non-%s" accessor name)))))
fcd73769
RS
2418 (list (if (eq (car (get name 'cl-struct-type)) 'vector)
2419 (list 'aset temp pos store)
2420 (list 'setcar
2421 (if (<= pos 5)
2422 (let ((xx temp))
2423 (while (>= (setq pos (1- pos)) 0)
2424 (setq xx (list 'cdr xx)))
2425 xx)
2426 (list 'nthcdr pos temp))
2427 store))))
2428 (list accessor temp))))
2429
2430
2431;;; Types and assertions.
2432
64a4c526
DL
2433(defmacro deftype (name arglist &rest body)
2434 "Define NAME as a new data type.
fcd73769
RS
2435The type name can then be used in `typecase', `check-type', etc."
2436 (list 'eval-when '(compile load eval)
2437 (cl-transform-function-property
64a4c526 2438 name 'cl-deftype-handler (cons (list* '&cl-defs ''('*) arglist) body))))
fcd73769
RS
2439
2440(defun cl-make-type-test (val type)
fcd73769
RS
2441 (if (symbolp type)
2442 (cond ((get type 'cl-deftype-handler)
2443 (cl-make-type-test val (funcall (get type 'cl-deftype-handler))))
2444 ((memq type '(nil t)) type)
e0b16322 2445 ((eq type 'null) `(null ,val))
578f8106 2446 ((eq type 'atom) `(atom ,val))
e0b16322
SM
2447 ((eq type 'float) `(floatp-safe ,val))
2448 ((eq type 'real) `(numberp ,val))
2449 ((eq type 'fixnum) `(integerp ,val))
2450 ;; FIXME: Should `character' accept things like ?\C-\M-a ? -stef
31ff0ac1 2451 ((memq type '(character string-char)) `(characterp ,val))
fcd73769
RS
2452 (t
2453 (let* ((name (symbol-name type))
2454 (namep (intern (concat name "p"))))
2455 (if (fboundp namep) (list namep val)
2456 (list (intern (concat name "-p")) val)))))
2457 (cond ((get (car type) 'cl-deftype-handler)
2458 (cl-make-type-test val (apply (get (car type) 'cl-deftype-handler)
2459 (cdr type))))
e0b16322 2460 ((memq (car type) '(integer float real number))
cb35e559 2461 (delq t (list 'and (cl-make-type-test val (car type))
fcd73769
RS
2462 (if (memq (cadr type) '(* nil)) t
2463 (if (consp (cadr type)) (list '> val (caadr type))
2464 (list '>= val (cadr type))))
2465 (if (memq (caddr type) '(* nil)) t
2466 (if (consp (caddr type)) (list '< val (caaddr type))
2467 (list '<= val (caddr type)))))))
e0b16322 2468 ((memq (car type) '(and or not))
fcd73769
RS
2469 (cons (car type)
2470 (mapcar (function (lambda (x) (cl-make-type-test val x)))
2471 (cdr type))))
e0b16322 2472 ((memq (car type) '(member member*))
fcd73769 2473 (list 'and (list 'member* val (list 'quote (cdr type))) t))
e0b16322 2474 ((eq (car type) 'satisfies) (list (cadr type) val))
fcd73769
RS
2475 (t (error "Bad type spec: %s" type)))))
2476
ebacfcc6 2477;;;###autoload
a766dfa1 2478(defun typep (object type) ; See compiler macro below.
fcd73769
RS
2479 "Check that OBJECT is of type TYPE.
2480TYPE is a Common Lisp-style type specifier."
a766dfa1 2481 (eval (cl-make-type-test 'object type)))
fcd73769 2482
ebacfcc6 2483;;;###autoload
fcd73769
RS
2484(defmacro check-type (form type &optional string)
2485 "Verify that FORM is of type TYPE; signal an error if not.
2486STRING is an optional description of the desired type."
2487 (and (or (not (cl-compiling-file))
2488 (< cl-optimize-speed 3) (= cl-optimize-safety 3))
e542ea4b
SM
2489 (let* ((temp (if (cl-simple-expr-p form 3)
2490 form (make-symbol "--cl-var--")))
fcd73769
RS
2491 (body (list 'or (cl-make-type-test temp type)
2492 (list 'signal '(quote wrong-type-argument)
2493 (list 'list (or string (list 'quote type))
2494 temp (list 'quote form))))))
2495 (if (eq temp form) (list 'progn body nil)
2496 (list 'let (list (list temp form)) body nil)))))
2497
ebacfcc6 2498;;;###autoload
fcd73769
RS
2499(defmacro assert (form &optional show-args string &rest args)
2500 "Verify that FORM returns non-nil; signal an error if not.
2501Second arg SHOW-ARGS means to include arguments of FORM in message.
2502Other args STRING and ARGS... are arguments to be passed to `error'.
2503They are not evaluated unless the assertion fails. If STRING is
2504omitted, a default message listing FORM itself is used."
2505 (and (or (not (cl-compiling-file))
2506 (< cl-optimize-speed 3) (= cl-optimize-safety 3))
2b88d62a
RS
2507 (let ((sargs (and show-args
2508 (delq nil (mapcar
2509 (lambda (x)
2510 (unless (cl-const-expr-p x)
2511 x))
2512 (cdr form))))))
fcd73769
RS
2513 (list 'progn
2514 (list 'or form
2515 (if string
2516 (list* 'error string (append sargs args))
2517 (list 'signal '(quote cl-assertion-failed)
2518 (list* 'list (list 'quote form) sargs))))
2519 nil))))
2520
fcd73769
RS
2521;;; Compiler macros.
2522
ebacfcc6 2523;;;###autoload
fcd73769 2524(defmacro define-compiler-macro (func args &rest body)
64a4c526 2525 "Define a compiler-only macro.
fcd73769
RS
2526This is like `defmacro', but macro expansion occurs only if the call to
2527FUNC is compiled (i.e., not interpreted). Compiler macros should be used
2528for optimizing the way calls to FUNC are compiled; the form returned by
2529BODY should do the same thing as a call to the normal function called
2530FUNC, though possibly more efficiently. Note that, like regular macros,
2531compiler macros are expanded repeatedly until no further expansions are
2532possible. Unlike regular macros, BODY can decide to \"punt\" and leave the
2533original function call alone by declaring an initial `&whole foo' parameter
2534and then returning foo."
16c9c10f 2535 (let ((p args) (res nil))
69d8fb1e 2536 (while (consp p) (push (pop p) res))
16c9c10f 2537 (setq args (nconc (nreverse res) (and p (list '&rest p)))))
fcd73769
RS
2538 (list 'eval-when '(compile load eval)
2539 (cl-transform-function-property
2540 func 'cl-compiler-macro
2541 (cons (if (memq '&whole args) (delq '&whole args)
2542 (cons '--cl-whole-arg-- args)) body))
2543 (list 'or (list 'get (list 'quote func) '(quote byte-compile))
2544 (list 'put (list 'quote func) '(quote byte-compile)
2545 '(quote cl-byte-compile-compiler-macro)))))
2546
ebacfcc6 2547;;;###autoload
fcd73769
RS
2548(defun compiler-macroexpand (form)
2549 (while
2550 (let ((func (car-safe form)) (handler nil))
2551 (while (and (symbolp func)
2552 (not (setq handler (get func 'cl-compiler-macro)))
2553 (fboundp func)
2554 (or (not (eq (car-safe (symbol-function func)) 'autoload))
2555 (load (nth 1 (symbol-function func)))))
2556 (setq func (symbol-function func)))
2557 (and handler
2558 (not (eq form (setq form (apply handler form (cdr form))))))))
2559 form)
2560
2561(defun cl-byte-compile-compiler-macro (form)
2562 (if (eq form (setq form (compiler-macroexpand form)))
2563 (byte-compile-normal-call form)
2564 (byte-compile-form form)))
2565
2566(defmacro defsubst* (name args &rest body)
69d8fb1e 2567 "Define NAME as a function.
fcd73769
RS
2568Like `defun', except the function is automatically declared `inline',
2569ARGLIST allows full Common Lisp conventions, and BODY is implicitly
69d8fb1e
SM
2570surrounded by (block NAME ...).
2571
2572\(fn NAME ARGLIST [DOCSTRING] BODY...)"
fcd73769
RS
2573 (let* ((argns (cl-arglist-args args)) (p argns)
2574 (pbody (cons 'progn body))
2575 (unsafe (not (cl-safe-expr-p pbody))))
69d8fb1e 2576 (while (and p (eq (cl-expr-contains args (car p)) 1)) (pop p))
fcd73769
RS
2577 (list 'progn
2578 (if p nil ; give up if defaults refer to earlier args
2579 (list 'define-compiler-macro name
cc1084a8
SM
2580 (if (memq '&key args)
2581 (list* '&whole 'cl-whole '&cl-quote args)
2582 (cons '&cl-quote args))
fcd73769
RS
2583 (list* 'cl-defsubst-expand (list 'quote argns)
2584 (list 'quote (list* 'block name body))
2585 (not (or unsafe (cl-expr-access-order pbody argns)))
2586 (and (memq '&key args) 'cl-whole) unsafe argns)))
2587 (list* 'defun* name args body))))
2588
2589(defun cl-defsubst-expand (argns body simple whole unsafe &rest argvs)
2590 (if (and whole (not (cl-safe-expr-p (cons 'progn argvs)))) whole
2591 (if (cl-simple-exprs-p argvs) (setq simple t))
2592 (let ((lets (delq nil
2593 (mapcar* (function
2594 (lambda (argn argv)
2595 (if (or simple (cl-const-expr-p argv))
2596 (progn (setq body (subst argv argn body))
2597 (and unsafe (list argn argv)))
2598 (list argn argv))))
2599 argns argvs))))
2600 (if lets (list 'let lets body) body))))
2601
2602
9b77469a
SM
2603;; Compile-time optimizations for some functions defined in this package.
2604;; Note that cl.el arranges to force cl-macs to be loaded at compile-time,
2605;; mainly to make sure these macros will be present.
fcd73769
RS
2606
2607(put 'eql 'byte-compile nil)
2608(define-compiler-macro eql (&whole form a b)
2609 (cond ((eq (cl-const-expr-p a) t)
2610 (let ((val (cl-const-expr-val a)))
2611 (if (and (numberp val) (not (integerp val)))
2612 (list 'equal a b)
2613 (list 'eq a b))))
2614 ((eq (cl-const-expr-p b) t)
2615 (let ((val (cl-const-expr-val b)))
2616 (if (and (numberp val) (not (integerp val)))
2617 (list 'equal a b)
2618 (list 'eq a b))))
2619 ((cl-simple-expr-p a 5)
2620 (list 'if (list 'numberp a)
2621 (list 'equal a b)
2622 (list 'eq a b)))
2623 ((and (cl-safe-expr-p a)
2624 (cl-simple-expr-p b 5))
2625 (list 'if (list 'numberp b)
2626 (list 'equal a b)
2627 (list 'eq a b)))
2628 (t form)))
2629
2630(define-compiler-macro member* (&whole form a list &rest keys)
64a4c526 2631 (let ((test (and (= (length keys) 2) (eq (car keys) :test)
fcd73769
RS
2632 (cl-const-expr-val (nth 1 keys)))))
2633 (cond ((eq test 'eq) (list 'memq a list))
2634 ((eq test 'equal) (list 'member a list))
eae51075 2635 ((or (null keys) (eq test 'eql)) (list 'memql a list))
fcd73769
RS
2636 (t form))))
2637
2638(define-compiler-macro assoc* (&whole form a list &rest keys)
64a4c526 2639 (let ((test (and (= (length keys) 2) (eq (car keys) :test)
fcd73769
RS
2640 (cl-const-expr-val (nth 1 keys)))))
2641 (cond ((eq test 'eq) (list 'assq a list))
2642 ((eq test 'equal) (list 'assoc a list))
2643 ((and (eq (cl-const-expr-p a) t) (or (null keys) (eq test 'eql)))
2644 (if (floatp-safe (cl-const-expr-val a))
2645 (list 'assoc a list) (list 'assq a list)))
2646 (t form))))
2647
2648(define-compiler-macro adjoin (&whole form a list &rest keys)
2649 (if (and (cl-simple-expr-p a) (cl-simple-expr-p list)
64a4c526 2650 (not (memq :key keys)))
fcd73769
RS
2651 (list 'if (list* 'member* a list keys) list (list 'cons a list))
2652 form))
2653
2654(define-compiler-macro list* (arg &rest others)
2655 (let* ((args (reverse (cons arg others)))
2656 (form (car args)))
2657 (while (setq args (cdr args))
2658 (setq form (list 'cons (car args) form)))
2659 form))
2660
2661(define-compiler-macro get* (sym prop &optional def)
2662 (if def
2663 (list 'getf (list 'symbol-plist sym) prop def)
2664 (list 'get sym prop)))
2665
2666(define-compiler-macro typep (&whole form val type)
2667 (if (cl-const-expr-p type)
2668 (let ((res (cl-make-type-test val (cl-const-expr-val type))))
2669 (if (or (memq (cl-expr-contains res val) '(nil 1))
2670 (cl-simple-expr-p val)) res
e542ea4b 2671 (let ((temp (make-symbol "--cl-var--")))
fcd73769
RS
2672 (list 'let (list (list temp val)) (subst temp val res)))))
2673 form))
2674
2675
e542ea4b
SM
2676(mapc (lambda (y)
2677 (put (car y) 'side-effect-free t)
2678 (put (car y) 'byte-compile 'cl-byte-compile-compiler-macro)
2679 (put (car y) 'cl-compiler-macro
2680 `(lambda (w x)
2681 ,(if (symbolp (cadr y))
2682 `(list ',(cadr y)
2683 (list ',(caddr y) x))
2684 (cons 'list (cdr y))))))
2685 '((first 'car x) (second 'cadr x) (third 'caddr x) (fourth 'cadddr x)
2686 (fifth 'nth 4 x) (sixth 'nth 5 x) (seventh 'nth 6 x)
2687 (eighth 'nth 7 x) (ninth 'nth 8 x) (tenth 'nth 9 x)
2688 (rest 'cdr x) (endp 'null x) (plusp '> x 0) (minusp '< x 0)
2689 (caaar car caar) (caadr car cadr) (cadar car cdar)
2690 (caddr car cddr) (cdaar cdr caar) (cdadr cdr cadr)
2691 (cddar cdr cdar) (cdddr cdr cddr) (caaaar car caaar)
2692 (caaadr car caadr) (caadar car cadar) (caaddr car caddr)
2693 (cadaar car cdaar) (cadadr car cdadr) (caddar car cddar)
2694 (cadddr car cdddr) (cdaaar cdr caaar) (cdaadr cdr caadr)
2695 (cdadar cdr cadar) (cdaddr cdr caddr) (cddaar cdr cdaar)
2696 (cddadr cdr cdadr) (cdddar cdr cddar) (cddddr cdr cdddr) ))
fcd73769
RS
2697
2698;;; Things that are inline.
2699(proclaim '(inline floatp-safe acons map concatenate notany notevery
2700 cl-set-elt revappend nreconc gethash))
2701
2702;;; Things that are side-effect-free.
e542ea4b
SM
2703(mapc (lambda (x) (put x 'side-effect-free t))
2704 '(oddp evenp signum last butlast ldiff pairlis gcd lcm
2705 isqrt floor* ceiling* truncate* round* mod* rem* subseq
2706 list-length get* getf))
fcd73769
RS
2707
2708;;; Things that are side-effect-and-error-free.
e542ea4b
SM
2709(mapc (lambda (x) (put x 'side-effect-free 'error-free))
2710 '(eql floatp-safe list* subst acons equalp random-state-p
2711 copy-tree sublis))
fcd73769
RS
2712
2713
2714(run-hooks 'cl-macs-load-hook)
2715
ebacfcc6 2716;; Local variables:
bc8ce89b
GM
2717;; byte-compile-dynamic: t
2718;; byte-compile-warnings: (not cl-functions)
ebacfcc6
SM
2719;; generated-autoload-file: "cl-loaddefs.el"
2720;; End:
b69a3374 2721
e542ea4b 2722;; arch-tag: afd947a6-b553-4df1-bba5-000be6388f46
fcd73769 2723;;; cl-macs.el ends here