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