comparison lisp/cl-macs.el @ 209:41ff10fd062f r20-4b3

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