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