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