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