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