1 ;;; cl-macs.el --- Common Lisp macros
3 ;; Copyright (C) 1993, 2001-2011 Free Software Foundation, Inc.
5 ;; Author: Dave Gillespie <daveg@synaptics.com>
7 ;; Keywords: extensions
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; These are extensions to Emacs Lisp that provide a degree of
28 ;; Common Lisp compatibility, beyond what is already built-in
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.
34 ;; Bug reports, comments, and suggestions are welcome!
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.
41 ;; See cl.el for Change Log.
48 (defmacro cl-pop2
(place)
49 (list 'prog1
(list 'car
(list 'cdr place
))
50 (list 'setq place
(list 'cdr
(list 'cdr place
)))))
51 (put 'cl-pop2
'edebug-form-spec
'edebug-sexps
)
53 (defvar cl-optimize-safety
)
54 (defvar cl-optimize-speed
)
57 ;; This kludge allows macros which use cl-transform-function-property
58 ;; to be called at compile-time.
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
))))))
72 (defvar cl-old-bc-file-form nil
)
74 ;;; Some predicates for analyzing Lisp forms. These are used by various
75 ;;; macro expanders to optimize the results in certain common cases.
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
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
))
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
))))
96 (defun cl-simple-exprs-p (xs)
97 (while (and xs
(cl-simple-expr-p (car xs
)))
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
))
109 (while (and (setq x
(cdr x
)) (cl-safe-expr-p (car x
))))
112 ;;; Check if constant (i.e., no side effects or dependencies).
113 (defun cl-const-expr-p (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
))
122 (defun cl-const-exprs-p (xs)
123 (while (and xs
(cl-const-expr-p (car xs
)))
127 (defun cl-const-expr-val (x)
128 (and (eq (cl-const-expr-p x
) t
) (if (consp x
) (nth 1 x
) x
)))
130 (defun cl-expr-access-order (x v
)
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
135 ;; FIXME: This is very naive, it doesn't even check to see if those
136 ;; variables appear more than once.
137 (if (cl-const-expr-p x
) v
140 (while (setq x
(cdr x
)) (setq v
(cl-expr-access-order (car x
) v
)))
142 (if (eq x
(car v
)) (cdr v
) '(t)))))
144 ;;; Count number of times X refers to Y. Return nil for 0 times.
145 (defun cl-expr-contains (x y
)
146 (cond ((equal y x
) 1)
147 ((and (consp x
) (not (memq (car-safe x
) '(quote function function
*))))
150 (setq sum
(+ sum
(or (cl-expr-contains (pop x
) y
) 0))))
151 (and (> sum
0) sum
)))
154 (defun cl-expr-contains-any (x y
)
155 (while (and y
(not (cl-expr-contains x
(car y
)))) (pop y
))
158 ;;; Check whether X may depend on any of the symbols in Y.
159 (defun cl-expr-depends-p (x y
)
160 (and (not (cl-const-expr-p x
))
161 (or (not (cl-safe-expr-p x
)) (cl-expr-contains-any x y
))))
165 (defvar *gensym-counter
*)
167 (defun gensym (&optional prefix
)
168 "Generate a new uninterned symbol.
169 The name is made by appending a number to PREFIX, default \"G\"."
170 (let ((pfix (if (stringp prefix
) prefix
"G"))
171 (num (if (integerp prefix
) prefix
172 (prog1 *gensym-counter
*
173 (setq *gensym-counter
* (1+ *gensym-counter
*))))))
174 (make-symbol (format "%s%d" pfix num
))))
177 (defun gentemp (&optional prefix
)
178 "Generate a new interned symbol with a unique name.
179 The name is made by appending a number to PREFIX, default \"G\"."
180 (let ((pfix (if (stringp prefix
) prefix
"G"))
182 (while (intern-soft (setq name
(format "%s%d" pfix
*gensym-counter
*)))
183 (setq *gensym-counter
* (1+ *gensym-counter
*)))
187 ;;; Program structure.
190 (defmacro defun
* (name args
&rest body
)
191 "Define NAME as a function.
192 Like normal `defun', except ARGLIST allows full Common Lisp conventions,
193 and BODY is implicitly surrounded by (block NAME ...).
195 \(fn NAME ARGLIST [DOCSTRING] BODY...)"
196 (let* ((res (cl-transform-lambda (cons args body
) name
))
197 (form (list* 'defun
name (cdr res
))))
198 (if (car res
) (list 'progn
(car res
) form
) form
)))
201 (defmacro defmacro
* (name args
&rest body
)
202 "Define NAME as a macro.
203 Like normal `defmacro', except ARGLIST allows full Common Lisp conventions,
204 and BODY is implicitly surrounded by (block NAME ...).
206 \(fn NAME ARGLIST [DOCSTRING] BODY...)"
207 (let* ((res (cl-transform-lambda (cons args body
) name
))
208 (form (list* 'defmacro name
(cdr res
))))
209 (if (car res
) (list 'progn
(car res
) form
) form
)))
212 (defmacro function
* (func)
213 "Introduce a function.
214 Like normal `function', except that if argument is a lambda form,
215 its argument list allows full Common Lisp conventions."
216 (if (eq (car-safe func
) 'lambda
)
217 (let* ((res (cl-transform-lambda (cdr func
) 'cl-none
))
218 (form (list 'function
(cons 'lambda
(cdr res
)))))
219 (if (car res
) (list 'progn
(car res
) form
) form
))
220 (list 'function func
)))
222 (defun cl-transform-function-property (func prop form
)
223 (let ((res (cl-transform-lambda form func
)))
224 (append '(progn) (cdr (cdr (car res
)))
225 (list (list 'put
(list 'quote func
) (list 'quote prop
)
226 (list 'function
(cons 'lambda
(cdr res
))))))))
228 (defconst lambda-list-keywords
229 '(&optional
&rest
&key
&allow-other-keys
&aux
&whole
&body
&environment
))
231 (defvar cl-macro-environment nil
232 "Keep the list of currently active macros.
233 It is a list of elements of the form either:
234 - (SYMBOL . FUNCTION) where FUNCTION is the macro expansion function.
235 - (SYMBOL-NAME . EXPANSION) where SYMBOL-NAME is the name of a symbol macro.")
236 (defvar bind-block
) (defvar bind-defs
) (defvar bind-enquote
)
237 (defvar bind-inits
) (defvar bind-lets
) (defvar bind-forms
)
239 (declare-function help-add-fundoc-usage
"help-fns" (docstring arglist
))
241 (defun cl-transform-lambda (form bind-block
)
242 (let* ((args (car form
)) (body (cdr form
)) (orig-args args
)
243 (bind-defs nil
) (bind-enquote nil
)
244 (bind-inits nil
) (bind-lets nil
) (bind-forms nil
)
245 (header nil
) (simple-args nil
))
246 (while (or (stringp (car body
))
247 (memq (car-safe (car body
)) '(interactive declare
)))
248 (push (pop body
) header
))
249 (setq args
(if (listp args
) (copy-list args
) (list '&rest args
)))
250 (let ((p (last args
))) (if (cdr p
) (setcdr p
(list '&rest
(cdr p
)))))
251 (if (setq bind-defs
(cadr (memq '&cl-defs args
)))
252 (setq args
(delq '&cl-defs
(delq bind-defs args
))
253 bind-defs
(cadr bind-defs
)))
254 (if (setq bind-enquote
(memq '&cl-quote args
))
255 (setq args
(delq '&cl-quote args
)))
256 (if (memq '&whole args
) (error "&whole not currently implemented"))
257 (let* ((p (memq '&environment args
)) (v (cadr p
)))
258 (if p
(setq args
(nconc (delq (car p
) (delq v args
))
259 (list '&aux
(list v
'cl-macro-environment
))))))
260 (while (and args
(symbolp (car args
))
261 (not (memq (car args
) '(nil &rest
&body
&key
&aux
)))
262 (not (and (eq (car args
) '&optional
)
263 (or bind-defs
(consp (cadr args
))))))
264 (push (pop args
) simple-args
))
265 (or (eq bind-block
'cl-none
)
266 (setq body
(list (list* 'block bind-block body
))))
268 (list* nil
(nreverse simple-args
) (nconc (nreverse header
) body
))
269 (if (memq '&optional simple-args
) (push '&optional args
))
270 (cl-do-arglist args nil
(- (length simple-args
)
271 (if (memq '&optional simple-args
) 1 0)))
272 (setq bind-lets
(nreverse bind-lets
))
273 (list* (and bind-inits
(list* 'eval-when
'(compile load eval
)
274 (nreverse bind-inits
)))
275 (nconc (nreverse simple-args
)
276 (list '&rest
(car (pop bind-lets
))))
277 (nconc (let ((hdr (nreverse header
)))
278 ;; Macro expansion can take place in the middle of
279 ;; apparently harmless computation, so it should not
280 ;; touch the match-data.
283 (cons (help-add-fundoc-usage
284 (if (stringp (car hdr
)) (pop hdr
))
285 ;; orig-args can contain &cl-defs (an internal
286 ;; CL thingy I don't understand), so remove it.
287 (let ((x (memq '&cl-defs orig-args
)))
288 (if (null x
) orig-args
289 (delq (car x
) (remq (cadr x
) orig-args
)))))
291 (list (nconc (list 'let
* bind-lets
)
292 (nreverse bind-forms
) body
)))))))
294 (defun cl-do-arglist (args expr
&optional num
) ; uses bind-*
296 (if (or (memq args lambda-list-keywords
) (not (symbolp args
)))
297 (error "Invalid argument name: %s" args
)
298 (push (list args expr
) bind-lets
))
299 (setq args
(copy-list args
))
300 (let ((p (last args
))) (if (cdr p
) (setcdr p
(list '&rest
(cdr p
)))))
301 (let ((p (memq '&body args
))) (if p
(setcar p
'&rest
)))
302 (if (memq '&environment args
) (error "&environment used incorrectly"))
303 (let ((save-args args
)
304 (restarg (memq '&rest args
))
305 (safety (if (cl-compiling-file) cl-optimize-safety
3))
307 (laterarg nil
) (exactarg nil
) minarg
)
308 (or num
(setq num
0))
309 (if (listp (cadr restarg
))
310 (setq restarg
(make-symbol "--cl-rest--"))
311 (setq restarg
(cadr restarg
)))
312 (push (list restarg expr
) bind-lets
)
313 (if (eq (car args
) '&whole
)
314 (push (list (cl-pop2 args
) restarg
) bind-lets
))
316 (setq minarg restarg
)
317 (while (and p
(not (memq (car p
) lambda-list-keywords
)))
318 (or (eq p args
) (setq minarg
(list 'cdr minarg
)))
320 (if (memq (car p
) '(nil &aux
))
321 (setq minarg
(list '= (list 'length restarg
)
322 (length (ldiff args p
)))
323 exactarg
(not (eq args p
)))))
324 (while (and args
(not (memq (car args
) lambda-list-keywords
)))
325 (let ((poparg (list (if (or (cdr args
) (not exactarg
)) 'pop
'car
)
329 (if (or laterarg
(= safety
0)) poparg
330 (list 'if minarg poparg
331 (list 'signal
'(quote wrong-number-of-arguments
)
332 (list 'list
(and (not (eq bind-block
'cl-none
))
333 (list 'quote bind-block
))
334 (list 'length restarg
)))))))
335 (setq num
(1+ num
) laterarg t
))
336 (while (and (eq (car args
) '&optional
) (pop args
))
337 (while (and args
(not (memq (car args
) lambda-list-keywords
)))
338 (let ((arg (pop args
)))
339 (or (consp arg
) (setq arg
(list arg
)))
340 (if (cddr arg
) (cl-do-arglist (nth 2 arg
) (list 'and restarg t
)))
341 (let ((def (if (cdr arg
) (nth 1 arg
)
343 (nth 1 (assq (car arg
) bind-defs
)))))
344 (poparg (list 'pop restarg
)))
345 (and def bind-enquote
(setq def
(list 'quote def
)))
346 (cl-do-arglist (car arg
)
347 (if def
(list 'if restarg poparg def
) poparg
))
348 (setq num
(1+ num
))))))
349 (if (eq (car args
) '&rest
)
350 (let ((arg (cl-pop2 args
)))
351 (if (consp arg
) (cl-do-arglist arg restarg
)))
352 (or (eq (car args
) '&key
) (= safety
0) exactarg
353 (push (list 'if restarg
354 (list 'signal
'(quote wrong-number-of-arguments
)
356 (and (not (eq bind-block
'cl-none
))
357 (list 'quote bind-block
))
358 (list '+ num
(list 'length restarg
)))))
360 (while (and (eq (car args
) '&key
) (pop args
))
361 (while (and args
(not (memq (car args
) lambda-list-keywords
)))
362 (let ((arg (pop args
)))
363 (or (consp arg
) (setq arg
(list arg
)))
364 (let* ((karg (if (consp (car arg
)) (caar arg
)
365 (intern (format ":%s" (car arg
)))))
366 (varg (if (consp (car arg
)) (cadar arg
) (car arg
)))
367 (def (if (cdr arg
) (cadr arg
)
368 (or (car bind-defs
) (cadr (assq varg bind-defs
)))))
369 (look (list 'memq
(list 'quote karg
) restarg
)))
370 (and def bind-enquote
(setq def
(list 'quote def
)))
372 (let* ((temp (or (nth 2 arg
) (make-symbol "--cl-var--")))
373 (val (list 'car
(list 'cdr temp
))))
374 (cl-do-arglist temp look
)
377 (list 'prog1 val
(list 'setq temp t
))
386 (if (eq (cl-const-expr-p def
) t
)
389 (list nil
(cl-const-expr-val def
)))
390 (list 'list nil def
))))))))
392 (setq keys
(nreverse keys
))
393 (or (and (eq (car args
) '&allow-other-keys
) (pop args
))
394 (null keys
) (= safety
0)
395 (let* ((var (make-symbol "--cl-keys--"))
396 (allow '(:allow-other-keys
))
401 (list (list 'memq
(list 'car var
)
402 (list 'quote
(append keys allow
)))
403 (list 'setq var
(list 'cdr
(list 'cdr var
))))
406 (list 'memq
(cons 'quote allow
)
408 (list 'setq var nil
))
412 (format "Keyword argument %%s not one of %s"
414 (list 'car var
)))))))
415 (push (list 'let
(list (list var restarg
)) check
) bind-forms
)))
416 (while (and (eq (car args
) '&aux
) (pop args
))
417 (while (and args
(not (memq (car args
) lambda-list-keywords
)))
418 (if (consp (car args
))
419 (if (and bind-enquote
(cadar args
))
420 (cl-do-arglist (caar args
)
421 (list 'quote
(cadr (pop args
))))
422 (cl-do-arglist (caar args
) (cadr (pop args
))))
423 (cl-do-arglist (pop args
) nil
))))
424 (if args
(error "Malformed argument list %s" save-args
)))))
426 (defun cl-arglist-args (args)
427 (if (nlistp args
) (list args
)
428 (let ((res nil
) (kind nil
) arg
)
430 (setq arg
(pop args
))
431 (if (memq arg lambda-list-keywords
) (setq kind arg
)
432 (if (eq arg
'&cl-defs
) (pop args
)
433 (and (consp arg
) kind
(setq arg
(car arg
)))
434 (and (consp arg
) (cdr arg
) (eq kind
'&key
) (setq arg
(cadr arg
)))
435 (setq res
(nconc res
(cl-arglist-args arg
))))))
436 (nconc res
(and args
(list args
))))))
439 (defmacro destructuring-bind
(args expr
&rest body
)
440 (let* ((bind-lets nil
) (bind-forms nil
) (bind-inits nil
)
441 (bind-defs nil
) (bind-block 'cl-none
) (bind-enquote nil
))
442 (cl-do-arglist (or args
'(&aux
)) expr
)
443 (append '(progn) bind-inits
444 (list (nconc (list 'let
* (nreverse bind-lets
))
445 (nreverse bind-forms
) body
)))))
448 ;;; The `eval-when' form.
450 (defvar cl-not-toplevel nil
)
453 (defmacro eval-when
(when &rest body
)
454 "Control when BODY is evaluated.
455 If `compile' is in WHEN, BODY is evaluated when compiled at top-level.
456 If `load' is in WHEN, BODY is evaluated when loaded after top-level compile.
457 If `eval' is in WHEN, BODY is evaluated when interpreted or at non-top-level.
459 \(fn (WHEN...) BODY...)"
460 (if (and (fboundp 'cl-compiling-file
) (cl-compiling-file)
461 (not cl-not-toplevel
) (not (boundp 'for-effect
))) ; horrible kludge
462 (let ((comp (or (memq 'compile when
) (memq :compile-toplevel when
)))
464 (if (or (memq 'load when
) (memq :load-toplevel when
))
465 (if comp
(cons 'progn
(mapcar 'cl-compile-time-too body
))
466 (list* 'if nil nil body
))
467 (progn (if comp
(eval (cons 'progn body
))) nil
)))
468 (and (or (memq 'eval when
) (memq :execute when
))
469 (cons 'progn body
))))
471 (defun cl-compile-time-too (form)
472 (or (and (symbolp (car-safe form
)) (get (car-safe form
) 'byte-hunk-handler
))
473 (setq form
(macroexpand
474 form
(cons '(eval-when) byte-compile-macro-environment
))))
475 (cond ((eq (car-safe form
) 'progn
)
476 (cons 'progn
(mapcar 'cl-compile-time-too
(cdr form
))))
477 ((eq (car-safe form
) 'eval-when
)
478 (let ((when (nth 1 form
)))
479 (if (or (memq 'eval when
) (memq :execute when
))
480 (list* 'eval-when
(cons 'compile when
) (cddr form
))
482 (t (eval form
) form
)))
485 (defmacro load-time-value
(form &optional read-only
)
486 "Like `progn', but evaluates the body at load time.
487 The result of the body appears to the compiler as a quoted constant."
488 (if (cl-compiling-file)
489 (let* ((temp (gentemp "--cl-load-time--"))
490 (set (list 'set
(list 'quote temp
) form
)))
491 (if (and (fboundp 'byte-compile-file-form-defmumble
)
492 (boundp 'this-kind
) (boundp 'that-one
))
493 (fset 'byte-compile-file-form
494 (list 'lambda
'(form)
495 (list 'fset
'(quote byte-compile-file-form
)
497 (symbol-function 'byte-compile-file-form
)))
498 (list 'byte-compile-file-form
(list 'quote set
))
499 '(byte-compile-file-form form
)))
500 (print set
(symbol-value 'byte-compile--outbuffer
)))
501 (list 'symbol-value
(list 'quote temp
)))
502 (list 'quote
(eval form
))))
505 ;;; Conditional control structures.
508 (defmacro case
(expr &rest clauses
)
509 "Eval EXPR and choose among clauses on that value.
510 Each clause looks like (KEYLIST BODY...). EXPR is evaluated and compared
511 against each key in each KEYLIST; the corresponding BODY is evaluated.
512 If no clause succeeds, case returns nil. A single atom may be used in
513 place of a KEYLIST of one atom. A KEYLIST of t or `otherwise' is
514 allowed only in the final clause, and matches if no other keys match.
515 Key values are compared by `eql'.
516 \n(fn EXPR (KEYLIST BODY...)...)"
517 (let* ((temp (if (cl-simple-expr-p expr
3) expr
(make-symbol "--cl-var--")))
524 (cons (cond ((memq (car c
) '(t otherwise
)) t
)
525 ((eq (car c
) 'ecase-error-flag
)
526 (list 'error
"ecase failed: %s, %s"
527 temp
(list 'quote
(reverse head-list
))))
529 (setq head-list
(append (car c
) head-list
))
530 (list 'member
* temp
(list 'quote
(car c
))))
532 (if (memq (car c
) head-list
)
533 (error "Duplicate key in case: %s"
535 (push (car c
) head-list
)
536 (list 'eql temp
(list 'quote
(car c
)))))
537 (or (cdr c
) '(nil)))))
539 (if (eq temp expr
) body
540 (list 'let
(list (list temp expr
)) body
))))
543 (defmacro ecase
(expr &rest clauses
)
544 "Like `case', but error if no case fits.
545 `otherwise'-clauses are not allowed.
546 \n(fn EXPR (KEYLIST BODY...)...)"
547 (list* 'case expr
(append clauses
'((ecase-error-flag)))))
550 (defmacro typecase
(expr &rest clauses
)
551 "Evals EXPR, chooses among clauses on that value.
552 Each clause looks like (TYPE BODY...). EXPR is evaluated and, if it
553 satisfies TYPE, the corresponding BODY is evaluated. If no clause succeeds,
554 typecase returns nil. A TYPE of t or `otherwise' is allowed only in the
555 final clause, and matches if no other keys match.
556 \n(fn EXPR (TYPE BODY...)...)"
557 (let* ((temp (if (cl-simple-expr-p expr
3) expr
(make-symbol "--cl-var--")))
564 (cons (cond ((eq (car c
) 'otherwise
) t
)
565 ((eq (car c
) 'ecase-error-flag
)
566 (list 'error
"etypecase failed: %s, %s"
567 temp
(list 'quote
(reverse type-list
))))
569 (push (car c
) type-list
)
570 (cl-make-type-test temp
(car c
))))
571 (or (cdr c
) '(nil)))))
573 (if (eq temp expr
) body
574 (list 'let
(list (list temp expr
)) body
))))
577 (defmacro etypecase
(expr &rest clauses
)
578 "Like `typecase', but error if no case fits.
579 `otherwise'-clauses are not allowed.
580 \n(fn EXPR (TYPE BODY...)...)"
581 (list* 'typecase expr
(append clauses
'((ecase-error-flag)))))
584 ;;; Blocks and exits.
587 (defmacro block
(name &rest body
)
588 "Define a lexically-scoped block named NAME.
589 NAME may be any symbol. Code inside the BODY forms can call `return-from'
590 to jump prematurely out of the block. This differs from `catch' and `throw'
591 in two respects: First, the NAME is an unevaluated symbol rather than a
592 quoted symbol or other form; and second, NAME is lexically rather than
593 dynamically scoped: Only references to it within BODY will work. These
594 references may appear inside macro expansions, but not inside functions
596 (if (cl-safe-expr-p (cons 'progn body
)) (cons 'progn body
)
597 (list 'cl-block-wrapper
598 (list* 'catch
(list 'quote
(intern (format "--cl-block-%s--" name
)))
602 (defmacro return
(&optional result
)
603 "Return from the block named nil.
604 This is equivalent to `(return-from nil RESULT)'."
605 (list 'return-from nil result
))
608 (defmacro return-from
(name &optional result
)
609 "Return from the block named NAME.
610 This jumps out to the innermost enclosing `(block NAME ...)' form,
611 returning RESULT from that form (or nil if RESULT is omitted).
612 This is compatible with Common Lisp, but note that `defun' and
613 `defmacro' do not create implicit blocks as they do in Common Lisp."
614 (let ((name2 (intern (format "--cl-block-%s--" name
))))
615 (list 'cl-block-throw
(list 'quote name2
) result
)))
618 ;;; The "loop" macro.
620 (defvar loop-args
) (defvar loop-accum-var
) (defvar loop-accum-vars
)
621 (defvar loop-bindings
) (defvar loop-body
) (defvar loop-destr-temps
)
622 (defvar loop-finally
) (defvar loop-finish-flag
) (defvar loop-first-flag
)
623 (defvar loop-initially
) (defvar loop-map-form
) (defvar loop-name
)
624 (defvar loop-result
) (defvar loop-result-explicit
)
625 (defvar loop-result-var
) (defvar loop-steps
) (defvar loop-symbol-macs
)
628 (defmacro loop
(&rest loop-args
)
629 "The Common Lisp `loop' macro.
631 for VAR from/upfrom/downfrom NUM to/upto/downto/above/below NUM by NUM,
632 for VAR in LIST by FUNC, for VAR on LIST by FUNC, for VAR = INIT then EXPR,
633 for VAR across ARRAY, repeat NUM, with VAR = INIT, while COND, until COND,
634 always COND, never COND, thereis COND, collect EXPR into VAR,
635 append EXPR into VAR, nconc EXPR into VAR, sum EXPR into VAR,
636 count EXPR into VAR, maximize EXPR into VAR, minimize EXPR into VAR,
637 if COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...],
638 unless COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...],
639 do EXPRS..., initially EXPRS..., finally EXPRS..., return EXPR,
640 finally return EXPR, named NAME.
643 (if (not (memq t
(mapcar 'symbolp
(delq nil
(delq t
(copy-list loop-args
))))))
644 (list 'block nil
(list* 'while t loop-args
))
645 (let ((loop-name nil
) (loop-bindings nil
)
646 (loop-body nil
) (loop-steps nil
)
647 (loop-result nil
) (loop-result-explicit nil
)
648 (loop-result-var nil
) (loop-finish-flag nil
)
649 (loop-accum-var nil
) (loop-accum-vars nil
)
650 (loop-initially nil
) (loop-finally nil
)
651 (loop-map-form nil
) (loop-first-flag nil
)
652 (loop-destr-temps nil
) (loop-symbol-macs nil
))
653 (setq loop-args
(append loop-args
'(cl-end-loop)))
654 (while (not (eq (car loop-args
) 'cl-end-loop
)) (cl-parse-loop-clause))
656 (push `((,loop-finish-flag t
)) loop-bindings
))
658 (progn (push `((,loop-first-flag t
)) loop-bindings
)
659 (push `(setq ,loop-first-flag nil
) loop-steps
)))
660 (let* ((epilogue (nconc (nreverse loop-finally
)
661 (list (or loop-result-explicit loop-result
))))
662 (ands (cl-loop-build-ands (nreverse loop-body
)))
663 (while-body (nconc (cadr ands
) (nreverse loop-steps
)))
665 (nreverse loop-initially
)
666 (list (if loop-map-form
667 (list 'block
'--cl-finish--
669 (if (eq (car ands
) t
) while-body
670 (cons `(or ,(car ands
)
671 (return-from --cl-finish--
674 '--cl-map loop-map-form
))
675 (list* 'while
(car ands
) while-body
)))
677 (if (equal epilogue
'(nil)) (list loop-result-var
)
678 `((if ,loop-finish-flag
679 (progn ,@epilogue
) ,loop-result-var
)))
681 (if loop-result-var
(push (list loop-result-var
) loop-bindings
))
683 (if (cdar loop-bindings
)
684 (setq body
(list (cl-loop-let (pop loop-bindings
) body t
)))
686 (while (and loop-bindings
687 (not (cdar loop-bindings
)))
688 (push (car (pop loop-bindings
)) lets
))
689 (setq body
(list (cl-loop-let lets body nil
))))))
691 (setq body
(list (list* 'symbol-macrolet loop-symbol-macs body
))))
692 (list* 'block loop-name body
)))))
694 (defun cl-parse-loop-clause () ; uses loop-*
695 (let ((word (pop loop-args
))
696 (hash-types '(hash-key hash-keys hash-value hash-values
))
697 (key-types '(key-code key-codes key-seq key-seqs
698 key-binding key-bindings
)))
702 (error "Malformed `loop' macro"))
705 (setq loop-name
(pop loop-args
)))
707 ((eq word
'initially
)
708 (if (memq (car loop-args
) '(do doing
)) (pop loop-args
))
709 (or (consp (car loop-args
)) (error "Syntax error on `initially' clause"))
710 (while (consp (car loop-args
))
711 (push (pop loop-args
) loop-initially
)))
714 (if (eq (car loop-args
) 'return
)
715 (setq loop-result-explicit
(or (cl-pop2 loop-args
) '(quote nil
)))
716 (if (memq (car loop-args
) '(do doing
)) (pop loop-args
))
717 (or (consp (car loop-args
)) (error "Syntax error on `finally' clause"))
718 (if (and (eq (caar loop-args
) 'return
) (null loop-name
))
719 (setq loop-result-explicit
(or (nth 1 (pop loop-args
)) '(quote nil
)))
720 (while (consp (car loop-args
))
721 (push (pop loop-args
) loop-finally
)))))
723 ((memq word
'(for as
))
724 (let ((loop-for-bindings nil
) (loop-for-sets nil
) (loop-for-steps nil
)
727 ;; Use `gensym' rather than `make-symbol'. It's important that
728 ;; (not (eq (symbol-name var1) (symbol-name var2))) because
729 ;; these vars get added to the cl-macro-environment.
730 (let ((var (or (pop loop-args
) (gensym "--cl-var--"))))
731 (setq word
(pop loop-args
))
732 (if (eq word
'being
) (setq word
(pop loop-args
)))
733 (if (memq word
'(the each
)) (setq word
(pop loop-args
)))
734 (if (memq word
'(buffer buffers
))
735 (setq word
'in loop-args
(cons '(buffer-list) loop-args
)))
738 ((memq word
'(from downfrom upfrom to downto upto
740 (push word loop-args
)
741 (if (memq (car loop-args
) '(downto above
))
742 (error "Must specify `from' value for downward loop"))
743 (let* ((down (or (eq (car loop-args
) 'downfrom
)
744 (memq (caddr loop-args
) '(downto above
))))
745 (excl (or (memq (car loop-args
) '(above below
))
746 (memq (caddr loop-args
) '(above below
))))
747 (start (and (memq (car loop-args
) '(from upfrom downfrom
))
748 (cl-pop2 loop-args
)))
749 (end (and (memq (car loop-args
)
750 '(to upto downto above below
))
751 (cl-pop2 loop-args
)))
752 (step (and (eq (car loop-args
) 'by
) (cl-pop2 loop-args
)))
753 (end-var (and (not (cl-const-expr-p end
))
754 (make-symbol "--cl-var--")))
755 (step-var (and (not (cl-const-expr-p step
))
756 (make-symbol "--cl-var--"))))
757 (and step
(numberp step
) (<= step
0)
758 (error "Loop `by' value is not positive: %s" step
))
759 (push (list var
(or start
0)) loop-for-bindings
)
760 (if end-var
(push (list end-var end
) loop-for-bindings
))
761 (if step-var
(push (list step-var step
)
765 (if down
(if excl
'> '>=) (if excl
'< '<=))
766 var
(or end-var end
)) loop-body
))
767 (push (list var
(list (if down
'-
'+) var
768 (or step-var step
1)))
771 ((memq word
'(in in-ref on
))
772 (let* ((on (eq word
'on
))
773 (temp (if (and on
(symbolp var
))
774 var
(make-symbol "--cl-var--"))))
775 (push (list temp
(pop loop-args
)) loop-for-bindings
)
776 (push (list 'consp temp
) loop-body
)
777 (if (eq word
'in-ref
)
778 (push (list var
(list 'car temp
)) loop-symbol-macs
)
781 (push (list var nil
) loop-for-bindings
)
782 (push (list var
(if on temp
(list 'car temp
)))
785 (if (eq (car loop-args
) 'by
)
786 (let ((step (cl-pop2 loop-args
)))
787 (if (and (memq (car-safe step
)
790 (symbolp (nth 1 step
)))
791 (list (nth 1 step
) temp
)
792 (list 'funcall step temp
)))
797 (let* ((start (pop loop-args
))
798 (then (if (eq (car loop-args
) 'then
) (cl-pop2 loop-args
) start
)))
799 (push (list var nil
) loop-for-bindings
)
800 (if (or ands
(eq (car loop-args
) 'and
))
803 (if ,(or loop-first-flag
804 (setq loop-first-flag
805 (make-symbol "--cl-var--")))
808 (push (list var then
) loop-for-steps
))
810 (if (eq start then
) start
811 `(if ,(or loop-first-flag
812 (setq loop-first-flag
813 (make-symbol "--cl-var--")))
817 ((memq word
'(across across-ref
))
818 (let ((temp-vec (make-symbol "--cl-vec--"))
819 (temp-idx (make-symbol "--cl-idx--")))
820 (push (list temp-vec
(pop loop-args
)) loop-for-bindings
)
821 (push (list temp-idx -
1) loop-for-bindings
)
822 (push (list '< (list 'setq temp-idx
(list '1+ temp-idx
))
823 (list 'length temp-vec
)) loop-body
)
824 (if (eq word
'across-ref
)
825 (push (list var
(list 'aref temp-vec temp-idx
))
827 (push (list var nil
) loop-for-bindings
)
828 (push (list var
(list 'aref temp-vec temp-idx
))
831 ((memq word
'(element elements
))
832 (let ((ref (or (memq (car loop-args
) '(in-ref of-ref
))
833 (and (not (memq (car loop-args
) '(in of
)))
834 (error "Expected `of'"))))
835 (seq (cl-pop2 loop-args
))
836 (temp-seq (make-symbol "--cl-seq--"))
837 (temp-idx (if (eq (car loop-args
) 'using
)
838 (if (and (= (length (cadr loop-args
)) 2)
839 (eq (caadr loop-args
) 'index
))
840 (cadr (cl-pop2 loop-args
))
841 (error "Bad `using' clause"))
842 (make-symbol "--cl-idx--"))))
843 (push (list temp-seq seq
) loop-for-bindings
)
844 (push (list temp-idx
0) loop-for-bindings
)
846 (let ((temp-len (make-symbol "--cl-len--")))
847 (push (list temp-len
(list 'length temp-seq
))
849 (push (list var
(list 'elt temp-seq temp-idx
))
851 (push (list '< temp-idx temp-len
) loop-body
))
852 (push (list var nil
) loop-for-bindings
)
853 (push (list 'and temp-seq
854 (list 'or
(list 'consp temp-seq
)
856 (list 'length temp-seq
))))
858 (push (list var
(list 'if
(list 'consp temp-seq
)
860 (list 'aref temp-seq temp-idx
)))
862 (push (list temp-idx
(list '1+ temp-idx
))
865 ((memq word hash-types
)
866 (or (memq (car loop-args
) '(in of
)) (error "Expected `of'"))
867 (let* ((table (cl-pop2 loop-args
))
868 (other (if (eq (car loop-args
) 'using
)
869 (if (and (= (length (cadr loop-args
)) 2)
870 (memq (caadr loop-args
) hash-types
)
871 (not (eq (caadr loop-args
) word
)))
872 (cadr (cl-pop2 loop-args
))
873 (error "Bad `using' clause"))
874 (make-symbol "--cl-var--"))))
875 (if (memq word
'(hash-value hash-values
))
876 (setq var
(prog1 other
(setq other var
))))
878 `(maphash (lambda (,var
,other
) . --cl-map
) ,table
))))
880 ((memq word
'(symbol present-symbol external-symbol
881 symbols present-symbols external-symbols
))
882 (let ((ob (and (memq (car loop-args
) '(in of
)) (cl-pop2 loop-args
))))
884 `(mapatoms (lambda (,var
) . --cl-map
) ,ob
))))
886 ((memq word
'(overlay overlays extent extents
))
887 (let ((buf nil
) (from nil
) (to nil
))
888 (while (memq (car loop-args
) '(in of from to
))
889 (cond ((eq (car loop-args
) 'from
) (setq from
(cl-pop2 loop-args
)))
890 ((eq (car loop-args
) 'to
) (setq to
(cl-pop2 loop-args
)))
891 (t (setq buf
(cl-pop2 loop-args
)))))
894 (lambda (,var
,(make-symbol "--cl-var--"))
895 (progn . --cl-map
) nil
)
898 ((memq word
'(interval intervals
))
899 (let ((buf nil
) (prop nil
) (from nil
) (to nil
)
900 (var1 (make-symbol "--cl-var1--"))
901 (var2 (make-symbol "--cl-var2--")))
902 (while (memq (car loop-args
) '(in of property from to
))
903 (cond ((eq (car loop-args
) 'from
) (setq from
(cl-pop2 loop-args
)))
904 ((eq (car loop-args
) 'to
) (setq to
(cl-pop2 loop-args
)))
905 ((eq (car loop-args
) 'property
)
906 (setq prop
(cl-pop2 loop-args
)))
907 (t (setq buf
(cl-pop2 loop-args
)))))
908 (if (and (consp var
) (symbolp (car var
)) (symbolp (cdr var
)))
909 (setq var1
(car var
) var2
(cdr var
))
910 (push (list var
(list 'cons var1 var2
)) loop-for-sets
))
913 (lambda (,var1
,var2
) . --cl-map
)
914 ,buf
,prop
,from
,to
))))
916 ((memq word key-types
)
917 (or (memq (car loop-args
) '(in of
)) (error "Expected `of'"))
918 (let ((map (cl-pop2 loop-args
))
919 (other (if (eq (car loop-args
) 'using
)
920 (if (and (= (length (cadr loop-args
)) 2)
921 (memq (caadr loop-args
) key-types
)
922 (not (eq (caadr loop-args
) word
)))
923 (cadr (cl-pop2 loop-args
))
924 (error "Bad `using' clause"))
925 (make-symbol "--cl-var--"))))
926 (if (memq word
'(key-binding key-bindings
))
927 (setq var
(prog1 other
(setq other var
))))
929 `(,(if (memq word
'(key-seq key-seqs
))
930 'cl-map-keymap-recursively
'map-keymap
)
931 (lambda (,var
,other
) . --cl-map
) ,map
))))
933 ((memq word
'(frame frames screen screens
))
934 (let ((temp (make-symbol "--cl-var--")))
935 (push (list var
'(selected-frame))
937 (push (list temp nil
) loop-for-bindings
)
938 (push (list 'prog1
(list 'not
(list 'eq var temp
))
939 (list 'or temp
(list 'setq temp var
)))
941 (push (list var
(list 'next-frame var
))
944 ((memq word
'(window windows
))
945 (let ((scr (and (memq (car loop-args
) '(in of
)) (cl-pop2 loop-args
)))
946 (temp (make-symbol "--cl-var--"))
947 (minip (make-symbol "--cl-minip--")))
948 (push (list var
(if scr
949 (list 'frame-selected-window scr
)
952 ;; If we started in the minibuffer, we need to
953 ;; ensure that next-window will bring us back there
954 ;; at some point. (Bug#7492).
955 ;; (Consider using walk-windows instead of loop if
956 ;; you care about such things.)
957 (push (list minip
`(minibufferp (window-buffer ,var
)))
959 (push (list temp nil
) loop-for-bindings
)
960 (push (list 'prog1
(list 'not
(list 'eq var temp
))
961 (list 'or temp
(list 'setq temp var
)))
963 (push (list var
(list 'next-window var minip
))
967 (let ((handler (and (symbolp word
)
968 (get word
'cl-loop-for-handler
))))
970 (funcall handler var
)
971 (error "Expected a `for' preposition, found %s" word
)))))
972 (eq (car loop-args
) 'and
))
975 (if (and ands loop-for-bindings
)
976 (push (nreverse loop-for-bindings
) loop-bindings
)
977 (setq loop-bindings
(nconc (mapcar 'list loop-for-bindings
)
981 (cl-loop-let (nreverse loop-for-sets
) 'setq ands
)
984 (push (cons (if ands
'psetq
'setq
)
985 (apply 'append
(nreverse loop-for-steps
)))
989 (let ((temp (make-symbol "--cl-var--")))
990 (push (list (list temp
(pop loop-args
))) loop-bindings
)
991 (push (list '>= (list 'setq temp
(list '1- temp
)) 0) loop-body
)))
993 ((memq word
'(collect collecting
))
994 (let ((what (pop loop-args
))
995 (var (cl-loop-handle-accum nil
'nreverse
)))
996 (if (eq var loop-accum-var
)
997 (push (list 'progn
(list 'push what var
) t
) loop-body
)
999 (list 'setq var
(list 'nconc var
(list 'list what
)))
1002 ((memq word
'(nconc nconcing append appending
))
1003 (let ((what (pop loop-args
))
1004 (var (cl-loop-handle-accum nil
'nreverse
)))
1007 (if (eq var loop-accum-var
)
1009 (list (if (memq word
'(nconc nconcing
))
1013 (list (if (memq word
'(nconc nconcing
))
1015 var what
))) t
) loop-body
)))
1017 ((memq word
'(concat concating
))
1018 (let ((what (pop loop-args
))
1019 (var (cl-loop-handle-accum "")))
1020 (push (list 'progn
(list 'callf
'concat var what
) t
) loop-body
)))
1022 ((memq word
'(vconcat vconcating
))
1023 (let ((what (pop loop-args
))
1024 (var (cl-loop-handle-accum [])))
1025 (push (list 'progn
(list 'callf
'vconcat var what
) t
) loop-body
)))
1027 ((memq word
'(sum summing
))
1028 (let ((what (pop loop-args
))
1029 (var (cl-loop-handle-accum 0)))
1030 (push (list 'progn
(list 'incf var what
) t
) loop-body
)))
1032 ((memq word
'(count counting
))
1033 (let ((what (pop loop-args
))
1034 (var (cl-loop-handle-accum 0)))
1035 (push (list 'progn
(list 'if what
(list 'incf var
)) t
) loop-body
)))
1037 ((memq word
'(minimize minimizing maximize maximizing
))
1038 (let* ((what (pop loop-args
))
1039 (temp (if (cl-simple-expr-p what
) what
(make-symbol "--cl-var--")))
1040 (var (cl-loop-handle-accum nil
))
1041 (func (intern (substring (symbol-name word
) 0 3)))
1042 (set (list 'setq var
(list 'if var
(list func var temp
) temp
))))
1043 (push (list 'progn
(if (eq temp what
) set
1044 (list 'let
(list (list temp what
)) set
))
1048 (let ((bindings nil
))
1049 (while (progn (push (list (pop loop-args
)
1050 (and (eq (car loop-args
) '=) (cl-pop2 loop-args
)))
1052 (eq (car loop-args
) 'and
))
1054 (push (nreverse bindings
) loop-bindings
)))
1057 (push (pop loop-args
) loop-body
))
1060 (push (list 'not
(pop loop-args
)) loop-body
))
1063 (or loop-finish-flag
(setq loop-finish-flag
(make-symbol "--cl-flag--")))
1064 (push (list 'setq loop-finish-flag
(pop loop-args
)) loop-body
)
1065 (setq loop-result t
))
1068 (or loop-finish-flag
(setq loop-finish-flag
(make-symbol "--cl-flag--")))
1069 (push (list 'setq loop-finish-flag
(list 'not
(pop loop-args
)))
1071 (setq loop-result t
))
1074 (or loop-finish-flag
(setq loop-finish-flag
(make-symbol "--cl-flag--")))
1075 (or loop-result-var
(setq loop-result-var
(make-symbol "--cl-var--")))
1076 (push (list 'setq loop-finish-flag
1077 (list 'not
(list 'setq loop-result-var
(pop loop-args
))))
1080 ((memq word
'(if when unless
))
1081 (let* ((cond (pop loop-args
))
1082 (then (let ((loop-body nil
))
1083 (cl-parse-loop-clause)
1084 (cl-loop-build-ands (nreverse loop-body
))))
1085 (else (let ((loop-body nil
))
1086 (if (eq (car loop-args
) 'else
)
1087 (progn (pop loop-args
) (cl-parse-loop-clause)))
1088 (cl-loop-build-ands (nreverse loop-body
))))
1089 (simple (and (eq (car then
) t
) (eq (car else
) t
))))
1090 (if (eq (car loop-args
) 'end
) (pop loop-args
))
1091 (if (eq word
'unless
) (setq then
(prog1 else
(setq else then
))))
1092 (let ((form (cons (if simple
(cons 'progn
(nth 1 then
)) (nth 2 then
))
1093 (if simple
(nth 1 else
) (list (nth 2 else
))))))
1094 (if (cl-expr-contains form
'it
)
1095 (let ((temp (make-symbol "--cl-var--")))
1096 (push (list temp
) loop-bindings
)
1097 (setq form
(list* 'if
(list 'setq temp cond
)
1098 (subst temp
'it form
))))
1099 (setq form
(list* 'if cond form
)))
1100 (push (if simple
(list 'progn form t
) form
) loop-body
))))
1102 ((memq word
'(do doing
))
1104 (or (consp (car loop-args
)) (error "Syntax error on `do' clause"))
1105 (while (consp (car loop-args
)) (push (pop loop-args
) body
))
1106 (push (cons 'progn
(nreverse (cons t body
))) loop-body
)))
1109 (or loop-finish-flag
(setq loop-finish-flag
(make-symbol "--cl-var--")))
1110 (or loop-result-var
(setq loop-result-var
(make-symbol "--cl-var--")))
1111 (push (list 'setq loop-result-var
(pop loop-args
)
1112 loop-finish-flag nil
) loop-body
))
1115 (let ((handler (and (symbolp word
) (get word
'cl-loop-handler
))))
1116 (or handler
(error "Expected a loop keyword, found %s" word
))
1117 (funcall handler
))))
1118 (if (eq (car loop-args
) 'and
)
1119 (progn (pop loop-args
) (cl-parse-loop-clause)))))
1121 (defun cl-loop-let (specs body par
) ; uses loop-*
1122 (let ((p specs
) (temps nil
) (new nil
))
1123 (while (and p
(or (symbolp (car-safe (car p
))) (null (cadar p
))))
1127 (setq par nil p specs
)
1129 (or (cl-const-expr-p (cadar p
))
1130 (let ((temp (make-symbol "--cl-var--")))
1131 (push (list temp
(cadar p
)) temps
)
1132 (setcar (cdar p
) temp
)))
1135 (if (and (consp (car specs
)) (listp (caar specs
)))
1136 (let* ((spec (caar specs
)) (nspecs nil
)
1137 (expr (cadr (pop specs
)))
1138 (temp (cdr (or (assq spec loop-destr-temps
)
1139 (car (push (cons spec
(or (last spec
0)
1140 (make-symbol "--cl-var--")))
1141 loop-destr-temps
))))))
1142 (push (list temp expr
) new
)
1144 (push (list (pop spec
)
1145 (and expr
(list (if spec
'pop
'car
) temp
)))
1147 (setq specs
(nconc (nreverse nspecs
) specs
)))
1148 (push (pop specs
) new
)))
1150 (let ((set (cons (if par
'psetq
'setq
) (apply 'nconc
(nreverse new
)))))
1151 (if temps
(list 'let
* (nreverse temps
) set
) set
))
1152 (list* (if par
'let
'let
*)
1153 (nconc (nreverse temps
) (nreverse new
)) body
))))
1155 (defun cl-loop-handle-accum (def &optional func
) ; uses loop-*
1156 (if (eq (car loop-args
) 'into
)
1157 (let ((var (cl-pop2 loop-args
)))
1158 (or (memq var loop-accum-vars
)
1159 (progn (push (list (list var def
)) loop-bindings
)
1160 (push var loop-accum-vars
)))
1164 (push (list (list (setq loop-accum-var
(make-symbol "--cl-var--")) def
))
1166 (setq loop-result
(if func
(list func loop-accum-var
)
1170 (defun cl-loop-build-ands (clauses)
1174 (if (and (eq (car-safe (car clauses
)) 'progn
)
1175 (eq (car (last (car clauses
))) t
))
1177 (setq clauses
(cons (nconc (butlast (car clauses
))
1178 (if (eq (car-safe (cadr clauses
))
1181 (list (cadr clauses
))))
1183 (setq body
(cdr (butlast (pop clauses
)))))
1184 (push (pop clauses
) ands
)))
1185 (setq ands
(or (nreverse ands
) (list t
)))
1186 (list (if (cdr ands
) (cons 'and ands
) (car ands
))
1188 (let ((full (if body
1189 (append ands
(list (cons 'progn
(append body
'(t)))))
1191 (if (cdr full
) (cons 'and full
) (car full
))))))
1194 ;;; Other iteration control structures.
1197 (defmacro do
(steps endtest
&rest body
)
1198 "The Common Lisp `do' loop.
1200 \(fn ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)"
1201 (cl-expand-do-loop steps endtest body nil
))
1204 (defmacro do
* (steps endtest
&rest body
)
1205 "The Common Lisp `do*' loop.
1207 \(fn ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)"
1208 (cl-expand-do-loop steps endtest body t
))
1210 (defun cl-expand-do-loop (steps endtest body star
)
1212 (list* (if star
'let
* 'let
)
1213 (mapcar (function (lambda (c)
1214 (if (consp c
) (list (car c
) (nth 1 c
)) c
)))
1216 (list* 'while
(list 'not
(car endtest
))
1221 (and (consp c
) (cdr (cdr c
))
1222 (list (car c
) (nth 2 c
)))))
1224 (setq sets
(delq nil sets
))
1226 (list (cons (if (or star
(not (cdr sets
)))
1228 (apply 'append sets
)))))))
1229 (or (cdr endtest
) '(nil)))))
1232 (defmacro dolist
(spec &rest body
)
1234 Evaluate BODY with VAR bound to each `car' from LIST, in turn.
1235 Then evaluate RESULT to get return value, default nil.
1237 \(fn (VAR LIST [RESULT]) BODY...)"
1238 (let ((temp (make-symbol "--cl-dolist-temp--")))
1239 ;; FIXME: Copy&pasted from subr.el.
1241 ;; This is not a reliable test, but it does not matter because both
1242 ;; semantics are acceptable, tho one is slightly faster with dynamic
1243 ;; scoping and the other is slightly faster (and has cleaner semantics)
1244 ;; with lexical scoping.
1245 ,(if lexical-binding
1246 `(let ((,temp
,(nth 1 spec
)))
1248 (let ((,(car spec
) (car ,temp
)))
1250 (setq ,temp
(cdr ,temp
))))
1251 ,@(if (cdr (cdr spec
))
1252 ;; FIXME: This let often leads to "unused var" warnings.
1253 `((let ((,(car spec
) nil
)) ,@(cdr (cdr spec
))))))
1254 `(let ((,temp
,(nth 1 spec
))
1257 (setq ,(car spec
) (car ,temp
))
1259 (setq ,temp
(cdr ,temp
)))
1260 ,@(if (cdr (cdr spec
))
1261 `((setq ,(car spec
) nil
) ,@(cddr spec
))))))))
1264 (defmacro dotimes
(spec &rest body
)
1265 "Loop a certain number of times.
1266 Evaluate BODY with VAR bound to successive integers from 0, inclusive,
1267 to COUNT, exclusive. Then evaluate RESULT to get return value, default
1270 \(fn (VAR COUNT [RESULT]) BODY...)"
1271 (let ((temp (make-symbol "--cl-dotimes-temp--"))
1273 ;; FIXME: Copy&pasted from subr.el.
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 has cleaner semantics.
1278 ,(if lexical-binding
1279 (let ((counter '--dotimes-counter--
))
1282 (while (< ,counter
,temp
)
1283 (let ((,(car spec
) ,counter
))
1285 (setq ,counter
(1+ ,counter
)))
1287 ;; FIXME: This let often leads to "unused var" warnings.
1288 `((let ((,(car spec
) ,counter
)) ,@(cddr spec
))))))
1291 (while (< ,(car spec
) ,temp
)
1294 ,@(cdr (cdr spec
)))))))
1297 (defmacro do-symbols
(spec &rest body
)
1298 "Loop over all symbols.
1299 Evaluate BODY with VAR bound to each interned symbol, or to each symbol
1302 \(fn (VAR [OBARRAY [RESULT]]) BODY...)"
1303 ;; Apparently this doesn't have an implicit block.
1305 (list 'let
(list (car spec
))
1307 (list 'function
(list* 'lambda
(list (car spec
)) body
))
1308 (and (cadr spec
) (list (cadr spec
))))
1312 (defmacro do-all-symbols
(spec &rest body
)
1313 (list* 'do-symbols
(list (car spec
) nil
(cadr spec
)) body
))
1319 (defmacro psetq
(&rest args
)
1320 "Set SYMs to the values VALs in parallel.
1321 This is like `setq', except that all VAL forms are evaluated (in order)
1322 before assigning any symbols SYM to the corresponding values.
1324 \(fn SYM VAL SYM VAL ...)"
1328 ;;; Binding control structures.
1331 (defmacro progv
(symbols values
&rest body
)
1332 "Bind SYMBOLS to VALUES dynamically in BODY.
1333 The forms SYMBOLS and VALUES are evaluated, and must evaluate to lists.
1334 Each symbol in the first list is bound to the corresponding value in the
1335 second list (or made unbound if VALUES is shorter than SYMBOLS); then the
1336 BODY forms are executed and their result is returned. This is much like
1337 a `let' form, except that the list of symbols can be computed at run-time."
1338 (list 'let
'((cl-progv-save nil
))
1339 (list 'unwind-protect
1340 (list* 'progn
(list 'cl-progv-before symbols values
) body
)
1341 '(cl-progv-after))))
1343 ;;; This should really have some way to shadow 'byte-compile properties, etc.
1345 (defmacro flet
(bindings &rest body
)
1346 "Make temporary function definitions.
1347 This is an analogue of `let' that operates on the function cell of FUNC
1348 rather than its value cell. The FORMs are evaluated with the specified
1349 function definitions in place, then the definitions are undone (the FUNCs
1350 go back to their previous definitions, or lack thereof).
1352 \(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
1357 (if (or (and (fboundp (car x
))
1358 (eq (car-safe (symbol-function (car x
))) 'macro
))
1359 (cdr (assq (car x
) cl-macro-environment
)))
1360 (error "Use `labels', not `flet', to rebind macro names"))
1361 (let ((func (list 'function
*
1362 (list 'lambda
(cadr x
)
1363 (list* 'block
(car x
) (cddr x
))))))
1364 (when (cl-compiling-file)
1365 ;; Bug#411. It would be nice to fix this.
1366 (and (get (car x
) 'byte-compile
)
1367 (error "Byte-compiling a redefinition of `%s' \
1368 will not work - use `labels' instead" (symbol-name (car x
))))
1369 ;; FIXME This affects the rest of the file, when it
1370 ;; should be restricted to the flet body.
1371 (and (boundp 'byte-compile-function-environment
)
1372 (push (cons (car x
) (eval func
))
1373 byte-compile-function-environment
)))
1374 (list (list 'symbol-function
(list 'quote
(car x
))) func
))))
1379 (defmacro labels
(bindings &rest body
)
1380 "Make temporary function bindings.
1381 This is like `flet', except the bindings are lexical instead of dynamic.
1382 Unlike `flet', this macro is fully compliant with the Common Lisp standard.
1384 \(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
1385 (let ((vars nil
) (sets nil
) (cl-macro-environment cl-macro-environment
))
1387 ;; Use `gensym' rather than `make-symbol'. It's important that
1388 ;; (not (eq (symbol-name var1) (symbol-name var2))) because these
1389 ;; vars get added to the cl-macro-environment.
1390 (let ((var (gensym "--cl-var--")))
1392 (push (list 'function
* (cons 'lambda
(cdar bindings
))) sets
)
1394 (push (list (car (pop bindings
)) 'lambda
'(&rest cl-labels-args
)
1395 (list 'list
* '(quote funcall
) (list 'quote var
)
1397 cl-macro-environment
)))
1398 (cl-macroexpand-all (list* 'lexical-let vars
(cons (cons 'setq sets
) body
))
1399 cl-macro-environment
)))
1401 ;; The following ought to have a better definition for use with newer
1404 (defmacro macrolet
(bindings &rest body
)
1405 "Make temporary macro definitions.
1406 This is like `flet', but for macros instead of functions.
1408 \(fn ((NAME ARGLIST BODY...) ...) FORM...)"
1411 (list (car bindings
)) (list* 'macrolet
(cdr bindings
) body
))
1412 (if (null bindings
) (cons 'progn body
)
1413 (let* ((name (caar bindings
))
1414 (res (cl-transform-lambda (cdar bindings
) name
)))
1416 (cl-macroexpand-all (cons 'progn body
)
1417 (cons (list* name
'lambda
(cdr res
))
1418 cl-macro-environment
))))))
1421 (defmacro symbol-macrolet
(bindings &rest body
)
1422 "Make symbol macro definitions.
1423 Within the body FORMs, references to the variable NAME will be replaced
1424 by EXPANSION, and (setq NAME ...) will act like (setf EXPANSION ...).
1426 \(fn ((NAME EXPANSION) ...) FORM...)"
1428 (list 'symbol-macrolet
1429 (list (car bindings
)) (list* 'symbol-macrolet
(cdr bindings
) body
))
1430 (if (null bindings
) (cons 'progn body
)
1431 (cl-macroexpand-all (cons 'progn body
)
1432 (cons (list (symbol-name (caar bindings
))
1434 cl-macro-environment
)))))
1436 (defvar cl-closure-vars nil
)
1438 (defmacro lexical-let
(bindings &rest body
)
1439 "Like `let', but lexically scoped.
1440 The main visible difference is that lambdas inside BODY will create
1441 lexical closures as in Common Lisp.
1442 \n(fn BINDINGS BODY)"
1443 (let* ((cl-closure-vars cl-closure-vars
)
1444 (vars (mapcar (function
1446 (or (consp x
) (setq x
(list x
)))
1447 (push (make-symbol (format "--cl-%s--" (car x
)))
1449 (set (car cl-closure-vars
) [bad-lexical-ref
])
1450 (list (car x
) (cadr x
) (car cl-closure-vars
))))
1455 (nconc (mapcar (function (lambda (x)
1456 (list (symbol-name (car x
))
1457 (list 'symbol-value
(caddr x
))
1459 (list '(defun . cl-defun-expander
))
1460 cl-macro-environment
))))
1461 (if (not (get (car (last cl-closure-vars
)) 'used
))
1462 (list 'let
(mapcar (function (lambda (x)
1463 (list (caddr x
) (cadr x
)))) vars
)
1464 (sublis (mapcar (function (lambda (x)
1466 (list 'quote
(caddr x
)))))
1469 (list 'let
(mapcar (function (lambda (x)
1472 (format "--%s--" (car x
))))))
1474 (apply 'append
'(setf)
1477 (list (list 'symbol-value
(caddr x
)) (cadr x
))))
1482 (defmacro lexical-let
* (bindings &rest body
)
1483 "Like `let*', but lexically scoped.
1484 The main visible difference is that lambdas inside BODY, and in
1485 successive bindings within BINDINGS, will create lexical closures
1486 as in Common Lisp. This is similar to the behavior of `let*' in
1488 \n(fn BINDINGS BODY)"
1489 (if (null bindings
) (cons 'progn body
)
1490 (setq bindings
(reverse bindings
))
1492 (setq body
(list (list* 'lexical-let
(list (pop bindings
)) body
))))
1495 (defun cl-defun-expander (func &rest rest
)
1497 (list 'defalias
(list 'quote func
)
1498 (list 'function
(cons 'lambda rest
)))
1499 (list 'quote func
)))
1502 ;;; Multiple values.
1505 (defmacro multiple-value-bind
(vars form
&rest body
)
1506 "Collect multiple return values.
1507 FORM must return a list; the BODY is then executed with the first N elements
1508 of this list bound (`let'-style) to each of the symbols SYM in turn. This
1509 is analogous to the Common Lisp `multiple-value-bind' macro, using lists to
1510 simulate true multiple return values. For compatibility, (values A B C) is
1511 a synonym for (list A B C).
1513 \(fn (SYM...) FORM BODY)"
1514 (let ((temp (make-symbol "--cl-var--")) (n -
1))
1515 (list* 'let
* (cons (list temp form
)
1518 (list v
(list 'nth
(setq n
(1+ n
)) temp
))))
1523 (defmacro multiple-value-setq
(vars form
)
1524 "Collect multiple return values.
1525 FORM must return a list; the first N elements of this list are stored in
1526 each of the symbols SYM in turn. This is analogous to the Common Lisp
1527 `multiple-value-setq' macro, using lists to simulate true multiple return
1528 values. For compatibility, (values A B C) is a synonym for (list A B C).
1530 \(fn (SYM...) FORM)"
1531 (cond ((null vars
) (list 'progn form nil
))
1532 ((null (cdr vars
)) (list 'setq
(car vars
) (list 'car form
)))
1534 (let* ((temp (make-symbol "--cl-var--")) (n 0))
1535 (list 'let
(list (list temp form
))
1536 (list 'prog1
(list 'setq
(pop vars
) (list 'car temp
))
1537 (cons 'setq
(apply 'nconc
1550 (defmacro locally
(&rest body
) (cons 'progn body
))
1552 (defmacro the
(type form
) form
)
1554 (defvar cl-proclaim-history t
) ; for future compilers
1555 (defvar cl-declare-stack t
) ; for future compilers
1557 (defun cl-do-proclaim (spec hist
)
1558 (and hist
(listp cl-proclaim-history
) (push spec cl-proclaim-history
))
1559 (cond ((eq (car-safe spec
) 'special
)
1560 (if (boundp 'byte-compile-bound-variables
)
1561 (setq byte-compile-bound-variables
1562 (append (cdr spec
) byte-compile-bound-variables
))))
1564 ((eq (car-safe spec
) 'inline
)
1565 (while (setq spec
(cdr spec
))
1566 (or (memq (get (car spec
) 'byte-optimizer
)
1567 '(nil byte-compile-inline-expand
))
1568 (error "%s already has a byte-optimizer, can't make it inline"
1570 (put (car spec
) 'byte-optimizer
'byte-compile-inline-expand
)))
1572 ((eq (car-safe spec
) 'notinline
)
1573 (while (setq spec
(cdr spec
))
1574 (if (eq (get (car spec
) 'byte-optimizer
)
1575 'byte-compile-inline-expand
)
1576 (put (car spec
) 'byte-optimizer nil
))))
1578 ((eq (car-safe spec
) 'optimize
)
1579 (let ((speed (assq (nth 1 (assq 'speed
(cdr spec
)))
1580 '((0 nil
) (1 t
) (2 t
) (3 t
))))
1581 (safety (assq (nth 1 (assq 'safety
(cdr spec
)))
1582 '((0 t
) (1 t
) (2 t
) (3 nil
)))))
1583 (if speed
(setq cl-optimize-speed
(car speed
)
1584 byte-optimize
(nth 1 speed
)))
1585 (if safety
(setq cl-optimize-safety
(car safety
)
1586 byte-compile-delete-errors
(nth 1 safety
)))))
1588 ((and (eq (car-safe spec
) 'warn
) (boundp 'byte-compile-warnings
))
1589 (while (setq spec
(cdr spec
))
1590 (if (consp (car spec
))
1591 (if (eq (cadar spec
) 0)
1592 (byte-compile-disable-warning (caar spec
))
1593 (byte-compile-enable-warning (caar spec
)))))))
1596 ;;; Process any proclamations made before cl-macs was loaded.
1597 (defvar cl-proclaims-deferred
)
1598 (let ((p (reverse cl-proclaims-deferred
)))
1599 (while p
(cl-do-proclaim (pop p
) t
))
1600 (setq cl-proclaims-deferred nil
))
1603 (defmacro declare
(&rest specs
)
1604 (if (cl-compiling-file)
1606 (if (listp cl-declare-stack
) (push (car specs
) cl-declare-stack
))
1607 (cl-do-proclaim (pop specs
) nil
)))
1612 ;;; Generalized variables.
1615 (defmacro define-setf-method
(func args
&rest body
)
1616 "Define a `setf' method.
1617 This method shows how to handle `setf's to places of the form (NAME ARGS...).
1618 The argument forms ARGS are bound according to ARGLIST, as if NAME were
1619 going to be expanded as a macro, then the BODY forms are executed and must
1620 return a list of five elements: a temporary-variables list, a value-forms
1621 list, a store-variables list (of length one), a store-form, and an access-
1622 form. See `defsetf' for a simpler way to define most setf-methods.
1624 \(fn NAME ARGLIST BODY...)"
1625 (append '(eval-when (compile load eval
))
1626 (if (stringp (car body
))
1627 (list (list 'put
(list 'quote func
) '(quote setf-documentation
)
1629 (list (cl-transform-function-property
1630 func
'setf-method
(cons args body
)))))
1631 (defalias 'define-setf-expander
'define-setf-method
)
1634 (defmacro defsetf
(func arg1
&rest args
)
1635 "Define a `setf' method.
1636 This macro is an easy-to-use substitute for `define-setf-method' that works
1637 well for simple place forms. In the simple `defsetf' form, `setf's of
1638 the form (setf (NAME ARGS...) VAL) are transformed to function or macro
1639 calls of the form (FUNC ARGS... VAL). Example:
1643 Alternate form: (defsetf NAME ARGLIST (STORE) BODY...).
1644 Here, the above `setf' call is expanded by binding the argument forms ARGS
1645 according to ARGLIST, binding the value form VAL to STORE, then executing
1646 BODY, which must return a Lisp form that does the necessary `setf' operation.
1647 Actually, ARGLIST and STORE may be bound to temporary variables which are
1648 introduced automatically to preserve proper execution order of the arguments.
1651 (defsetf nth (n x) (v) (list 'setcar (list 'nthcdr n x) v))
1653 \(fn NAME [FUNC | ARGLIST (STORE) BODY...])"
1654 (if (and (listp arg1
) (consp args
))
1655 (let* ((largs nil
) (largsr nil
)
1656 (temps nil
) (tempsr nil
)
1657 (restarg nil
) (rest-temps nil
)
1658 (store-var (car (prog1 (car args
) (setq args
(cdr args
)))))
1659 (store-temp (intern (format "--%s--temp--" store-var
)))
1660 (lets1 nil
) (lets2 nil
)
1661 (docstr nil
) (p arg1
))
1662 (if (stringp (car args
))
1663 (setq docstr
(prog1 (car args
) (setq args
(cdr args
)))))
1664 (while (and p
(not (eq (car p
) '&aux
)))
1665 (if (eq (car p
) '&rest
)
1666 (setq p
(cdr p
) restarg
(car p
))
1667 (or (memq (car p
) '(&optional
&key
&allow-other-keys
))
1668 (setq largs
(cons (if (consp (car p
)) (car (car p
)) (car p
))
1670 temps
(cons (intern (format "--%s--temp--" (car largs
)))
1673 (setq largs
(nreverse largs
) temps
(nreverse temps
))
1675 (setq largsr
(append largs
(list restarg
))
1676 rest-temps
(intern (format "--%s--temp--" restarg
))
1677 tempsr
(append temps
(list rest-temps
)))
1678 (setq largsr largs tempsr temps
))
1679 (let ((p1 largs
) (p2 temps
))
1681 (setq lets1
(cons `(,(car p2
)
1682 (make-symbol ,(format "--cl-%s--" (car p1
))))
1684 lets2
(cons (list (car p1
) (car p2
)) lets2
)
1685 p1
(cdr p1
) p2
(cdr p2
))))
1686 (if restarg
(setq lets2
(cons (list restarg rest-temps
) lets2
)))
1687 `(define-setf-method ,func
,arg1
1688 ,@(and docstr
(list docstr
))
1692 (make-symbol ,(format "--cl-%s--" store-var
)))
1695 (mapcar (lambda (_) (make-symbol "--cl-var--"))
1700 (,(if restarg
'list
* 'list
) ,@tempsr
)
1701 (,(if restarg
'list
* 'list
) ,@largsr
)
1705 (cons (list store-var store-temp
)
1708 (,(if restarg
'list
* 'list
)
1709 ,@(cons (list 'quote func
) tempsr
))))))
1710 `(defsetf ,func
(&rest args
) (store)
1711 ,(let ((call `(cons ',arg1
1712 (append args
(list store
)))))
1714 `(list 'progn
,call store
)
1717 ;;; Some standard place types from Common Lisp.
1719 (defsetf car setcar
)
1720 (defsetf cdr setcdr
)
1721 (defsetf caar
(x) (val) (list 'setcar
(list 'car x
) val
))
1722 (defsetf cadr
(x) (val) (list 'setcar
(list 'cdr x
) val
))
1723 (defsetf cdar
(x) (val) (list 'setcdr
(list 'car x
) val
))
1724 (defsetf cddr
(x) (val) (list 'setcdr
(list 'cdr x
) val
))
1725 (defsetf elt
(seq n
) (store)
1726 (list 'if
(list 'listp seq
) (list 'setcar
(list 'nthcdr n seq
) store
)
1727 (list 'aset seq n store
)))
1729 (defsetf get
* (x y
&optional d
) (store) (list 'put x y store
))
1730 (defsetf gethash
(x h
&optional d
) (store) (list 'puthash x store h
))
1731 (defsetf nth
(n x
) (store) (list 'setcar
(list 'nthcdr n x
) store
))
1732 (defsetf subseq
(seq start
&optional end
) (new)
1733 (list 'progn
(list 'replace seq new
:start1 start
:end1 end
) new
))
1734 (defsetf symbol-function fset
)
1735 (defsetf symbol-plist setplist
)
1736 (defsetf symbol-value set
)
1738 ;;; Various car/cdr aliases. Note that `cadr' is handled specially.
1739 (defsetf first setcar
)
1740 (defsetf second
(x) (store) (list 'setcar
(list 'cdr x
) store
))
1741 (defsetf third
(x) (store) (list 'setcar
(list 'cddr x
) store
))
1742 (defsetf fourth
(x) (store) (list 'setcar
(list 'cdddr x
) store
))
1743 (defsetf fifth
(x) (store) (list 'setcar
(list 'nthcdr
4 x
) store
))
1744 (defsetf sixth
(x) (store) (list 'setcar
(list 'nthcdr
5 x
) store
))
1745 (defsetf seventh
(x) (store) (list 'setcar
(list 'nthcdr
6 x
) store
))
1746 (defsetf eighth
(x) (store) (list 'setcar
(list 'nthcdr
7 x
) store
))
1747 (defsetf ninth
(x) (store) (list 'setcar
(list 'nthcdr
8 x
) store
))
1748 (defsetf tenth
(x) (store) (list 'setcar
(list 'nthcdr
9 x
) store
))
1749 (defsetf rest setcdr
)
1751 ;;; Some more Emacs-related place types.
1752 (defsetf buffer-file-name set-visited-file-name t
)
1753 (defsetf buffer-modified-p
(&optional buf
) (flag)
1754 (list 'with-current-buffer buf
1755 (list 'set-buffer-modified-p flag
)))
1756 (defsetf buffer-name rename-buffer t
)
1757 (defsetf buffer-string
() (store)
1758 (list 'progn
'(erase-buffer) (list 'insert store
)))
1759 (defsetf buffer-substring cl-set-buffer-substring
)
1760 (defsetf current-buffer set-buffer
)
1761 (defsetf current-case-table set-case-table
)
1762 (defsetf current-column move-to-column t
)
1763 (defsetf current-global-map use-global-map t
)
1764 (defsetf current-input-mode
() (store)
1765 (list 'progn
(list 'apply
'set-input-mode store
) store
))
1766 (defsetf current-local-map use-local-map t
)
1767 (defsetf current-window-configuration set-window-configuration t
)
1768 (defsetf default-file-modes set-default-file-modes t
)
1769 (defsetf default-value set-default
)
1770 (defsetf documentation-property put
)
1771 (defsetf face-background
(f &optional s
) (x) (list 'set-face-background f x s
))
1772 (defsetf face-background-pixmap
(f &optional s
) (x)
1773 (list 'set-face-background-pixmap f x s
))
1774 (defsetf face-font
(f &optional s
) (x) (list 'set-face-font f x s
))
1775 (defsetf face-foreground
(f &optional s
) (x) (list 'set-face-foreground f x s
))
1776 (defsetf face-underline-p
(f &optional s
) (x)
1777 (list 'set-face-underline-p f x s
))
1778 (defsetf file-modes set-file-modes t
)
1779 (defsetf frame-height set-screen-height t
)
1780 (defsetf frame-parameters modify-frame-parameters t
)
1781 (defsetf frame-visible-p cl-set-frame-visible-p
)
1782 (defsetf frame-width set-screen-width t
)
1783 (defsetf frame-parameter set-frame-parameter t
)
1784 (defsetf terminal-parameter set-terminal-parameter
)
1785 (defsetf getenv setenv t
)
1786 (defsetf get-register set-register
)
1787 (defsetf global-key-binding global-set-key
)
1788 (defsetf keymap-parent set-keymap-parent
)
1789 (defsetf local-key-binding local-set-key
)
1790 (defsetf mark set-mark t
)
1791 (defsetf mark-marker set-mark t
)
1792 (defsetf marker-position set-marker t
)
1793 (defsetf match-data set-match-data t
)
1794 (defsetf mouse-position
(scr) (store)
1795 (list 'set-mouse-position scr
(list 'car store
) (list 'cadr store
)
1796 (list 'cddr store
)))
1797 (defsetf overlay-get overlay-put
)
1798 (defsetf overlay-start
(ov) (store)
1799 (list 'progn
(list 'move-overlay ov store
(list 'overlay-end ov
)) store
))
1800 (defsetf overlay-end
(ov) (store)
1801 (list 'progn
(list 'move-overlay ov
(list 'overlay-start ov
) store
) store
))
1802 (defsetf point goto-char
)
1803 (defsetf point-marker goto-char t
)
1804 (defsetf point-max
() (store)
1805 (list 'progn
(list 'narrow-to-region
'(point-min) store
) store
))
1806 (defsetf point-min
() (store)
1807 (list 'progn
(list 'narrow-to-region store
'(point-max)) store
))
1808 (defsetf process-buffer set-process-buffer
)
1809 (defsetf process-filter set-process-filter
)
1810 (defsetf process-sentinel set-process-sentinel
)
1811 (defsetf process-get process-put
)
1812 (defsetf read-mouse-position
(scr) (store)
1813 (list 'set-mouse-position scr
(list 'car store
) (list 'cdr store
)))
1814 (defsetf screen-height set-screen-height t
)
1815 (defsetf screen-width set-screen-width t
)
1816 (defsetf selected-window select-window
)
1817 (defsetf selected-screen select-screen
)
1818 (defsetf selected-frame select-frame
)
1819 (defsetf standard-case-table set-standard-case-table
)
1820 (defsetf syntax-table set-syntax-table
)
1821 (defsetf visited-file-modtime set-visited-file-modtime t
)
1822 (defsetf window-buffer set-window-buffer t
)
1823 (defsetf window-display-table set-window-display-table t
)
1824 (defsetf window-dedicated-p set-window-dedicated-p t
)
1825 (defsetf window-height
() (store)
1826 (list 'progn
(list 'enlarge-window
(list '- store
'(window-height))) store
))
1827 (defsetf window-hscroll set-window-hscroll
)
1828 (defsetf window-parameter set-window-parameter
)
1829 (defsetf window-point set-window-point
)
1830 (defsetf window-start set-window-start
)
1831 (defsetf window-width
() (store)
1832 (list 'progn
(list 'enlarge-window
(list '- store
'(window-width)) t
) store
))
1833 (defsetf x-get-secondary-selection x-own-secondary-selection t
)
1834 (defsetf x-get-selection x-own-selection t
)
1836 ;; This is a hack that allows (setf (eq a 7) B) to mean either
1837 ;; (setq a 7) or (setq a nil) depending on whether B is nil or not.
1838 ;; This is useful when you have control over the PLACE but not over
1839 ;; the VALUE, as is the case in define-minor-mode's :variable.
1840 (define-setf-method eq
(place val
)
1841 (let ((method (get-setf-method place cl-macro-environment
))
1842 (val-temp (make-symbol "--eq-val--"))
1843 (store-temp (make-symbol "--eq-store--")))
1844 (list (append (nth 0 method
) (list val-temp
))
1845 (append (nth 1 method
) (list val
))
1847 `(let ((,(car (nth 2 method
))
1848 (if ,store-temp
,val-temp
(not ,val-temp
))))
1849 ,(nth 3 method
) ,store-temp
)
1850 `(eq ,(nth 4 method
) ,val-temp
))))
1852 ;;; More complex setf-methods.
1853 ;; These should take &environment arguments, but since full arglists aren't
1854 ;; available while compiling cl-macs, we fake it by referring to the global
1855 ;; variable cl-macro-environment directly.
1857 (define-setf-method apply
(func arg1
&rest rest
)
1858 (or (and (memq (car-safe func
) '(quote function function
*))
1859 (symbolp (car-safe (cdr-safe func
))))
1860 (error "First arg to apply in setf is not (function SYM): %s" func
))
1861 (let* ((form (cons (nth 1 func
) (cons arg1 rest
)))
1862 (method (get-setf-method form cl-macro-environment
)))
1863 (list (car method
) (nth 1 method
) (nth 2 method
)
1864 (cl-setf-make-apply (nth 3 method
) (cadr func
) (car method
))
1865 (cl-setf-make-apply (nth 4 method
) (cadr func
) (car method
)))))
1867 (defun cl-setf-make-apply (form func temps
)
1868 (if (eq (car form
) 'progn
)
1869 (list* 'progn
(cl-setf-make-apply (cadr form
) func temps
) (cddr form
))
1870 (or (equal (last form
) (last temps
))
1871 (error "%s is not suitable for use with setf-of-apply" func
))
1872 (list* 'apply
(list 'quote
(car form
)) (cdr form
))))
1874 (define-setf-method nthcdr
(n place
)
1875 (let ((method (get-setf-method place cl-macro-environment
))
1876 (n-temp (make-symbol "--cl-nthcdr-n--"))
1877 (store-temp (make-symbol "--cl-nthcdr-store--")))
1878 (list (cons n-temp
(car method
))
1879 (cons n
(nth 1 method
))
1881 (list 'let
(list (list (car (nth 2 method
))
1882 (list 'cl-set-nthcdr n-temp
(nth 4 method
)
1884 (nth 3 method
) store-temp
)
1885 (list 'nthcdr n-temp
(nth 4 method
)))))
1887 (define-setf-method getf
(place tag
&optional def
)
1888 (let ((method (get-setf-method place cl-macro-environment
))
1889 (tag-temp (make-symbol "--cl-getf-tag--"))
1890 (def-temp (make-symbol "--cl-getf-def--"))
1891 (store-temp (make-symbol "--cl-getf-store--")))
1892 (list (append (car method
) (list tag-temp def-temp
))
1893 (append (nth 1 method
) (list tag def
))
1895 (list 'let
(list (list (car (nth 2 method
))
1896 (list 'cl-set-getf
(nth 4 method
)
1897 tag-temp store-temp
)))
1898 (nth 3 method
) store-temp
)
1899 (list 'getf
(nth 4 method
) tag-temp def-temp
))))
1901 (define-setf-method substring
(place from
&optional to
)
1902 (let ((method (get-setf-method place cl-macro-environment
))
1903 (from-temp (make-symbol "--cl-substring-from--"))
1904 (to-temp (make-symbol "--cl-substring-to--"))
1905 (store-temp (make-symbol "--cl-substring-store--")))
1906 (list (append (car method
) (list from-temp to-temp
))
1907 (append (nth 1 method
) (list from to
))
1909 (list 'let
(list (list (car (nth 2 method
))
1910 (list 'cl-set-substring
(nth 4 method
)
1911 from-temp to-temp store-temp
)))
1912 (nth 3 method
) store-temp
)
1913 (list 'substring
(nth 4 method
) from-temp to-temp
))))
1915 ;;; Getting and optimizing setf-methods.
1917 (defun get-setf-method (place &optional env
)
1918 "Return a list of five values describing the setf-method for PLACE.
1919 PLACE may be any Lisp form which can appear as the PLACE argument to
1920 a macro like `setf' or `incf'."
1922 (let ((temp (make-symbol "--cl-setf--")))
1923 (list nil nil
(list temp
) (list 'setq place temp
) place
))
1924 (or (and (symbolp (car place
))
1925 (let* ((func (car place
))
1926 (name (symbol-name func
))
1927 (method (get func
'setf-method
))
1928 (case-fold-search nil
))
1930 (let ((cl-macro-environment env
))
1931 (setq method
(apply method
(cdr place
))))
1932 (if (and (consp method
) (= (length method
) 5))
1934 (error "Setf-method for %s returns malformed method"
1936 (and (string-match-p "\\`c[ad][ad][ad]?[ad]?r\\'" name
)
1937 (get-setf-method (compiler-macroexpand place
)))
1938 (and (eq func
'edebug-after
)
1939 (get-setf-method (nth (1- (length place
)) place
)
1941 (if (eq place
(setq place
(macroexpand place env
)))
1942 (if (and (symbolp (car place
)) (fboundp (car place
))
1943 (symbolp (symbol-function (car place
))))
1944 (get-setf-method (cons (symbol-function (car place
))
1946 (error "No setf-method known for %s" (car place
)))
1947 (get-setf-method place env
)))))
1949 (defun cl-setf-do-modify (place opt-expr
)
1950 (let* ((method (get-setf-method place cl-macro-environment
))
1951 (temps (car method
)) (values (nth 1 method
))
1952 (lets nil
) (subs nil
)
1953 (optimize (and (not (eq opt-expr
'no-opt
))
1954 (or (and (not (eq opt-expr
'unsafe
))
1955 (cl-safe-expr-p opt-expr
))
1956 (cl-setf-simple-store-p (car (nth 2 method
))
1958 (simple (and optimize
(consp place
) (cl-simple-exprs-p (cdr place
)))))
1960 (if (or simple
(cl-const-expr-p (car values
)))
1961 (push (cons (pop temps
) (pop values
)) subs
)
1962 (push (list (pop temps
) (pop values
)) lets
)))
1963 (list (nreverse lets
)
1964 (cons (car (nth 2 method
)) (sublis subs
(nth 3 method
)))
1965 (sublis subs
(nth 4 method
)))))
1967 (defun cl-setf-do-store (spec val
)
1968 (let ((sym (car spec
))
1970 (if (or (cl-const-expr-p val
)
1971 (and (cl-simple-expr-p val
) (eq (cl-expr-contains form sym
) 1))
1972 (cl-setf-simple-store-p sym form
))
1973 (subst val sym form
)
1974 (list 'let
(list (list sym val
)) form
))))
1976 (defun cl-setf-simple-store-p (sym form
)
1977 (and (consp form
) (eq (cl-expr-contains form sym
) 1)
1978 (eq (nth (1- (length form
)) form
) sym
)
1979 (symbolp (car form
)) (fboundp (car form
))
1980 (not (eq (car-safe (symbol-function (car form
))) 'macro
))))
1982 ;;; The standard modify macros.
1984 (defmacro setf
(&rest args
)
1985 "Set each PLACE to the value of its VAL.
1986 This is a generalized version of `setq'; the PLACEs may be symbolic
1987 references such as (car x) or (aref x i), as well as plain symbols.
1988 For example, (setf (cadar x) y) is equivalent to (setcar (cdar x) y).
1989 The return value is the last VAL in the list.
1991 \(fn PLACE VAL PLACE VAL ...)"
1992 (if (cdr (cdr args
))
1994 (while args
(push (list 'setf
(pop args
) (pop args
)) sets
))
1995 (cons 'progn
(nreverse sets
)))
1996 (if (symbolp (car args
))
1997 (and args
(cons 'setq args
))
1998 (let* ((method (cl-setf-do-modify (car args
) (nth 1 args
)))
1999 (store (cl-setf-do-store (nth 1 method
) (nth 1 args
))))
2000 (if (car method
) (list 'let
* (car method
) store
) store
)))))
2003 (defmacro psetf
(&rest args
)
2004 "Set PLACEs to the values VALs in parallel.
2005 This is like `setf', except that all VAL forms are evaluated (in order)
2006 before assigning any PLACEs to the corresponding values.
2008 \(fn PLACE VAL PLACE VAL ...)"
2009 (let ((p args
) (simple t
) (vars nil
))
2011 (if (or (not (symbolp (car p
))) (cl-expr-depends-p (nth 1 p
) vars
))
2013 (if (memq (car p
) vars
)
2014 (error "Destination duplicated in psetf: %s" (car p
)))
2016 (or p
(error "Odd number of arguments to psetf"))
2019 (list 'progn
(cons 'setf args
) nil
)
2020 (setq args
(reverse args
))
2021 (let ((expr (list 'setf
(cadr args
) (car args
))))
2022 (while (setq args
(cddr args
))
2023 (setq expr
(list 'setf
(cadr args
) (list 'prog1
(car args
) expr
))))
2024 (list 'progn expr nil
)))))
2027 (defun cl-do-pop (place)
2028 (if (cl-simple-expr-p place
)
2029 (list 'prog1
(list 'car place
) (list 'setf place
(list 'cdr place
)))
2030 (let* ((method (cl-setf-do-modify place t
))
2031 (temp (make-symbol "--cl-pop--")))
2033 (append (car method
)
2034 (list (list temp
(nth 2 method
))))
2037 (cl-setf-do-store (nth 1 method
) (list 'cdr temp
)))))))
2040 (defmacro remf
(place tag
)
2041 "Remove TAG from property list PLACE.
2042 PLACE may be a symbol, or any generalized variable allowed by `setf'.
2043 The form returns true if TAG was found and removed, nil otherwise."
2044 (let* ((method (cl-setf-do-modify place t
))
2045 (tag-temp (and (not (cl-const-expr-p tag
)) (make-symbol "--cl-remf-tag--")))
2046 (val-temp (and (not (cl-simple-expr-p place
))
2047 (make-symbol "--cl-remf-place--")))
2048 (ttag (or tag-temp tag
))
2049 (tval (or val-temp
(nth 2 method
))))
2051 (append (car method
)
2052 (and val-temp
(list (list val-temp
(nth 2 method
))))
2053 (and tag-temp
(list (list tag-temp tag
))))
2054 (list 'if
(list 'eq ttag
(list 'car tval
))
2056 (cl-setf-do-store (nth 1 method
) (list 'cddr tval
))
2058 (list 'cl-do-remf tval ttag
)))))
2061 (defmacro shiftf
(place &rest args
)
2062 "Shift left among PLACEs.
2063 Example: (shiftf A B C) sets A to B, B to C, and returns the old A.
2064 Each PLACE may be a symbol, or any generalized variable allowed by `setf'.
2069 ((symbolp place
) `(prog1 ,place
(setq ,place
(shiftf ,@args
))))
2071 (let ((method (cl-setf-do-modify place
'unsafe
)))
2072 `(let* ,(car method
)
2073 (prog1 ,(nth 2 method
)
2074 ,(cl-setf-do-store (nth 1 method
) `(shiftf ,@args
))))))))
2077 (defmacro rotatef
(&rest args
)
2078 "Rotate left among PLACEs.
2079 Example: (rotatef A B C) sets A to B, B to C, and C to A. It returns nil.
2080 Each PLACE may be a symbol, or any generalized variable allowed by `setf'.
2083 (if (not (memq nil
(mapcar 'symbolp args
)))
2088 (setq sets
(nconc sets
(list (pop args
) (car args
)))))
2089 (nconc (list 'psetf
) sets
(list (car args
) first
))))
2090 (let* ((places (reverse args
))
2091 (temp (make-symbol "--cl-rotatef--"))
2094 (let ((method (cl-setf-do-modify (pop places
) 'unsafe
)))
2095 (setq form
(list 'let
* (car method
)
2096 (list 'prog1
(nth 2 method
)
2097 (cl-setf-do-store (nth 1 method
) form
))))))
2098 (let ((method (cl-setf-do-modify (car places
) 'unsafe
)))
2099 (list 'let
* (append (car method
) (list (list temp
(nth 2 method
))))
2100 (cl-setf-do-store (nth 1 method
) form
) nil
)))))
2103 (defmacro letf
(bindings &rest body
)
2104 "Temporarily bind to PLACEs.
2105 This is the analogue of `let', but with generalized variables (in the
2106 sense of `setf') for the PLACEs. Each PLACE is set to the corresponding
2107 VALUE, then the BODY forms are executed. On exit, either normally or
2108 because of a `throw' or error, the PLACEs are set back to their original
2109 values. Note that this macro is *not* available in Common Lisp.
2110 As a special case, if `(PLACE)' is used instead of `(PLACE VALUE)',
2111 the PLACE is not modified before executing BODY.
2113 \(fn ((PLACE VALUE) ...) BODY...)"
2114 (if (and (not (cdr bindings
)) (cdar bindings
) (symbolp (caar bindings
)))
2115 (list* 'let bindings body
)
2116 (let ((lets nil
) (sets nil
)
2117 (unsets nil
) (rev (reverse bindings
)))
2119 (let* ((place (if (symbolp (caar rev
))
2120 (list 'symbol-value
(list 'quote
(caar rev
)))
2123 (method (cl-setf-do-modify place
'no-opt
))
2124 (save (make-symbol "--cl-letf-save--"))
2125 (bound (and (memq (car place
) '(symbol-value symbol-function
))
2126 (make-symbol "--cl-letf-bound--")))
2127 (temp (and (not (cl-const-expr-p value
)) (cdr bindings
)
2128 (make-symbol "--cl-letf-val--"))))
2129 (setq lets
(nconc (car method
)
2132 (list (if (eq (car place
)
2135 (nth 1 (nth 2 method
))))
2136 (list save
(list 'and bound
2138 (list (list save
(nth 2 method
))))
2139 (and temp
(list (list temp value
)))
2142 (list 'unwind-protect
2145 (cons (cl-setf-do-store (nth 1 method
)
2151 (cl-setf-do-store (nth 1 method
) save
)
2152 (list (if (eq (car place
) 'symbol-value
)
2153 'makunbound
'fmakunbound
)
2154 (nth 1 (nth 2 method
))))
2155 (cl-setf-do-store (nth 1 method
) save
))))
2157 (list* 'let
* lets body
))))
2160 (defmacro letf
* (bindings &rest body
)
2161 "Temporarily bind to PLACEs.
2162 This is the analogue of `let*', but with generalized variables (in the
2163 sense of `setf') for the PLACEs. Each PLACE is set to the corresponding
2164 VALUE, then the BODY forms are executed. On exit, either normally or
2165 because of a `throw' or error, the PLACEs are set back to their original
2166 values. Note that this macro is *not* available in Common Lisp.
2167 As a special case, if `(PLACE)' is used instead of `(PLACE VALUE)',
2168 the PLACE is not modified before executing BODY.
2170 \(fn ((PLACE VALUE) ...) BODY...)"
2173 (setq bindings
(reverse bindings
))
2175 (setq body
(list (list* 'letf
(list (pop bindings
)) body
))))
2179 (defmacro callf
(func place
&rest args
)
2180 "Set PLACE to (FUNC PLACE ARGS...).
2181 FUNC should be an unquoted function name. PLACE may be a symbol,
2182 or any generalized variable allowed by `setf'.
2184 \(fn FUNC PLACE ARGS...)"
2185 (let* ((method (cl-setf-do-modify place
(cons 'list args
)))
2186 (rargs (cons (nth 2 method
) args
)))
2187 (list 'let
* (car method
)
2188 (cl-setf-do-store (nth 1 method
)
2189 (if (symbolp func
) (cons func rargs
)
2190 (list* 'funcall
(list 'function func
)
2194 (defmacro callf2
(func arg1 place
&rest args
)
2195 "Set PLACE to (FUNC ARG1 PLACE ARGS...).
2196 Like `callf', but PLACE is the second argument of FUNC, not the first.
2198 \(fn FUNC ARG1 PLACE ARGS...)"
2199 (if (and (cl-safe-expr-p arg1
) (cl-simple-expr-p place
) (symbolp func
))
2200 (list 'setf place
(list* func arg1 place args
))
2201 (let* ((method (cl-setf-do-modify place
(cons 'list args
)))
2202 (temp (and (not (cl-const-expr-p arg1
)) (make-symbol "--cl-arg1--")))
2203 (rargs (list* (or temp arg1
) (nth 2 method
) args
)))
2204 (list 'let
* (append (and temp
(list (list temp arg1
))) (car method
))
2205 (cl-setf-do-store (nth 1 method
)
2206 (if (symbolp func
) (cons func rargs
)
2207 (list* 'funcall
(list 'function func
)
2211 (defmacro define-modify-macro
(name arglist func
&optional doc
)
2212 "Define a `setf'-like modify macro.
2213 If NAME is called, it combines its PLACE argument with the other arguments
2214 from ARGLIST using FUNC: (define-modify-macro incf (&optional (n 1)) +)"
2215 (if (memq '&key arglist
) (error "&key not allowed in define-modify-macro"))
2216 (let ((place (make-symbol "--cl-place--")))
2217 (list 'defmacro
* name
(cons place arglist
) doc
2218 (list* (if (memq '&rest arglist
) 'list
* 'list
)
2219 '(quote callf
) (list 'quote func
) place
2220 (cl-arglist-args arglist
)))))
2226 (defmacro defstruct
(struct &rest descs
)
2227 "Define a struct type.
2228 This macro defines a new data type called NAME that stores data
2229 in SLOTs. It defines a `make-NAME' constructor, a `copy-NAME'
2230 copier, a `NAME-p' predicate, and slot accessors named `NAME-SLOT'.
2231 You can use the accessors to set the corresponding slots, via `setf'.
2233 NAME may instead take the form (NAME OPTIONS...), where each
2234 OPTION is either a single keyword or (KEYWORD VALUE).
2235 See Info node `(cl)Structures' for a list of valid keywords.
2237 Each SLOT may instead take the form (SLOT SLOT-OPTS...), where
2238 SLOT-OPTS are keyword-value pairs for that slot. Currently, only
2239 one keyword is supported, `:read-only'. If this has a non-nil
2240 value, that slot cannot be set via `setf'.
2242 \(fn NAME SLOTS...)"
2243 (let* ((name (if (consp struct
) (car struct
) struct
))
2244 (opts (cdr-safe struct
))
2247 (conc-name (concat (symbol-name name
) "-"))
2248 (constructor (intern (format "make-%s" name
)))
2250 (copier (intern (format "copy-%s" name
)))
2251 (predicate (intern (format "%s-p" name
)))
2252 (print-func nil
) (print-auto nil
)
2253 (safety (if (cl-compiling-file) cl-optimize-safety
3))
2255 (tag (intern (format "cl-struct-%s" name
)))
2256 (tag-symbol (intern (format "cl-struct-%s-tags" name
)))
2262 pred-form pred-check
)
2263 (if (stringp (car descs
))
2264 (push (list 'put
(list 'quote name
) '(quote structure-documentation
)
2265 (pop descs
)) forms
))
2266 (setq descs
(cons '(cl-tag-slot)
2267 (mapcar (function (lambda (x) (if (consp x
) x
(list x
))))
2270 (let ((opt (if (consp (car opts
)) (caar opts
) (car opts
)))
2271 (args (cdr-safe (pop opts
))))
2272 (cond ((eq opt
:conc-name
)
2274 (setq conc-name
(if (car args
)
2275 (symbol-name (car args
)) ""))))
2276 ((eq opt
:constructor
)
2279 ;; If this defines a constructor of the same name as
2280 ;; the default one, don't define the default.
2281 (if (eq (car args
) constructor
)
2282 (setq constructor nil
))
2283 (push args constrs
))
2284 (if args
(setq constructor
(car args
)))))
2286 (if args
(setq copier
(car args
))))
2287 ((eq opt
:predicate
)
2288 (if args
(setq predicate
(car args
))))
2290 (setq include
(car args
)
2291 include-descs
(mapcar (function
2293 (if (consp x
) x
(list x
))))
2295 ((eq opt
:print-function
)
2296 (setq print-func
(car args
)))
2298 (setq type
(car args
)))
2301 ((eq opt
:initial-offset
)
2302 (setq descs
(nconc (make-list (car args
) '(cl-skip-slot))
2305 (error "Slot option %s unrecognized" opt
)))))
2307 (setq print-func
(list 'progn
2308 (list 'funcall
(list 'function print-func
)
2309 'cl-x
'cl-s
'cl-n
) t
))
2310 (or type
(and include
(not (get include
'cl-struct-print
)))
2312 print-func
(and (or (not (or include type
)) (null print-func
))
2314 (list 'princ
(format "#S(%s" name
)
2317 (let ((inc-type (get include
'cl-struct-type
))
2318 (old-descs (get include
'cl-struct-slots
)))
2319 (or inc-type
(error "%s is not a struct name" include
))
2320 (and type
(not (eq (car inc-type
) type
))
2321 (error ":type disagrees with :include for %s" name
))
2322 (while include-descs
2323 (setcar (memq (or (assq (caar include-descs
) old-descs
)
2324 (error "No slot %s in included struct %s"
2325 (caar include-descs
) include
))
2327 (pop include-descs
)))
2328 (setq descs
(append old-descs
(delq (assq 'cl-tag-slot descs
) descs
))
2330 named
(assq 'cl-tag-slot descs
))
2331 (if (cadr inc-type
) (setq tag name named t
))
2332 (let ((incl include
))
2334 (push (list 'pushnew
(list 'quote tag
)
2335 (intern (format "cl-struct-%s-tags" incl
)))
2337 (setq incl
(get incl
'cl-struct-include
)))))
2340 (or (memq type
'(vector list
))
2341 (error "Invalid :type specifier: %s" type
))
2342 (if named
(setq tag name
)))
2343 (setq type
'vector named
'true
)))
2344 (or named
(setq descs
(delq (assq 'cl-tag-slot descs
) descs
)))
2345 (push (list 'defvar tag-symbol
) forms
)
2346 (setq pred-form
(and named
2347 (let ((pos (- (length descs
)
2348 (length (memq (assq 'cl-tag-slot descs
)
2350 (if (eq type
'vector
)
2351 (list 'and
'(vectorp cl-x
)
2352 (list '>= '(length cl-x
) (length descs
))
2353 (list 'memq
(list 'aref
'cl-x pos
)
2356 (list 'memq
'(car-safe cl-x
) tag-symbol
)
2357 (list 'and
'(consp cl-x
)
2358 (list 'memq
(list 'nth pos
'cl-x
)
2360 pred-check
(and pred-form
(> safety
0)
2361 (if (and (eq (caadr pred-form
) 'vectorp
)
2363 (cons 'and
(cdddr pred-form
)) pred-form
)))
2364 (let ((pos 0) (descp descs
))
2366 (let* ((desc (pop descp
))
2368 (if (memq slot
'(cl-tag-slot cl-skip-slot
))
2371 (push (and (eq slot
'cl-tag-slot
) (list 'quote tag
))
2373 (if (assq slot descp
)
2374 (error "Duplicate slots named %s in %s" slot name
))
2375 (let ((accessor (intern (format "%s%s" conc-name slot
))))
2377 (push (nth 1 desc
) defaults
)
2379 'defsubst
* accessor
'(cl-x)
2382 (list (list 'or pred-check
2384 (format "%s accessing a non-%s"
2386 (list (if (eq type
'vector
) (list 'aref
'cl-x pos
)
2387 (if (= pos
0) '(car cl-x
)
2388 (list 'nth pos
'cl-x
)))))) forms
)
2389 (push (cons accessor t
) side-eff
)
2390 (push (list 'define-setf-method accessor
'(cl-x)
2391 (if (cadr (memq :read-only
(cddr desc
)))
2392 (list 'error
(format "%s is a read-only slot"
2394 ;; If cl is loaded only for compilation,
2395 ;; the call to cl-struct-setf-expander would
2396 ;; cause a warning because it may not be
2397 ;; defined at run time. Suppress that warning.
2398 (list 'with-no-warnings
2399 (list 'cl-struct-setf-expander
'cl-x
2400 (list 'quote name
) (list 'quote accessor
)
2401 (and pred-check
(list 'quote pred-check
))
2406 (list (list 'princ
(format " %s" slot
) 'cl-s
)
2407 (list 'prin1
(list accessor
'cl-x
) 'cl-s
)))))))
2408 (setq pos
(1+ pos
))))
2409 (setq slots
(nreverse slots
)
2410 defaults
(nreverse defaults
))
2411 (and predicate pred-form
2412 (progn (push (list 'defsubst
* predicate
'(cl-x)
2413 (if (eq (car pred-form
) 'and
)
2414 (append pred-form
'(t))
2415 (list 'and pred-form t
))) forms
)
2416 (push (cons predicate
'error-free
) side-eff
)))
2418 (progn (push (list 'defun
copier '(x) '(copy-sequence x
)) forms
)
2419 (push (cons copier t
) side-eff
)))
2421 (push (list constructor
2422 (cons '&key
(delq nil
(copy-sequence slots
))))
2425 (let* ((name (caar constrs
))
2426 (args (cadr (pop constrs
)))
2427 (anames (cl-arglist-args args
))
2428 (make (mapcar* (function (lambda (s d
) (if (memq s anames
) s d
)))
2430 (push (list 'defsubst
* name
2431 (list* '&cl-defs
(list 'quote
(cons nil descs
)) args
)
2432 (cons type make
)) forms
)
2433 (if (cl-safe-expr-p (cons 'progn
(mapcar 'second descs
)))
2434 (push (cons name t
) side-eff
))))
2435 (if print-auto
(nconc print-func
(list '(princ ")" cl-s
) t
)))
2438 ;; The auto-generated function does not pay attention to
2439 ;; the depth argument cl-n.
2440 (lambda (cl-x cl-s
,(if print-auto
'_cl-n
'cl-n
))
2441 (and ,pred-form
,print-func
))
2442 custom-print-functions
)
2444 (push (list 'setq tag-symbol
(list 'list
(list 'quote tag
))) forms
)
2445 (push (list* 'eval-when
'(compile load eval
)
2446 (list 'put
(list 'quote name
) '(quote cl-struct-slots
)
2447 (list 'quote descs
))
2448 (list 'put
(list 'quote name
) '(quote cl-struct-type
)
2449 (list 'quote
(list type
(eq named t
))))
2450 (list 'put
(list 'quote name
) '(quote cl-struct-include
)
2451 (list 'quote include
))
2452 (list 'put
(list 'quote name
) '(quote cl-struct-print
)
2454 (mapcar (function (lambda (x)
2455 (list 'put
(list 'quote
(car x
))
2456 '(quote side-effect-free
)
2457 (list 'quote
(cdr x
)))))
2460 (cons 'progn
(nreverse (cons (list 'quote name
) forms
)))))
2463 (defun cl-struct-setf-expander (x name accessor pred-form pos
)
2464 (let* ((temp (make-symbol "--cl-x--")) (store (make-symbol "--cl-store--")))
2465 (list (list temp
) (list x
) (list store
)
2468 (list (list 'or
(subst temp
'cl-x pred-form
)
2471 "%s storing a non-%s" accessor name
)))))
2472 (list (if (eq (car (get name
'cl-struct-type
)) 'vector
)
2473 (list 'aset temp pos store
)
2477 (while (>= (setq pos
(1- pos
)) 0)
2478 (setq xx
(list 'cdr xx
)))
2480 (list 'nthcdr pos temp
))
2482 (list accessor temp
))))
2485 ;;; Types and assertions.
2488 (defmacro deftype
(name arglist
&rest body
)
2489 "Define NAME as a new data type.
2490 The type name can then be used in `typecase', `check-type', etc."
2491 (list 'eval-when
'(compile load eval
)
2492 (cl-transform-function-property
2493 name
'cl-deftype-handler
(cons (list* '&cl-defs
''('*) arglist
) body
))))
2495 (defun cl-make-type-test (val type
)
2497 (cond ((get type
'cl-deftype-handler
)
2498 (cl-make-type-test val
(funcall (get type
'cl-deftype-handler
))))
2499 ((memq type
'(nil t
)) type
)
2500 ((eq type
'null
) `(null ,val
))
2501 ((eq type
'atom
) `(atom ,val
))
2502 ((eq type
'float
) `(floatp-safe ,val
))
2503 ((eq type
'real
) `(numberp ,val
))
2504 ((eq type
'fixnum
) `(integerp ,val
))
2505 ;; FIXME: Should `character' accept things like ?\C-\M-a ? -stef
2506 ((memq type
'(character string-char
)) `(characterp ,val
))
2508 (let* ((name (symbol-name type
))
2509 (namep (intern (concat name
"p"))))
2510 (if (fboundp namep
) (list namep val
)
2511 (list (intern (concat name
"-p")) val
)))))
2512 (cond ((get (car type
) 'cl-deftype-handler
)
2513 (cl-make-type-test val
(apply (get (car type
) 'cl-deftype-handler
)
2515 ((memq (car type
) '(integer float real number
))
2516 (delq t
(list 'and
(cl-make-type-test val
(car type
))
2517 (if (memq (cadr type
) '(* nil
)) t
2518 (if (consp (cadr type
)) (list '> val
(caadr type
))
2519 (list '>= val
(cadr type
))))
2520 (if (memq (caddr type
) '(* nil
)) t
2521 (if (consp (caddr type
)) (list '< val
(caaddr type
))
2522 (list '<= val
(caddr type
)))))))
2523 ((memq (car type
) '(and or not
))
2525 (mapcar (function (lambda (x) (cl-make-type-test val x
)))
2527 ((memq (car type
) '(member member
*))
2528 (list 'and
(list 'member
* val
(list 'quote
(cdr type
))) t
))
2529 ((eq (car type
) 'satisfies
) (list (cadr type
) val
))
2530 (t (error "Bad type spec: %s" type
)))))
2533 (defun typep (object type
) ; See compiler macro below.
2534 "Check that OBJECT is of type TYPE.
2535 TYPE is a Common Lisp-style type specifier."
2536 (eval (cl-make-type-test 'object type
)))
2539 (defmacro check-type
(form type
&optional string
)
2540 "Verify that FORM is of type TYPE; signal an error if not.
2541 STRING is an optional description of the desired type."
2542 (and (or (not (cl-compiling-file))
2543 (< cl-optimize-speed
3) (= cl-optimize-safety
3))
2544 (let* ((temp (if (cl-simple-expr-p form
3)
2545 form
(make-symbol "--cl-var--")))
2546 (body (list 'or
(cl-make-type-test temp type
)
2547 (list 'signal
'(quote wrong-type-argument
)
2548 (list 'list
(or string
(list 'quote type
))
2549 temp
(list 'quote form
))))))
2550 (if (eq temp form
) (list 'progn body nil
)
2551 (list 'let
(list (list temp form
)) body nil
)))))
2554 (defmacro assert
(form &optional show-args string
&rest args
)
2555 "Verify that FORM returns non-nil; signal an error if not.
2556 Second arg SHOW-ARGS means to include arguments of FORM in message.
2557 Other args STRING and ARGS... are arguments to be passed to `error'.
2558 They are not evaluated unless the assertion fails. If STRING is
2559 omitted, a default message listing FORM itself is used."
2560 (and (or (not (cl-compiling-file))
2561 (< cl-optimize-speed
3) (= cl-optimize-safety
3))
2562 (let ((sargs (and show-args
2565 (unless (cl-const-expr-p x
)
2571 (list* 'error string
(append sargs args
))
2572 (list 'signal
'(quote cl-assertion-failed
)
2573 (list* 'list
(list 'quote form
) sargs
))))
2576 ;;; Compiler macros.
2579 (defmacro define-compiler-macro
(func args
&rest body
)
2580 "Define a compiler-only macro.
2581 This is like `defmacro', but macro expansion occurs only if the call to
2582 FUNC is compiled (i.e., not interpreted). Compiler macros should be used
2583 for optimizing the way calls to FUNC are compiled; the form returned by
2584 BODY should do the same thing as a call to the normal function called
2585 FUNC, though possibly more efficiently. Note that, like regular macros,
2586 compiler macros are expanded repeatedly until no further expansions are
2587 possible. Unlike regular macros, BODY can decide to \"punt\" and leave the
2588 original function call alone by declaring an initial `&whole foo' parameter
2589 and then returning foo."
2590 (let ((p args
) (res nil
))
2591 (while (consp p
) (push (pop p
) res
))
2592 (setq args
(nconc (nreverse res
) (and p
(list '&rest p
)))))
2593 (list 'eval-when
'(compile load eval
)
2594 (cl-transform-function-property
2595 func
'cl-compiler-macro
2596 (cons (if (memq '&whole args
) (delq '&whole args
)
2597 (cons '_cl-whole-arg args
)) body
))
2598 (list 'or
(list 'get
(list 'quote func
) '(quote byte-compile
))
2600 (list 'put
(list 'quote func
) '(quote byte-compile
)
2601 '(quote cl-byte-compile-compiler-macro
))
2602 ;; This is so that describe-function can locate
2603 ;; the macro definition.
2607 (or buffer-file-name
2608 (and (boundp 'byte-compile-current-file
)
2609 (stringp byte-compile-current-file
)
2610 byte-compile-current-file
))))
2612 (list 'put
(list 'quote func
)
2613 '(quote compiler-macro-file
)
2614 '(purecopy (file-name-nondirectory file
)))))))))
2617 (defun compiler-macroexpand (form)
2619 (let ((func (car-safe form
)) (handler nil
))
2620 (while (and (symbolp func
)
2621 (not (setq handler
(get func
'cl-compiler-macro
)))
2623 (or (not (eq (car-safe (symbol-function func
)) 'autoload
))
2624 (load (nth 1 (symbol-function func
)))))
2625 (setq func
(symbol-function func
)))
2627 (not (eq form
(setq form
(apply handler form
(cdr form
))))))))
2630 (defun cl-byte-compile-compiler-macro (form)
2631 (if (eq form
(setq form
(compiler-macroexpand form
)))
2632 (byte-compile-normal-call form
)
2633 (byte-compile-form form
)))
2635 ;; Optimize away unused block-wrappers.
2637 (defvar cl-active-block-names nil
)
2639 (define-compiler-macro cl-block-wrapper
(cl-form)
2640 (let* ((cl-entry (cons (nth 1 (nth 1 cl-form
)) nil
))
2641 (cl-active-block-names (cons cl-entry cl-active-block-names
))
2642 (cl-body (macroexpand-all ;Performs compiler-macro expansions.
2643 (cons 'progn
(cddr cl-form
))
2644 macroexpand-all-environment
)))
2645 ;; FIXME: To avoid re-applying macroexpand-all, we'd like to be able
2646 ;; to indicate that this return value is already fully expanded.
2648 `(catch ,(nth 1 cl-form
) ,@(cdr cl-body
))
2651 (define-compiler-macro cl-block-throw
(cl-tag cl-value
)
2652 (let ((cl-found (assq (nth 1 cl-tag
) cl-active-block-names
)))
2653 (if cl-found
(setcdr cl-found t
)))
2654 `(throw ,cl-tag
,cl-value
))
2657 (defmacro defsubst
* (name args
&rest body
)
2658 "Define NAME as a function.
2659 Like `defun', except the function is automatically declared `inline',
2660 ARGLIST allows full Common Lisp conventions, and BODY is implicitly
2661 surrounded by (block NAME ...).
2663 \(fn NAME ARGLIST [DOCSTRING] BODY...)"
2664 (let* ((argns (cl-arglist-args args
)) (p argns
)
2665 (pbody (cons 'progn body
))
2666 (unsafe (not (cl-safe-expr-p pbody
))))
2667 (while (and p
(eq (cl-expr-contains args
(car p
)) 1)) (pop p
))
2669 (if p nil
; give up if defaults refer to earlier args
2670 (list 'define-compiler-macro name
2671 (if (memq '&key args
)
2672 (list* '&whole
'cl-whole
'&cl-quote args
)
2673 (cons '&cl-quote args
))
2674 (list* 'cl-defsubst-expand
(list 'quote argns
)
2675 (list 'quote
(list* 'block name body
))
2676 ;; We used to pass `simple' as
2677 ;; (not (or unsafe (cl-expr-access-order pbody argns)))
2678 ;; But this is much too simplistic since it
2679 ;; does not pay attention to the argvs (and
2680 ;; cl-expr-access-order itself is also too naive).
2682 (and (memq '&key args
) 'cl-whole
) unsafe argns
)))
2683 (list* 'defun
* name args body
))))
2685 (defun cl-defsubst-expand (argns body simple whole unsafe
&rest argvs
)
2686 (if (and whole
(not (cl-safe-expr-p (cons 'progn argvs
)))) whole
2687 (if (cl-simple-exprs-p argvs
) (setq simple t
))
2692 (if (or simple
(cl-const-expr-p argv
))
2693 (progn (push (cons argn argv
) substs
)
2694 (and unsafe
(list argn argv
)))
2697 ;; FIXME: `sublis/subst' will happily substitute the symbol
2698 ;; `argn' in places where it's not used as a reference
2700 ;; FIXME: `sublis/subst' will happily copy `argv' to a different
2701 ;; scope, leading to name capture.
2702 (setq body
(cond ((null substs
) body
)
2703 ((null (cdr substs
))
2704 (subst (cdar substs
) (caar substs
) body
))
2705 (t (sublis substs body
))))
2706 (if lets
(list 'let lets body
) body
))))
2709 ;; Compile-time optimizations for some functions defined in this package.
2710 ;; Note that cl.el arranges to force cl-macs to be loaded at compile-time,
2711 ;; mainly to make sure these macros will be present.
2713 (put 'eql
'byte-compile nil
)
2714 (define-compiler-macro eql
(&whole form a b
)
2715 (cond ((eq (cl-const-expr-p a
) t
)
2716 (let ((val (cl-const-expr-val a
)))
2717 (if (and (numberp val
) (not (integerp val
)))
2720 ((eq (cl-const-expr-p b
) t
)
2721 (let ((val (cl-const-expr-val b
)))
2722 (if (and (numberp val
) (not (integerp val
)))
2725 ((cl-simple-expr-p a
5)
2726 (list 'if
(list 'numberp a
)
2729 ((and (cl-safe-expr-p a
)
2730 (cl-simple-expr-p b
5))
2731 (list 'if
(list 'numberp b
)
2736 (define-compiler-macro member
* (&whole form a list
&rest keys
)
2737 (let ((test (and (= (length keys
) 2) (eq (car keys
) :test
)
2738 (cl-const-expr-val (nth 1 keys
)))))
2739 (cond ((eq test
'eq
) (list 'memq a list
))
2740 ((eq test
'equal
) (list 'member a list
))
2741 ((or (null keys
) (eq test
'eql
)) (list 'memql a list
))
2744 (define-compiler-macro assoc
* (&whole form a list
&rest keys
)
2745 (let ((test (and (= (length keys
) 2) (eq (car keys
) :test
)
2746 (cl-const-expr-val (nth 1 keys
)))))
2747 (cond ((eq test
'eq
) (list 'assq a list
))
2748 ((eq test
'equal
) (list 'assoc a list
))
2749 ((and (eq (cl-const-expr-p a
) t
) (or (null keys
) (eq test
'eql
)))
2750 (if (floatp-safe (cl-const-expr-val a
))
2751 (list 'assoc a list
) (list 'assq a list
)))
2754 (define-compiler-macro adjoin
(&whole form a list
&rest keys
)
2755 (if (and (cl-simple-expr-p a
) (cl-simple-expr-p list
)
2756 (not (memq :key keys
)))
2757 (list 'if
(list* 'member
* a list keys
) list
(list 'cons a list
))
2760 (define-compiler-macro list
* (arg &rest others
)
2761 (let* ((args (reverse (cons arg others
)))
2763 (while (setq args
(cdr args
))
2764 (setq form
(list 'cons
(car args
) form
)))
2767 (define-compiler-macro get
* (sym prop
&optional def
)
2769 (list 'getf
(list 'symbol-plist sym
) prop def
)
2770 (list 'get sym prop
)))
2772 (define-compiler-macro typep
(&whole form val type
)
2773 (if (cl-const-expr-p type
)
2774 (let ((res (cl-make-type-test val
(cl-const-expr-val type
))))
2775 (if (or (memq (cl-expr-contains res val
) '(nil 1))
2776 (cl-simple-expr-p val
)) res
2777 (let ((temp (make-symbol "--cl-var--")))
2778 (list 'let
(list (list temp val
)) (subst temp val res
)))))
2783 (put (car y
) 'side-effect-free t
)
2784 (put (car y
) 'byte-compile
'cl-byte-compile-compiler-macro
)
2785 (put (car y
) 'cl-compiler-macro
2787 ,(if (symbolp (cadr y
))
2789 (list ',(caddr y
) x
))
2790 (cons 'list
(cdr y
))))))
2791 '((first 'car x
) (second 'cadr x
) (third 'caddr x
) (fourth 'cadddr x
)
2792 (fifth 'nth
4 x
) (sixth 'nth
5 x
) (seventh 'nth
6 x
)
2793 (eighth 'nth
7 x
) (ninth 'nth
8 x
) (tenth 'nth
9 x
)
2794 (rest 'cdr x
) (endp 'null x
) (plusp '> x
0) (minusp '< x
0)
2795 (caaar car caar
) (caadr car cadr
) (cadar car cdar
)
2796 (caddr car cddr
) (cdaar cdr caar
) (cdadr cdr cadr
)
2797 (cddar cdr cdar
) (cdddr cdr cddr
) (caaaar car caaar
)
2798 (caaadr car caadr
) (caadar car cadar
) (caaddr car caddr
)
2799 (cadaar car cdaar
) (cadadr car cdadr
) (caddar car cddar
)
2800 (cadddr car cdddr
) (cdaaar cdr caaar
) (cdaadr cdr caadr
)
2801 (cdadar cdr cadar
) (cdaddr cdr caddr
) (cddaar cdr cdaar
)
2802 (cddadr cdr cdadr
) (cdddar cdr cddar
) (cddddr cdr cdddr
) ))
2804 ;;; Things that are inline.
2805 (proclaim '(inline floatp-safe acons map concatenate notany notevery
2806 cl-set-elt revappend nreconc gethash
))
2808 ;;; Things that are side-effect-free.
2809 (mapc (lambda (x) (put x
'side-effect-free t
))
2810 '(oddp evenp signum last butlast ldiff pairlis gcd lcm
2811 isqrt floor
* ceiling
* truncate
* round
* mod
* rem
* subseq
2812 list-length get
* getf
))
2814 ;;; Things that are side-effect-and-error-free.
2815 (mapc (lambda (x) (put x
'side-effect-free
'error-free
))
2816 '(eql floatp-safe list
* subst acons equalp random-state-p
2820 (run-hooks 'cl-macs-load-hook
)
2823 ;; byte-compile-dynamic: t
2824 ;; byte-compile-warnings: (not cl-functions)
2825 ;; generated-autoload-file: "cl-loaddefs.el"
2828 ;;; cl-macs.el ends here
