Mercurial > hg > xemacs-beta
annotate lisp/cl-macs.el @ 4792:95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
lisp/ChangeLog addition:
2009-11-08 Aidan Kehoe <kehoea@parhasard.net>
* cl-extra.el (cl-string-vector-equalp)
(cl-bit-vector-vector-equalp, cl-vector-array-equalp)
(cl-hash-table-contents-equalp): New functions, to implement
equalp treating arrays with identical contents as equivalent, as
specified by Common Lisp.
(equalp): Revise this function to implement array equivalence,
and the hash-table equalp behaviour specified by CL.
* cl-macs.el (equalp): Add a compiler macro for this function,
used when one of the arguments is constant, and as such, its type
is known at compile time.
man/ChangeLog addition:
2009-11-08 Aidan Kehoe <kehoea@parhasard.net>
* lispref/objects.texi (Equality Predicates):
Document #'equalp here, as well as #'equal and #'eq.
tests/ChangeLog addition:
2009-12-31 Aidan Kehoe <kehoea@parhasard.net>
* automated/lisp-tests.el:
Test much of the functionality of equalp; add a pointer to Paul
Dietz' ANSI test suite for this function, converted to Emacs
Lisp. Not including the tests themselves in XEmacs because who
owns the copyright on the files is unclear and the GCL people
didn't respond to my queries.
author | Aidan Kehoe <kehoea@parhasard.net> |
---|---|
date | Thu, 31 Dec 2009 15:09:41 +0000 |
parents | e29fcfd8df5f |
children | 8484c6c76837 |
rev | line source |
---|---|
613 | 1 ;;; cl-macs.el --- Common Lisp extensions for XEmacs Lisp (part four) |
428 | 2 |
2153 | 3 ;; Copyright (C) 1993, 2003, 2004 Free Software Foundation, Inc. |
800 | 4 ;; Copyright (C) 2002 Ben Wing. |
428 | 5 |
6 ;; Author: Dave Gillespie <daveg@synaptics.com> | |
7 ;; Version: 2.02 | |
8 ;; Keywords: extensions | |
9 | |
10 ;; This file is part of XEmacs. | |
11 | |
12 ;; XEmacs is free software; you can redistribute it and/or modify it | |
13 ;; under the terms of the GNU General Public License as published by | |
14 ;; the Free Software Foundation; either version 2, or (at your option) | |
15 ;; any later version. | |
16 | |
17 ;; XEmacs is distributed in the hope that it will be useful, but | |
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
20 ;; General Public License for more details. | |
21 | |
22 ;; You should have received a copy of the GNU General Public License | |
23 ;; along with XEmacs; see the file COPYING. If not, write to the Free | |
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
25 ;; 02111-1307, USA. | |
26 | |
2153 | 27 ;;; Synched up with: FSF 21.3. |
428 | 28 |
29 ;;; Commentary: | |
30 | |
31 ;; These are extensions to Emacs Lisp that provide a degree of | |
32 ;; Common Lisp compatibility, beyond what is already built-in | |
33 ;; in Emacs Lisp. | |
34 ;; | |
35 ;; This package was written by Dave Gillespie; it is a complete | |
36 ;; rewrite of Cesar Quiroz's original cl.el package of December 1986. | |
37 ;; | |
38 ;; Bug reports, comments, and suggestions are welcome! | |
39 | |
40 ;; This file contains the portions of the Common Lisp extensions | |
41 ;; package which should be autoloaded, but need only be present | |
42 ;; if the compiler or interpreter is used---this file is not | |
43 ;; necessary for executing compiled code. | |
44 | |
45 ;; See cl.el for Change Log. | |
46 | |
47 | |
48 ;;; Code: | |
49 | |
50 (or (memq 'cl-19 features) | |
51 (error "Tried to load `cl-macs' before `cl'!")) | |
52 | |
53 | |
54 (defmacro cl-pop2 (place) | |
55 (list 'prog1 (list 'car (list 'cdr place)) | |
56 (list 'setq place (list 'cdr (list 'cdr place))))) | |
57 (put 'cl-pop2 'edebug-form-spec 'edebug-sexps) | |
58 | |
59 (defvar cl-optimize-safety) | |
60 (defvar cl-optimize-speed) | |
61 | |
62 | |
63 ;;; This kludge allows macros which use cl-transform-function-property | |
64 ;;; to be called at compile-time. | |
65 | |
66 (require | |
67 (progn | |
68 (or (fboundp 'cl-transform-function-property) | |
69 (defalias 'cl-transform-function-property | |
70 #'(lambda (n p f) | |
71 (list 'put (list 'quote n) (list 'quote p) | |
72 (list 'function (cons 'lambda f)))))) | |
442 | 73 'xemacs)) |
428 | 74 |
75 | |
76 ;;; Initialization. | |
77 | |
78 (defvar cl-old-bc-file-form nil) | |
79 | |
80 ;;;###autoload | |
81 (defun cl-compile-time-init () | |
82 (run-hooks 'cl-hack-bytecomp-hook)) | |
83 | |
84 | |
2153 | 85 ;;; Some predicates for analyzing Lisp forms. These are used by various |
86 ;;; macro expanders to optimize the results in certain common cases. | |
87 | |
88 (defconst cl-simple-funcs '(car cdr nth aref elt if and or + - 1+ 1- min max | |
89 car-safe cdr-safe progn prog1 prog2)) | |
90 (defconst cl-safe-funcs '(* / % length memq list vector vectorp | |
91 < > <= >= = error)) | |
92 | |
93 ;;; Check if no side effects, and executes quickly. | |
94 (defun cl-simple-expr-p (x &optional size) | |
95 (or size (setq size 10)) | |
96 (if (and (consp x) (not (memq (car x) '(quote function function*)))) | |
97 (and (symbolp (car x)) | |
98 (or (memq (car x) cl-simple-funcs) | |
99 (get (car x) 'side-effect-free)) | |
100 (progn | |
101 (setq size (1- size)) | |
102 (while (and (setq x (cdr x)) | |
103 (setq size (cl-simple-expr-p (car x) size)))) | |
104 (and (null x) (>= size 0) size))) | |
105 (and (> size 0) (1- size)))) | |
106 | |
107 (defun cl-simple-exprs-p (xs) | |
108 (while (and xs (cl-simple-expr-p (car xs))) | |
109 (setq xs (cdr xs))) | |
110 (not xs)) | |
111 | |
112 ;;; Check if no side effects. | |
113 (defun cl-safe-expr-p (x) | |
114 (or (not (and (consp x) (not (memq (car x) '(quote function function*))))) | |
115 (and (symbolp (car x)) | |
116 (or (memq (car x) cl-simple-funcs) | |
117 (memq (car x) cl-safe-funcs) | |
118 (get (car x) 'side-effect-free)) | |
119 (progn | |
120 (while (and (setq x (cdr x)) (cl-safe-expr-p (car x)))) | |
121 (null x))))) | |
122 | |
123 ;;; Check if constant (i.e., no side effects or dependencies). | |
124 (defun cl-const-expr-p (x) | |
125 (cond ((consp x) | |
126 (or (eq (car x) 'quote) | |
127 (and (memq (car x) '(function function*)) | |
128 (or (symbolp (nth 1 x)) | |
129 (and (eq (car-safe (nth 1 x)) 'lambda) 'func))))) | |
130 ((symbolp x) (and (memq x '(nil t)) t)) | |
131 (t t))) | |
132 | |
133 (defun cl-const-exprs-p (xs) | |
134 (while (and xs (cl-const-expr-p (car xs))) | |
135 (setq xs (cdr xs))) | |
136 (not xs)) | |
137 | |
138 (defun cl-const-expr-val (x) | |
139 (and (eq (cl-const-expr-p x) t) (if (consp x) (nth 1 x) x))) | |
140 | |
141 (defun cl-expr-access-order (x v) | |
142 (if (cl-const-expr-p x) v | |
143 (if (consp x) | |
144 (progn | |
145 (while (setq x (cdr x)) (setq v (cl-expr-access-order (car x) v))) | |
146 v) | |
147 (if (eq x (car v)) (cdr v) '(t))))) | |
148 | |
149 ;;; Count number of times X refers to Y. Return nil for 0 times. | |
150 (defun cl-expr-contains (x y) | |
151 (cond ((equal y x) 1) | |
152 ((and (consp x) (not (memq (car-safe x) '(quote function function*)))) | |
153 (let ((sum 0)) | |
154 (while x | |
155 (setq sum (+ sum (or (cl-expr-contains (pop x) y) 0)))) | |
156 (and (> sum 0) sum))) | |
157 (t nil))) | |
158 | |
159 (defun cl-expr-contains-any (x y) | |
160 (while (and y (not (cl-expr-contains x (car y)))) (pop y)) | |
161 y) | |
162 | |
163 ;;; Check whether X may depend on any of the symbols in Y. | |
164 (defun cl-expr-depends-p (x y) | |
165 (and (not (cl-const-expr-p x)) | |
166 (or (not (cl-safe-expr-p x)) (cl-expr-contains-any x y)))) | |
167 | |
168 ;;; Symbols. | |
169 | |
170 (defvar *gensym-counter*) | |
171 | |
172 ;; XEmacs change: gensym and gentemp have been moved to cl.el. | |
173 | |
174 | |
428 | 175 ;;; Program structure. |
176 | |
177 ;;;###autoload | |
178 (defmacro defun* (name args &rest body) | |
179 "(defun* NAME ARGLIST [DOCSTRING] BODY...): define NAME as a function. | |
180 Like normal `defun', except ARGLIST allows full Common Lisp conventions, | |
872 | 181 and BODY is implicitly surrounded by (block NAME ...). |
182 | |
183 \"Full Common Lisp conventions\" means that: | |
184 | |
185 -- In addition to &optional and &rest, the lambda-list keywords &key, | |
186 &allow-other-keys, and &aux are allowed. | |
187 | |
188 -- The format of the arguments to &optional is expanded: As well as simple | |
189 variables, they can be lists of the form (VAR [INITFORM [SVAR]]); when | |
190 no argument is available for VAR, INITFORM is evaluated (or nil, if | |
191 INITFORM is omitted) and stored as VAR's value, and SVAR is bound to t. | |
192 If an arguent is available for VAR, and INITFORM is unused, SVAR is | |
193 bound to nil. | |
194 | |
195 -- &key specifies keyword arguments. The format of each argument is | |
196 VAR || ( { VAR || (KEYWORD VAR) } [INITFORM [SVAR]]) -- #### document me. | |
197 | |
198 -- &allow-other-keys means that if other keyword arguments are given that are | |
199 not specifically list in the arg list, they are allowed, rather than an | |
200 error being signalled. They can be retrieved with an &rest form. | |
201 | |
202 -- &aux specifies extra bindings, exactly like a `let*' enclosing the body. | |
203 The format of each binding is VAR || (VAR [INITFORM]) -- exactly like the | |
204 format of `let'/`let*' bindings. | |
205 " | |
428 | 206 (let* ((res (cl-transform-lambda (cons args body) name)) |
207 (form (list* 'defun name (cdr res)))) | |
208 (if (car res) (list 'progn (car res) form) form))) | |
209 | |
210 ;;;###autoload | |
211 (defmacro defmacro* (name args &rest body) | |
212 "(defmacro* NAME ARGLIST [DOCSTRING] BODY...): define NAME as a macro. | |
213 Like normal `defmacro', except ARGLIST allows full Common Lisp conventions, | |
872 | 214 and BODY is implicitly surrounded by (block NAME ...). |
215 | |
216 \"Full Common Lisp conventions\" means that: | |
217 | |
218 -- The lambda-list keywords &optional, &rest, &key, &allow-other-keys, and | |
219 &aux are allowed, as in `defun*'. | |
220 | |
221 -- Three additional lambda-list keywords are allowed: &body, &whole, and | |
222 &environment. #### Document me. | |
223 | |
224 -- The macro arg list syntax allows for \"destructuring\" -- see also | |
225 `destructuring-bind', which destructures exactly like `defmacro*', and | |
226 `loop', which does a rather different way of destructuring. Anywhere | |
227 that a simple argument may appear, and (if following a lambda-list | |
228 keyword) a list may not normally appear, an embedded lambda list can be | |
229 substituted. (The format of the embedded lambda list is exactly the | |
230 same as for a top-level list except that &environment is not allowed.) | |
231 When matching this lambda list against a caller-specified argument, that | |
232 argument is treated as a list and normal lambda-list processing occurs, | |
233 just as if the entire operation were happening at top level. | |
234 Furthermore, any lambda list, embedded or top-level, can be dotted at its | |
235 end, and this will cause matching with an appropriate dotted list given | |
236 as an argument. | |
237 | |
238 See `loop' for practical examples of destructuring, but | |
239 keep in mind that `loop' destructuring is somewhat different from macro | |
240 destructuring in that | |
241 | |
242 (a) Macro destructuring has extra features in the various lambda-list | |
243 keywords, allowing for special processing of a list other than just | |
244 simple matching. | |
245 (b) Macro destructuring is strict, in that an error is signalled if the | |
246 actual structure does not match the expected structure. On the | |
247 other hand, loop destructuring is lax -- extra arguments in a list | |
248 are ignored, not enough arguments cause the remaining parameters to | |
249 receive a value of nil, etc. | |
250 " | |
428 | 251 (let* ((res (cl-transform-lambda (cons args body) name)) |
252 (form (list* 'defmacro name (cdr res)))) | |
253 (if (car res) (list 'progn (car res) form) form))) | |
254 | |
255 ;;;###autoload | |
256 (defmacro function* (func) | |
257 "(function* SYMBOL-OR-LAMBDA): introduce a function. | |
258 Like normal `function', except that if argument is a lambda form, its | |
259 ARGLIST allows full Common Lisp conventions." | |
260 (if (eq (car-safe func) 'lambda) | |
261 (let* ((res (cl-transform-lambda (cdr func) 'cl-none)) | |
262 (form (list 'function (cons 'lambda (cdr res))))) | |
263 (if (car res) (list 'progn (car res) form) form)) | |
264 (list 'function func))) | |
265 | |
266 (defun cl-transform-function-property (func prop form) | |
267 (let ((res (cl-transform-lambda form func))) | |
268 (append '(progn) (cdr (cdr (car res))) | |
269 (list (list 'put (list 'quote func) (list 'quote prop) | |
270 (list 'function (cons 'lambda (cdr res)))))))) | |
271 | |
272 (defconst lambda-list-keywords | |
273 '(&optional &rest &key &allow-other-keys &aux &whole &body &environment)) | |
274 | |
275 (defvar cl-macro-environment nil) | |
276 (defvar bind-block) (defvar bind-defs) (defvar bind-enquote) | |
277 (defvar bind-inits) (defvar bind-lets) (defvar bind-forms) | |
278 | |
452 | 279 ;; npak@ispras.ru |
280 (defun cl-upcase-arg (arg) | |
1580 | 281 ;; Changes all non-keyword symbols in `ARG' to symbols |
452 | 282 ;; with name in upper case. |
1580 | 283 ;; ARG is either symbol or list of symbols or lists |
452 | 284 (cond ((symbolp arg) |
1580 | 285 ;; Do not upcase &optional, &key etc. |
4694
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
286 (if (memq arg lambda-list-keywords) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
287 arg |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
288 (make-symbol (upcase (symbol-name arg))))) |
1580 | 289 ((listp arg) |
290 (let ((arg (copy-list arg)) junk) | |
291 ;; Clean the list | |
292 (let ((p (last arg))) (if (cdr p) (setcdr p (list '&rest (cdr p))))) | |
293 (if (setq junk (cadr (memq '&cl-defs arg))) | |
294 (setq arg (delq '&cl-defs (delq junk arg)))) | |
295 (if (memq '&cl-quote arg) | |
296 (setq arg (delq '&cl-quote arg))) | |
297 (mapcar 'cl-upcase-arg arg))) | |
298 (t arg))) ; Maybe we are in initializer | |
452 | 299 |
300 ;; npak@ispras.ru | |
4702
eb1a409c317b
Unbreak autoload.el
Mike Sperber <sperber@deinprogramm.de>
parents:
4695
diff
changeset
|
301 ;;;###autoload |
1580 | 302 (defun cl-function-arglist (name arglist) |
452 | 303 "Returns string with printed representation of arguments list. |
304 Supports Common Lisp lambda lists." | |
1580 | 305 (if (not (or (listp arglist) (symbolp arglist))) |
306 "Not available" | |
4694
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
307 (check-argument-type #'true-list-p arglist) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
308 (let ((print-gensym nil)) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
309 (condition-case nil |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
310 (prin1-to-string |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
311 (cons (if (eq name 'cl-none) 'lambda name) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
312 (cond ((null arglist) nil) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
313 ((listp arglist) (cl-upcase-arg arglist)) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
314 ((symbolp arglist) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
315 (cl-upcase-arg (list '&rest arglist))) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
316 (t (wrong-type-argument 'listp arglist))))) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
317 (t "Not available"))))) |
452 | 318 |
428 | 319 (defun cl-transform-lambda (form bind-block) |
320 (let* ((args (car form)) (body (cdr form)) | |
321 (bind-defs nil) (bind-enquote nil) | |
322 (bind-inits nil) (bind-lets nil) (bind-forms nil) | |
452 | 323 (header nil) (simple-args nil) |
4694
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
324 (complex-arglist (cl-function-arglist bind-block args)) |
452 | 325 (doc "")) |
428 | 326 (while (or (stringp (car body)) (eq (car-safe (car body)) 'interactive)) |
2153 | 327 (push (pop body) header)) |
428 | 328 (setq args (if (listp args) (copy-list args) (list '&rest args))) |
329 (let ((p (last args))) (if (cdr p) (setcdr p (list '&rest (cdr p))))) | |
330 (if (setq bind-defs (cadr (memq '&cl-defs args))) | |
331 (setq args (delq '&cl-defs (delq bind-defs args)) | |
332 bind-defs (cadr bind-defs))) | |
333 (if (setq bind-enquote (memq '&cl-quote args)) | |
334 (setq args (delq '&cl-quote args))) | |
335 (if (memq '&whole args) (error "&whole not currently implemented")) | |
336 (let* ((p (memq '&environment args)) (v (cadr p))) | |
337 (if p (setq args (nconc (delq (car p) (delq v args)) | |
338 (list '&aux (list v 'cl-macro-environment)))))) | |
339 (while (and args (symbolp (car args)) | |
340 (not (memq (car args) '(nil &rest &body &key &aux))) | |
341 (not (and (eq (car args) '&optional) | |
342 (or bind-defs (consp (cadr args)))))) | |
2153 | 343 (push (pop args) simple-args)) |
428 | 344 (or (eq bind-block 'cl-none) |
345 (setq body (list (list* 'block bind-block body)))) | |
4694
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
346 (setq simple-args (nreverse simple-args) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
347 header (nreverse header)) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
348 ;; Add CL lambda list to documentation, if the CL lambda list differs |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
349 ;; from the non-CL lambda list. npak@ispras.ru |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
350 (unless (equal complex-arglist |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
351 (cl-function-arglist bind-block simple-args)) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
352 (and (stringp (car header)) (setq doc (pop header))) |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
353 (push (concat doc |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
354 "\n\nCommon Lisp lambda list:\n" |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
355 " " complex-arglist "\n\n") |
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
356 header)) |
428 | 357 (if (null args) |
4694
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
358 (list* nil simple-args (nconc header body)) |
2153 | 359 (if (memq '&optional simple-args) (push '&optional args)) |
428 | 360 (cl-do-arglist args nil (- (length simple-args) |
361 (if (memq '&optional simple-args) 1 0))) | |
362 (setq bind-lets (nreverse bind-lets)) | |
363 (list* (and bind-inits (list* 'eval-when '(compile load eval) | |
364 (nreverse bind-inits))) | |
4694
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
365 (nconc simple-args |
2153 | 366 (list '&rest (car (pop bind-lets)))) |
367 ;; XEmacs change: we add usage information using Nickolay's | |
368 ;; approach above | |
4694
2ac296807b88
Don't needlessly intern symbols, #'function-arglist, #'cl-function-arglist
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
369 (nconc header |
428 | 370 (list (nconc (list 'let* bind-lets) |
371 (nreverse bind-forms) body))))))) | |
372 | |
373 (defun cl-do-arglist (args expr &optional num) ; uses bind-* | |
374 (if (nlistp args) | |
375 (if (or (memq args lambda-list-keywords) (not (symbolp args))) | |
376 (error "Invalid argument name: %s" args) | |
2153 | 377 (push (list args expr) bind-lets)) |
428 | 378 (setq args (copy-list args)) |
379 (let ((p (last args))) (if (cdr p) (setcdr p (list '&rest (cdr p))))) | |
380 (let ((p (memq '&body args))) (if p (setcar p '&rest))) | |
381 (if (memq '&environment args) (error "&environment used incorrectly")) | |
382 (let ((save-args args) | |
383 (restarg (memq '&rest args)) | |
384 (safety (if (cl-compiling-file) cl-optimize-safety 3)) | |
385 (keys nil) | |
386 (laterarg nil) (exactarg nil) minarg) | |
387 (or num (setq num 0)) | |
388 (if (listp (cadr restarg)) | |
389 (setq restarg (gensym "--rest--")) | |
390 (setq restarg (cadr restarg))) | |
2153 | 391 (push (list restarg expr) bind-lets) |
428 | 392 (if (eq (car args) '&whole) |
2153 | 393 (push (list (cl-pop2 args) restarg) bind-lets)) |
428 | 394 (let ((p args)) |
395 (setq minarg restarg) | |
396 (while (and p (not (memq (car p) lambda-list-keywords))) | |
397 (or (eq p args) (setq minarg (list 'cdr minarg))) | |
398 (setq p (cdr p))) | |
399 (if (memq (car p) '(nil &aux)) | |
400 (setq minarg (list '= (list 'length restarg) | |
401 (length (ldiff args p))) | |
402 exactarg (not (eq args p))))) | |
403 (while (and args (not (memq (car args) lambda-list-keywords))) | |
404 (let ((poparg (list (if (or (cdr args) (not exactarg)) 'pop 'car) | |
405 restarg))) | |
406 (cl-do-arglist | |
2153 | 407 (pop args) |
428 | 408 (if (or laterarg (= safety 0)) poparg |
409 (list 'if minarg poparg | |
410 (list 'signal '(quote wrong-number-of-arguments) | |
411 (list 'list (and (not (eq bind-block 'cl-none)) | |
412 (list 'quote bind-block)) | |
413 (list 'length restarg))))))) | |
414 (setq num (1+ num) laterarg t)) | |
2153 | 415 (while (and (eq (car args) '&optional) (pop args)) |
428 | 416 (while (and args (not (memq (car args) lambda-list-keywords))) |
2153 | 417 (let ((arg (pop args))) |
428 | 418 (or (consp arg) (setq arg (list arg))) |
419 (if (cddr arg) (cl-do-arglist (nth 2 arg) (list 'and restarg t))) | |
420 (let ((def (if (cdr arg) (nth 1 arg) | |
421 (or (car bind-defs) | |
422 (nth 1 (assq (car arg) bind-defs))))) | |
423 (poparg (list 'pop restarg))) | |
424 (and def bind-enquote (setq def (list 'quote def))) | |
425 (cl-do-arglist (car arg) | |
426 (if def (list 'if restarg poparg def) poparg)) | |
427 (setq num (1+ num)))))) | |
428 (if (eq (car args) '&rest) | |
429 (let ((arg (cl-pop2 args))) | |
430 (if (consp arg) (cl-do-arglist arg restarg))) | |
431 (or (eq (car args) '&key) (= safety 0) exactarg | |
2153 | 432 (push (list 'if restarg |
428 | 433 (list 'signal '(quote wrong-number-of-arguments) |
434 (list 'list | |
435 (and (not (eq bind-block 'cl-none)) | |
436 (list 'quote bind-block)) | |
437 (list '+ num (list 'length restarg))))) | |
438 bind-forms))) | |
2153 | 439 (while (and (eq (car args) '&key) (pop args)) |
428 | 440 (while (and args (not (memq (car args) lambda-list-keywords))) |
2153 | 441 (let ((arg (pop args))) |
428 | 442 (or (consp arg) (setq arg (list arg))) |
443 (let* ((karg (if (consp (car arg)) (caar arg) | |
444 (intern (format ":%s" (car arg))))) | |
445 (varg (if (consp (car arg)) (cadar arg) (car arg))) | |
446 (def (if (cdr arg) (cadr arg) | |
447 (or (car bind-defs) (cadr (assq varg bind-defs))))) | |
448 (look (list 'memq (list 'quote karg) restarg))) | |
449 (and def bind-enquote (setq def (list 'quote def))) | |
450 (if (cddr arg) | |
451 (let* ((temp (or (nth 2 arg) (gensym))) | |
452 (val (list 'car (list 'cdr temp)))) | |
453 (cl-do-arglist temp look) | |
454 (cl-do-arglist varg | |
455 (list 'if temp | |
456 (list 'prog1 val (list 'setq temp t)) | |
457 def))) | |
458 (cl-do-arglist | |
459 varg | |
460 (list 'car | |
461 (list 'cdr | |
462 (if (null def) | |
463 look | |
464 (list 'or look | |
465 (if (eq (cl-const-expr-p def) t) | |
466 (list | |
467 'quote | |
468 (list nil (cl-const-expr-val def))) | |
469 (list 'list nil def)))))))) | |
2153 | 470 (push karg keys) |
471 ;; XEmacs addition | |
428 | 472 (if (= (aref (symbol-name karg) 0) ?:) |
473 (progn (set karg karg) | |
2153 | 474 (push (list 'setq karg (list 'quote karg)) |
475 bind-inits))))))) | |
428 | 476 (setq keys (nreverse keys)) |
2153 | 477 (or (and (eq (car args) '&allow-other-keys) (pop args)) |
428 | 478 (null keys) (= safety 0) |
479 (let* ((var (gensym "--keys--")) | |
480 (allow '(:allow-other-keys)) | |
481 (check (list | |
482 'while var | |
483 (list | |
484 'cond | |
485 (list (list 'memq (list 'car var) | |
486 (list 'quote (append keys allow))) | |
487 (list 'setq var (list 'cdr (list 'cdr var)))) | |
488 (list (list 'car | |
489 (list 'cdr | |
490 (list 'memq (cons 'quote allow) | |
491 restarg))) | |
492 (list 'setq var nil)) | |
493 (list t | |
494 (list | |
495 'error | |
496 (format "Keyword argument %%s not one of %s" | |
497 keys) | |
498 (list 'car var))))))) | |
2153 | 499 (push (list 'let (list (list var restarg)) check) bind-forms))) |
500 (while (and (eq (car args) '&aux) (pop args)) | |
428 | 501 (while (and args (not (memq (car args) lambda-list-keywords))) |
502 (if (consp (car args)) | |
503 (if (and bind-enquote (cadar args)) | |
504 (cl-do-arglist (caar args) | |
2153 | 505 (list 'quote (cadr (pop args)))) |
506 (cl-do-arglist (caar args) (cadr (pop args)))) | |
507 (cl-do-arglist (pop args) nil)))) | |
428 | 508 (if args (error "Malformed argument list %s" save-args))))) |
509 | |
510 (defun cl-arglist-args (args) | |
511 (if (nlistp args) (list args) | |
512 (let ((res nil) (kind nil) arg) | |
513 (while (consp args) | |
2153 | 514 (setq arg (pop args)) |
428 | 515 (if (memq arg lambda-list-keywords) (setq kind arg) |
2153 | 516 (if (eq arg '&cl-defs) (pop args) |
428 | 517 (and (consp arg) kind (setq arg (car arg))) |
518 (and (consp arg) (cdr arg) (eq kind '&key) (setq arg (cadr arg))) | |
519 (setq res (nconc res (cl-arglist-args arg)))))) | |
520 (nconc res (and args (list args)))))) | |
521 | |
522 ;;;###autoload | |
523 (defmacro destructuring-bind (args expr &rest body) | |
872 | 524 "Bind the arguments in ARGS to EXPR then eval BODY. |
525 This is similar to `let' but it does \"destructuring\", in that it matches | |
526 the structure of ARGS to the structure of EXPR and binds corresponding | |
527 arguments in ARGS to their values in EXPR. The format of ARGS, and the | |
528 way the destructuring works, is exactly like the destructuring that occurs | |
529 in `defmacro*'; see that for more information. | |
530 | |
531 An alternative means of destructuring is using the `loop' macro. `loop' | |
532 gives practical examples of destructuring. `defmacro*' describes the | |
533 differences between loop and macro-style destructuring. | |
534 | |
535 You can rewrite a call to (destructuring-bind ARGS EXPR &rest BODY) using | |
536 `loop', approximately like this: | |
537 | |
538 (loop for ARGS = EXPR | |
539 return (progn BODY)) | |
540 | |
541 I say \"approximately\" because the destructuring works in a somewhat | |
542 different fashion, although for most reasonably simple constructs the | |
543 results will be the same." | |
428 | 544 (let* ((bind-lets nil) (bind-forms nil) (bind-inits nil) |
545 (bind-defs nil) (bind-block 'cl-none)) | |
546 (cl-do-arglist (or args '(&aux)) expr) | |
547 (append '(progn) bind-inits | |
548 (list (nconc (list 'let* (nreverse bind-lets)) | |
549 (nreverse bind-forms) body))))) | |
550 | |
551 | |
552 ;;; The `eval-when' form. | |
553 | |
554 (defvar cl-not-toplevel nil) | |
555 | |
556 ;;;###autoload | |
557 (defmacro eval-when (when &rest body) | |
558 "(eval-when (WHEN...) BODY...): control when BODY is evaluated. | |
559 If `compile' is in WHEN, BODY is evaluated when compiled at top-level. | |
560 If `load' is in WHEN, BODY is evaluated when loaded after top-level compile. | |
561 If `eval' is in WHEN, BODY is evaluated when interpreted or at non-top-level." | |
562 (if (and (fboundp 'cl-compiling-file) (cl-compiling-file) | |
563 (not cl-not-toplevel) (not (boundp 'for-effect))) ; horrible kludge | |
2153 | 564 (let ((comp (or (memq 'compile when) (memq :compile-toplevel when))) |
428 | 565 (cl-not-toplevel t)) |
2153 | 566 (if (or (memq 'load when) (memq :load-toplevel when)) |
428 | 567 (if comp (cons 'progn (mapcar 'cl-compile-time-too body)) |
568 (list* 'if nil nil body)) | |
569 (progn (if comp (eval (cons 'progn body))) nil))) | |
2153 | 570 (and (or (memq 'eval when) (memq :execute when)) |
428 | 571 (cons 'progn body)))) |
572 | |
573 (defun cl-compile-time-too (form) | |
574 (or (and (symbolp (car-safe form)) (get (car-safe form) 'byte-hunk-handler)) | |
575 (setq form (macroexpand | |
576 form (cons '(eval-when) byte-compile-macro-environment)))) | |
577 (cond ((eq (car-safe form) 'progn) | |
578 (cons 'progn (mapcar 'cl-compile-time-too (cdr form)))) | |
579 ((eq (car-safe form) 'eval-when) | |
580 (let ((when (nth 1 form))) | |
2153 | 581 (if (or (memq 'eval when) (memq :execute when)) |
428 | 582 (list* 'eval-when (cons 'compile when) (cddr form)) |
583 form))) | |
584 (t (eval form) form))) | |
585 | |
586 ;;;###autoload | |
587 (defmacro load-time-value (form &optional read-only) | |
588 "Like `progn', but evaluates the body at load time. | |
589 The result of the body appears to the compiler as a quoted constant." | |
590 (if (cl-compiling-file) | |
591 (let* ((temp (gentemp "--cl-load-time--")) | |
592 (set (list 'set (list 'quote temp) form))) | |
593 (if (and (fboundp 'byte-compile-file-form-defmumble) | |
594 (boundp 'this-kind) (boundp 'that-one)) | |
595 (fset 'byte-compile-file-form | |
596 (list 'lambda '(form) | |
597 (list 'fset '(quote byte-compile-file-form) | |
598 (list 'quote | |
599 (symbol-function 'byte-compile-file-form))) | |
600 (list 'byte-compile-file-form (list 'quote set)) | |
601 '(byte-compile-file-form form))) | |
602 ;; XEmacs change | |
603 (print set (symbol-value ;;'outbuffer | |
604 'byte-compile-output-buffer | |
605 ))) | |
606 (list 'symbol-value (list 'quote temp))) | |
607 (list 'quote (eval form)))) | |
608 | |
609 | |
610 ;;; Conditional control structures. | |
611 | |
612 ;;;###autoload | |
613 (defmacro case (expr &rest clauses) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
614 "Evals EXPR, chooses from CLAUSES on that value. |
428 | 615 Each clause looks like (KEYLIST BODY...). EXPR is evaluated and compared |
616 against each key in each KEYLIST; the corresponding BODY is evaluated. | |
617 If no clause succeeds, case returns nil. A single atom may be used in | |
618 place of a KEYLIST of one atom. A KEYLIST of `t' or `otherwise' is | |
619 allowed only in the final clause, and matches if no other keys match. | |
620 Key values are compared by `eql'." | |
621 (let* ((temp (if (cl-simple-expr-p expr 3) expr (gensym))) | |
622 (head-list nil) | |
623 (last-clause (car (last clauses))) | |
624 (body (cons | |
625 'cond | |
626 (mapcar | |
627 #'(lambda (c) | |
628 (cons (cond ((memq (car c) '(t otherwise)) | |
2153 | 629 ;; XEmacs addition: check for last clause |
428 | 630 (or (eq c last-clause) |
631 (error | |
632 "`%s' is allowed only as the last case clause" | |
633 (car c))) | |
634 t) | |
635 ((eq (car c) 'ecase-error-flag) | |
636 (list 'error "ecase failed: %s, %s" | |
637 temp (list 'quote (reverse head-list)))) | |
638 ((listp (car c)) | |
639 (setq head-list (append (car c) head-list)) | |
640 (list 'member* temp (list 'quote (car c)))) | |
641 (t | |
642 (if (memq (car c) head-list) | |
643 (error "Duplicate key in case: %s" | |
644 (car c))) | |
2153 | 645 (push (car c) head-list) |
428 | 646 (list 'eql temp (list 'quote (car c))))) |
647 (or (cdr c) '(nil)))) | |
648 clauses)))) | |
649 (if (eq temp expr) body | |
650 (list 'let (list (list temp expr)) body)))) | |
651 | |
652 ;; #### CL standard also requires `ccase', which signals a continuable | |
653 ;; error (`cerror' in XEmacs). However, I don't think it buys us | |
654 ;; anything to introduce it, as there is probably much more CL stuff | |
655 ;; missing, and the feature is not essential. --hniksic | |
656 | |
657 ;;;###autoload | |
658 (defmacro ecase (expr &rest clauses) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
659 "Like `case', but error if no case fits. |
428 | 660 `otherwise'-clauses are not allowed." |
2153 | 661 ;; XEmacs addition: disallow t and otherwise |
428 | 662 (let ((disallowed (or (assq t clauses) |
663 (assq 'otherwise clauses)))) | |
664 (if disallowed | |
665 (error "`%s' is not allowed in ecase" (car disallowed)))) | |
666 (list* 'case expr (append clauses '((ecase-error-flag))))) | |
667 | |
668 ;;;###autoload | |
669 (defmacro typecase (expr &rest clauses) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
670 "Evals EXPR, chooses from CLAUSES on that value. |
428 | 671 Each clause looks like (TYPE BODY...). EXPR is evaluated and, if it |
672 satisfies TYPE, the corresponding BODY is evaluated. If no clause succeeds, | |
673 typecase returns nil. A TYPE of `t' or `otherwise' is allowed only in the | |
674 final clause, and matches if no other keys match." | |
675 (let* ((temp (if (cl-simple-expr-p expr 3) expr (gensym))) | |
676 (type-list nil) | |
677 (body (cons | |
678 'cond | |
679 (mapcar | |
680 #'(lambda (c) | |
681 (cons (cond ((eq (car c) 'otherwise) t) | |
682 ((eq (car c) 'ecase-error-flag) | |
683 (list 'error "etypecase failed: %s, %s" | |
684 temp (list 'quote (reverse type-list)))) | |
685 (t | |
2153 | 686 (push (car c) type-list) |
428 | 687 (cl-make-type-test temp (car c)))) |
688 (or (cdr c) '(nil)))) | |
689 clauses)))) | |
690 (if (eq temp expr) body | |
691 (list 'let (list (list temp expr)) body)))) | |
692 | |
693 ;;;###autoload | |
694 (defmacro etypecase (expr &rest clauses) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
695 "Like `typecase', but error if no case fits. |
428 | 696 `otherwise'-clauses are not allowed." |
697 (list* 'typecase expr (append clauses '((ecase-error-flag))))) | |
698 | |
699 | |
700 ;;; Blocks and exits. | |
701 | |
702 ;;;###autoload | |
703 (defmacro block (name &rest body) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
704 "Define a lexically-scoped block named NAME. |
428 | 705 NAME may be any symbol. Code inside the BODY forms can call `return-from' |
706 to jump prematurely out of the block. This differs from `catch' and `throw' | |
707 in two respects: First, the NAME is an unevaluated symbol rather than a | |
708 quoted symbol or other form; and second, NAME is lexically rather than | |
709 dynamically scoped: Only references to it within BODY will work. These | |
710 references may appear inside macro expansions, but not inside functions | |
711 called from BODY." | |
712 (if (cl-safe-expr-p (cons 'progn body)) (cons 'progn body) | |
713 (list 'cl-block-wrapper | |
714 (list* 'catch (list 'quote (intern (format "--cl-block-%s--" name))) | |
715 body)))) | |
716 | |
717 (defvar cl-active-block-names nil) | |
718 | |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
719 (put 'cl-block-wrapper 'byte-compile |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
720 #'(lambda (cl-form) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
721 (if (/= (length cl-form) 2) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
722 (byte-compile-warn-wrong-args cl-form 1)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
723 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
724 (if (fboundp 'byte-compile-form-do-effect) ; Check for optimizing |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
725 ; compiler |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
726 (progn |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
727 (let* ((cl-entry (cons (nth 1 (nth 1 (nth 1 cl-form))) nil)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
728 (cl-active-block-names (cons cl-entry |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
729 cl-active-block-names)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
730 (cl-body (byte-compile-top-level |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
731 (cons 'progn (cddr (nth 1 cl-form)))))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
732 (if (cdr cl-entry) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
733 (byte-compile-form (list 'catch (nth 1 (nth 1 cl-form)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
734 cl-body)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
735 (byte-compile-form cl-body)))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
736 (byte-compile-form (nth 1 cl-form))))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
737 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
738 (put 'cl-block-throw 'byte-compile |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
739 #'(lambda (cl-form) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
740 (let ((cl-found (assq (nth 1 (nth 1 cl-form)) cl-active-block-names))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
741 (if cl-found (setcdr cl-found t))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
742 (byte-compile-throw (cons 'throw (cdr cl-form))))) |
428 | 743 |
744 ;;;###autoload | |
2153 | 745 (defmacro return (&optional result) |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
746 "Return from the block named nil. |
428 | 747 This is equivalent to `(return-from nil RESULT)'." |
2153 | 748 (list 'return-from nil result)) |
428 | 749 |
750 ;;;###autoload | |
2153 | 751 (defmacro return-from (name &optional result) |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
752 "Return from the block named NAME. |
428 | 753 This jumps out to the innermost enclosing `(block NAME ...)' form, |
754 returning RESULT from that form (or nil if RESULT is omitted). | |
755 This is compatible with Common Lisp, but note that `defun' and | |
756 `defmacro' do not create implicit blocks as they do in Common Lisp." | |
757 (let ((name2 (intern (format "--cl-block-%s--" name)))) | |
2153 | 758 (list 'cl-block-throw (list 'quote name2) result))) |
428 | 759 |
760 | |
761 ;;; The "loop" macro. | |
762 | |
763 (defvar args) (defvar loop-accum-var) (defvar loop-accum-vars) | |
764 (defvar loop-bindings) (defvar loop-body) (defvar loop-destr-temps) | |
765 (defvar loop-finally) (defvar loop-finish-flag) (defvar loop-first-flag) | |
766 (defvar loop-initially) (defvar loop-map-form) (defvar loop-name) | |
767 (defvar loop-result) (defvar loop-result-explicit) | |
768 (defvar loop-result-var) (defvar loop-steps) (defvar loop-symbol-macs) | |
769 | |
770 ;;;###autoload | |
771 (defmacro loop (&rest args) | |
772 "(loop CLAUSE...): The Common Lisp `loop' macro. | |
800 | 773 |
774 The loop macro consists of a series of clauses, which do things like | |
775 iterate variables, set conditions for exiting the loop, accumulating values | |
776 to be returned as the return value of the loop, and executing arbitrary | |
2297 | 777 blocks of code. Each clause is processed in turn, and the loop executes its |
800 | 778 body repeatedly until an exit condition is hit. |
779 | |
780 It's important to understand that loop clauses such as `for' and `while', | |
781 which look like loop-establishing constructs, don't actually *establish* a | |
782 loop\; the looping is established by the `loop' clause itself, which will | |
783 repeatedly process its body until told to stop. `while' merely establishes | |
784 a condition which, when true, causes the loop to finish, and `for' sets a | |
785 variable to different values on each iteration (e.g. successive elements of | |
786 a list) and sets an exit condition when there are no more values. This | |
787 means, for example, that if two `for' clauses appear, you don't get two | |
788 nested loops, but instead two variables that are stepped in parallel, and | |
789 two exit conditions, either of which, if triggered, will cause the loop to | |
790 end. Similarly for a loop with a `for' and a `while' clause. For example: | |
791 | |
792 \(loop | |
793 for x in list | |
794 while x | |
795 do ...) | |
796 | |
797 In each successive iteration, X is set to the next element of the list. If | |
798 there are no more elements, or if any element is nil (the `while' clause), | |
799 the loop exits. Otherwise, the block of code following `do' is executed.) | |
800 | |
801 This example also shows that some clauses establish variable bindings -- | |
802 essentially like a `let' binding -- and that following clauses can | |
803 reference these variables. Furthermore, the entire loop is surrounded by a | |
804 block named nil (unless the `named' clause is given), so you can return | |
805 from the loop using the macro `return'. (The other way to exit the loop is | |
806 through the macro `loop-finish'. The difference is that some loop clauses | |
807 establish or accumulate a value to be returned, and `loop-finish' returns | |
808 this. `return', however, can only return an explicitly-specified value. | |
809 NOTE CAREFULLY: There is a loop clause called `return' as well as a | |
810 standard Lisp macro called `return'. Normally they work similarly\; but if | |
811 you give the loop a name with `named', you will need to use the macro | |
812 `return-from'.) | |
813 | |
814 Another extremely useful feature of loops is called \"destructuring\". If, | |
815 in place of VAR, a list (possibly dotted, possibly a tree of arbitary | |
816 complexity) is given, the value to be assigned is assumed to have a similar | |
817 structure to the list given, and variables in the list will be matched up | |
818 with corresponding elements in the structure. For example: | |
819 | |
820 \(loop | |
821 for (x y) in '((foo 1) (bar 2) (baz 3)) | |
822 do (puthash x y some-hash-table)) | |
823 | |
824 will add three elements to a hash table, mapping foo -> 1, bar -> 2, and | |
825 baz -> 3. As other examples, you can conveniently process alists using | |
826 | |
827 \(loop for (x . y) in alist do ...) | |
828 | |
829 and plists using | |
830 | |
831 \(loop for (x y) on plist by #'cddr do ...) | |
832 | |
833 Destructuring is forgiving in that mismatches in the number of elements on | |
834 either size will be handled gracefully, either by ignoring or initializing | |
1123 | 835 to nil. Destructuring is extremely powerful, and is probably the single |
836 most useful feature of `loop'. | |
837 | |
838 Other useful features of loops are iterating over hash-tables, collecting values into lists, and being able to modify lists in-place as you iterate over them. As an example of the first two, | |
839 | |
840 \(loop for x being the hash-key in table using (hash-value y) | |
841 collect (cons x y)) | |
842 | |
843 converts hash-table TABLE to an alist. (What `collect' actually does is | |
844 push its value onto the end of an internal list and establish this list as | |
845 the default return value of the loop. See below for more information.) | |
846 | |
847 An example of in-place modification is | |
848 | |
849 \(setq foo '(1 3 5)) | |
850 \(loop for x in-ref foo do | |
851 (setf x (* x x))) | |
852 | |
853 after which foo will contain '(1 9 25). | |
800 | 854 |
855 If you don't understand how a particular loop clause works, create an | |
856 example and use `macroexpand-sexp' to expand the macro. | |
857 | |
428 | 858 Valid clauses are: |
800 | 859 |
860 \(NOTE: Keywords in lowercase\; slashes separate different possibilities | |
861 for keywords, some of which are synonymous\; brackets indicate optional | |
862 parts of the clause. In all of the clauses with `being', the word `being', | |
863 the words `each' or `the', and the difference between singular and plural | |
864 keywords are all just syntactic sugar. Stylistically, you should write | |
865 either `being each foo' or `being the foos'.) | |
866 | |
867 for VAR from/upfrom/downfrom NUM1 to/upto/downto/above/below NUM2 [by NUMSTEP] | |
868 Step VAR across numbers. `upfrom', `upto', and `below' explicitly | |
869 indicate upward stepping\; `downfrom', `downto', and `above' explicitly | |
870 indicate downward stepping. (If none of these is given, the default is | |
871 upward.) `to', `upto', and `downto' cause stepping to include NUM2 as | |
872 the last iteration, while `above' and `below' stop just before reaching | |
873 NUM2. `by' can be given to indicate a stepping increment other than 1. | |
874 | |
875 for VAR in LIST [by FUNC] | |
876 Step VAR over elements of a LIST. FUNC specifies how to get successive | |
877 sublists and defaults to `cdr'. | |
878 | |
879 for VAR on LIST [by FUNC] | |
880 Step VAR over tails of a LIST. FUNC specifies how to get successive | |
881 sublists and defaults to `cdr'. | |
882 | |
883 for VAR in-ref LIST [by FUNC] | |
884 Step VAR over elements of a LIST, like `for ... in', except the VAR is | |
885 bound using `symbol-macrolet' instead of `let'. In essence, VAR is set | |
886 to a \"reference\" to the list element instead of the element itself\; | |
887 this us, you can destructively modify the list using `setf' on VAR, and | |
888 any changes to the list will \"magically\" reflect themselves in | |
889 subsequent uses of VAR. | |
890 | |
891 for VAR = INIT [then EXPR] | |
892 Set VAR on each iteration of the loop. If only INIT is given, use it | |
893 on each iteration. Otherwise, use INIT on the first iteration and EXPR | |
894 on subsequent ones. | |
895 | |
896 for VAR across/across-ref ARRAY | |
897 Step VAR across a sequence other than a list (string, vector, bit | |
898 vector). If `across-ref' is given, VAR is bound using | |
899 `symbol-macrolet' instead of `let' -- see above. | |
900 | |
901 for VAR being each/the element/elements in/of/in-ref/of-ref SEQUENCE [using (index INDEX-VAR)] | |
902 Step VAR across any sequence. A variable can be specified with a | |
903 `using' phrase to receive the index, starting at 0. If `in-ref' or | |
904 `of-ref' is given, VAR is bound using `symbol-macrolet' instead of | |
905 `let' -- see above. | |
906 | |
907 for VAR being each/the hash-key/hash-keys/hash-value/hash-values in/of HASH-TABLE [using (hash-value/hash-key OTHER-VAR)] | |
908 | |
909 for VAR being each/the hash-key/hash-keys/hash-value/hash-values in/of HASH-TABLE [using (hash-value/hash-key OTHER-VAR)] | |
910 Map VAR over a hash table. The various keywords are synonymous except | |
911 those that distinguish between keys and values. The `using' phrase is | |
912 optional and allows both key and value to be bound. | |
913 | |
914 for VAR being each/the symbol/present-symbol/external-symbol/symbols/present-symbols/external-symbols in/of OBARRAY | |
915 Map VAR over the symbols in an obarray. All symbol keywords are | |
916 currently synonymous. | |
917 | |
918 for VAR being each/the extent/extents [in/of BUFFER-OR-STRING] [from POS] [to POS] | |
919 Map VAR over the extents in a buffer or string, defaulting to the | |
920 current buffer, the beginning and the end, respectively. | |
921 | |
922 for VAR being each/the interval/intervals [in/of BUFFER-OR-STRING] [property PROPERTY] [from POS] [to POS] | |
923 Map VAR over the intervals without property change in a buffer or | |
924 string, defaulting to the current buffer, the beginning and the end, | |
925 respectively. If PROPERTY is given, iteration occurs using | |
926 `next-single-property-change'\; otherwise, using | |
927 `next-property-change'. | |
928 | |
929 for VAR being each/the window/windows [in/of FRAME] | |
930 Step VAR over the windows in FRAME, defaulting to the selected frame. | |
931 | |
932 for VAR being each/the frame/frames | |
933 Step VAR over all frames. | |
934 | |
935 for VAR being each/the buffer/buffers [by FUNC] | |
936 Step VAR over all buffers. This is actually equivalent to | |
937 `for VAR in (buffer-list) [by FUNC]'. | |
938 | |
939 for VAR being each/the key-code/key-codes/key-seq/key-seqs/key-binding/key-bindings in KEYMAP [using (key-code/key-codes/key-seq/key-seqs/key-binding/key-bindings OTHER-VAR)] | |
940 Map VAR over the entries in a keymap. Keyword `key-seq' causes | |
941 recursive mapping over prefix keymaps occurring in the keymap, with VAR | |
942 getting the built-up sequence (a vector). Otherwise, mapping does not | |
943 occur recursively. `key-code' and `key-seq' refer to what is bound | |
944 (second argument of `define-key'), and `key-binding' what it's bound to | |
945 (third argument of `define-key'). | |
946 | |
947 as VAR ... | |
948 `as' is a synonym for `for'. | |
949 | |
950 and VAR ... | |
951 `and' clauses have the same syntax as `for' clauses except that the | |
952 variables in the clause are bound in parallel with a preceding | |
953 `and'/`for' clause instead of in series. | |
954 | |
955 with VAR = INIT | |
956 Set VAR to INIT once, before doing any iterations. | |
957 | |
958 repeat NUM | |
959 Exit the loop if more than NUM iterations have occurred. | |
960 | |
961 while COND | |
962 Exit the loop if COND isn't true. | |
963 | |
964 until COND | |
965 Exit the loop if COND is true. | |
966 | |
967 collect EXPR [into VAR] | |
968 Push EXPR onto the end of a list of values -- stored either in VAR or a | |
969 temporary variable that will be returned as the return value of the | |
970 loop if it terminates through an exit condition or a call to | |
971 `loop-finish'. | |
972 | |
973 append EXPR [into VAR] | |
974 Append EXPR (a list) onto the end of a list of values, like `collect'. | |
975 | |
976 nconc EXPR [into VAR] | |
977 Nconc EXPR (a list) onto the end of a list of values, like `collect'. | |
978 | |
979 concat EXPR [into VAR] | |
980 Concatenate EXPR (a string) onto the end of a string of values, like | |
981 `collect'. | |
982 | |
983 vconcat EXPR [into VAR] | |
984 Concatenate EXPR (a vector) onto the end of a vector of values, like | |
985 `collect'. | |
986 | |
987 bvconcat EXPR [into VAR] | |
988 Concatenate EXPR (a bit vector) onto the end of a bit vector of values, | |
989 like `collect'. | |
990 | |
991 sum EXPR [into VAR] | |
992 Add EXPR to a value, like `collect'. | |
993 | |
994 count EXPR [into VAR] | |
995 If EXPR is true, increment a value by 1, like `collect'. | |
996 | |
997 maximize EXPR [into VAR] | |
998 IF EXPR is greater than a value, replace the value with EXPR, like | |
999 `collect'. | |
1000 | |
1001 minimize EXPR [into VAR] | |
1002 IF EXPR is less than a value, replace the value with EXPR, like | |
1003 `collect'. | |
1004 | |
1005 always COND | |
1006 If COND is true, continue the loop and set the loop return value (the | |
1007 same value that's manipulated by `collect' and friends and is returned | |
1008 by a normal loop exit or an exit using `loop-finish') to t\; otherwise, | |
1009 exit the loop and return nil. The effect is to determine and return | |
1010 whether a condition is true \"always\" (all iterations of the loop). | |
1011 | |
1012 never COND | |
1013 If COND is false, continue the loop and set the loop return value (like | |
1014 `always') to t\; otherwise, exit the loop and return nil. The effect | |
1015 is to determine and return whether a condition is \"never\" true (all | |
1016 iterations of the loop). | |
1017 | |
1018 thereis COND | |
1019 If COND is true, exit the loop and return COND. | |
1020 | |
1021 if/when COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...] | |
1022 If COND is true, execute the directly following clause(s)\; otherwise, | |
1023 execute the clauses following `else'. | |
1024 | |
1025 unless COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...] | |
1026 If COND is false, execute the directly following clause(s)\; otherwise, execute the clauses following `else'. | |
1027 | |
1028 do EXPRS... | |
1029 Execute the expressions (any Lisp forms). | |
1030 | |
1031 initially EXPRS... | |
1032 Execute EXPR once, before doing any iterations, and after values have | |
1033 been set using `with'. | |
1034 | |
1035 finally EXPRS... | |
1036 Execute EXPR once, directly before the loop terminates. This will not | |
1037 be executed if the loop terminates prematurely as a result of `always', | |
1038 `never', `thereis', or `return'. | |
1039 | |
1040 return EXPR | |
1041 Exit from the loop and return EXPR. | |
1042 | |
1043 finally return EXPR | |
1044 Specify the value to be returned when the loop exits. (Unlike `return', | |
1045 this doesn't cause the loop to immediately exit\; it will exit whenever | |
1046 it normally would have.) This takes precedence over a return value | |
1047 specified with `collect' and friends or `always' and friends. | |
1048 | |
1049 named NAME | |
1050 Specify the name for block surrounding the loop, in place of nil. | |
1051 (See `block'.) | |
1052 " | |
428 | 1053 (if (not (memq t (mapcar 'symbolp (delq nil (delq t (copy-list args)))))) |
1054 (list 'block nil (list* 'while t args)) | |
1055 (let ((loop-name nil) (loop-bindings nil) | |
1056 (loop-body nil) (loop-steps nil) | |
1057 (loop-result nil) (loop-result-explicit nil) | |
1058 (loop-result-var nil) (loop-finish-flag nil) | |
1059 (loop-accum-var nil) (loop-accum-vars nil) | |
1060 (loop-initially nil) (loop-finally nil) | |
1061 (loop-map-form nil) (loop-first-flag nil) | |
1062 (loop-destr-temps nil) (loop-symbol-macs nil)) | |
1063 (setq args (append args '(cl-end-loop))) | |
1064 (while (not (eq (car args) 'cl-end-loop)) (cl-parse-loop-clause)) | |
1065 (if loop-finish-flag | |
2153 | 1066 (push (list (list loop-finish-flag t)) loop-bindings)) |
428 | 1067 (if loop-first-flag |
2153 | 1068 (progn (push (list (list loop-first-flag t)) loop-bindings) |
1069 (push (list 'setq loop-first-flag nil) loop-steps))) | |
428 | 1070 (let* ((epilogue (nconc (nreverse loop-finally) |
1071 (list (or loop-result-explicit loop-result)))) | |
1072 (ands (cl-loop-build-ands (nreverse loop-body))) | |
1073 (while-body (nconc (cadr ands) (nreverse loop-steps))) | |
1074 (body (append | |
1075 (nreverse loop-initially) | |
1076 (list (if loop-map-form | |
1077 (list 'block '--cl-finish-- | |
1078 (subst | |
1079 (if (eq (car ands) t) while-body | |
1080 (cons (list 'or (car ands) | |
1081 '(return-from --cl-finish-- | |
1082 nil)) | |
1083 while-body)) | |
1084 '--cl-map loop-map-form)) | |
1085 (list* 'while (car ands) while-body))) | |
1086 (if loop-finish-flag | |
1346 | 1087 (if (equal epilogue '(nil)) |
1088 ;; XEmacs change: When epilogue is nil and | |
1089 ;; loop-finish-flag exists, you get a byte-compiler | |
1090 ;; warning using the original (commented-out) | |
1091 ;; code below. So instead we create a form that | |
1092 ;; gives the same result but uses loop-finish-flag. | |
1093 ;; --ben | |
1094 ;(list loop-result-var) | |
1095 (list (list 'if loop-finish-flag | |
1096 loop-result-var loop-result-var)) | |
428 | 1097 (list (list 'if loop-finish-flag |
1098 (cons 'progn epilogue) loop-result-var))) | |
1099 epilogue)))) | |
2153 | 1100 (if loop-result-var (push (list loop-result-var) loop-bindings)) |
428 | 1101 (while loop-bindings |
1102 (if (cdar loop-bindings) | |
2153 | 1103 (setq body (list (cl-loop-let (pop loop-bindings) body t))) |
428 | 1104 (let ((lets nil)) |
1105 (while (and loop-bindings | |
1106 (not (cdar loop-bindings))) | |
2153 | 1107 (push (car (pop loop-bindings)) lets)) |
428 | 1108 (setq body (list (cl-loop-let lets body nil)))))) |
1109 (if loop-symbol-macs | |
1110 (setq body (list (list* 'symbol-macrolet loop-symbol-macs body)))) | |
1111 (list* 'block loop-name body))))) | |
1112 | |
1113 (defun cl-parse-loop-clause () ; uses args, loop-* | |
2153 | 1114 (let ((word (pop args)) |
428 | 1115 (hash-types '(hash-key hash-keys hash-value hash-values)) |
1116 (key-types '(key-code key-codes key-seq key-seqs | |
1117 key-binding key-bindings))) | |
1118 (cond | |
1119 | |
1120 ((null args) | |
1121 (error "Malformed `loop' macro")) | |
1122 | |
1123 ((eq word 'named) | |
2153 | 1124 (setq loop-name (pop args))) |
428 | 1125 |
1126 ((eq word 'initially) | |
2153 | 1127 (if (memq (car args) '(do doing)) (pop args)) |
428 | 1128 (or (consp (car args)) (error "Syntax error on `initially' clause")) |
1129 (while (consp (car args)) | |
2153 | 1130 (push (pop args) loop-initially))) |
428 | 1131 |
1132 ((eq word 'finally) | |
1133 (if (eq (car args) 'return) | |
1134 (setq loop-result-explicit (or (cl-pop2 args) '(quote nil))) | |
2153 | 1135 (if (memq (car args) '(do doing)) (pop args)) |
428 | 1136 (or (consp (car args)) (error "Syntax error on `finally' clause")) |
1137 (if (and (eq (caar args) 'return) (null loop-name)) | |
2153 | 1138 (setq loop-result-explicit (or (nth 1 (pop args)) '(quote nil))) |
428 | 1139 (while (consp (car args)) |
2153 | 1140 (push (pop args) loop-finally))))) |
428 | 1141 |
1142 ((memq word '(for as)) | |
1143 (let ((loop-for-bindings nil) (loop-for-sets nil) (loop-for-steps nil) | |
1144 (ands nil)) | |
1145 (while | |
2153 | 1146 (let ((var (or (pop args) (gensym)))) |
1147 (setq word (pop args)) | |
1148 (if (eq word 'being) (setq word (pop args))) | |
1149 (if (memq word '(the each)) (setq word (pop args))) | |
428 | 1150 (if (memq word '(buffer buffers)) |
1151 (setq word 'in args (cons '(buffer-list) args))) | |
1152 (cond | |
1153 | |
1154 ((memq word '(from downfrom upfrom to downto upto | |
1155 above below by)) | |
2153 | 1156 (push word args) |
428 | 1157 (if (memq (car args) '(downto above)) |
1158 (error "Must specify `from' value for downward loop")) | |
1159 (let* ((down (or (eq (car args) 'downfrom) | |
1160 (memq (caddr args) '(downto above)))) | |
1161 (excl (or (memq (car args) '(above below)) | |
1162 (memq (caddr args) '(above below)))) | |
1163 (start (and (memq (car args) '(from upfrom downfrom)) | |
1164 (cl-pop2 args))) | |
1165 (end (and (memq (car args) | |
1166 '(to upto downto above below)) | |
1167 (cl-pop2 args))) | |
1168 (step (and (eq (car args) 'by) (cl-pop2 args))) | |
1169 (end-var (and (not (cl-const-expr-p end)) (gensym))) | |
1170 (step-var (and (not (cl-const-expr-p step)) | |
1171 (gensym)))) | |
1172 (and step (numberp step) (<= step 0) | |
1173 (error "Loop `by' value is not positive: %s" step)) | |
2153 | 1174 (push (list var (or start 0)) loop-for-bindings) |
1175 (if end-var (push (list end-var end) loop-for-bindings)) | |
1176 (if step-var (push (list step-var step) | |
428 | 1177 loop-for-bindings)) |
1178 (if end | |
2153 | 1179 (push (list |
428 | 1180 (if down (if excl '> '>=) (if excl '< '<=)) |
1181 var (or end-var end)) loop-body)) | |
2153 | 1182 (push (list var (list (if down '- '+) var |
428 | 1183 (or step-var step 1))) |
1184 loop-for-steps))) | |
1185 | |
1186 ((memq word '(in in-ref on)) | |
1187 (let* ((on (eq word 'on)) | |
1188 (temp (if (and on (symbolp var)) var (gensym)))) | |
2153 | 1189 (push (list temp (pop args)) loop-for-bindings) |
1190 (push (list 'consp temp) loop-body) | |
428 | 1191 (if (eq word 'in-ref) |
2153 | 1192 (push (list var (list 'car temp)) loop-symbol-macs) |
428 | 1193 (or (eq temp var) |
1194 (progn | |
2153 | 1195 (push (list var nil) loop-for-bindings) |
1196 (push (list var (if on temp (list 'car temp))) | |
428 | 1197 loop-for-sets)))) |
2153 | 1198 (push (list temp |
428 | 1199 (if (eq (car args) 'by) |
1200 (let ((step (cl-pop2 args))) | |
1201 (if (and (memq (car-safe step) | |
1202 '(quote function | |
1203 function*)) | |
1204 (symbolp (nth 1 step))) | |
1205 (list (nth 1 step) temp) | |
1206 (list 'funcall step temp))) | |
1207 (list 'cdr temp))) | |
1208 loop-for-steps))) | |
1209 | |
1210 ((eq word '=) | |
2153 | 1211 (let* ((start (pop args)) |
428 | 1212 (then (if (eq (car args) 'then) (cl-pop2 args) start))) |
2153 | 1213 (push (list var nil) loop-for-bindings) |
428 | 1214 (if (or ands (eq (car args) 'and)) |
1215 (progn | |
2153 | 1216 (push (list var |
428 | 1217 (list 'if |
1218 (or loop-first-flag | |
1219 (setq loop-first-flag | |
1220 (gensym))) | |
1221 start var)) | |
1222 loop-for-sets) | |
2153 | 1223 (push (list var then) loop-for-steps)) |
1224 (push (list var | |
428 | 1225 (if (eq start then) start |
1226 (list 'if | |
1227 (or loop-first-flag | |
1228 (setq loop-first-flag (gensym))) | |
1229 start then))) | |
1230 loop-for-sets)))) | |
1231 | |
1232 ((memq word '(across across-ref)) | |
1233 (let ((temp-vec (gensym)) (temp-idx (gensym))) | |
2153 | 1234 (push (list temp-vec (pop args)) loop-for-bindings) |
1235 (push (list temp-idx -1) loop-for-bindings) | |
1236 (push (list '< (list 'setq temp-idx (list '1+ temp-idx)) | |
428 | 1237 (list 'length temp-vec)) loop-body) |
1238 (if (eq word 'across-ref) | |
2153 | 1239 (push (list var (list 'aref temp-vec temp-idx)) |
428 | 1240 loop-symbol-macs) |
2153 | 1241 (push (list var nil) loop-for-bindings) |
1242 (push (list var (list 'aref temp-vec temp-idx)) | |
428 | 1243 loop-for-sets)))) |
1244 | |
1245 ((memq word '(element elements)) | |
1246 (let ((ref (or (memq (car args) '(in-ref of-ref)) | |
1247 (and (not (memq (car args) '(in of))) | |
1248 (error "Expected `of'")))) | |
1249 (seq (cl-pop2 args)) | |
1250 (temp-seq (gensym)) | |
1251 (temp-idx (if (eq (car args) 'using) | |
1252 (if (and (= (length (cadr args)) 2) | |
1253 (eq (caadr args) 'index)) | |
1254 (cadr (cl-pop2 args)) | |
1255 (error "Bad `using' clause")) | |
1256 (gensym)))) | |
2153 | 1257 (push (list temp-seq seq) loop-for-bindings) |
1258 (push (list temp-idx 0) loop-for-bindings) | |
428 | 1259 (if ref |
1260 (let ((temp-len (gensym))) | |
2153 | 1261 (push (list temp-len (list 'length temp-seq)) |
428 | 1262 loop-for-bindings) |
2153 | 1263 (push (list var (list 'elt temp-seq temp-idx)) |
428 | 1264 loop-symbol-macs) |
2153 | 1265 (push (list '< temp-idx temp-len) loop-body)) |
1266 (push (list var nil) loop-for-bindings) | |
1267 (push (list 'and temp-seq | |
428 | 1268 (list 'or (list 'consp temp-seq) |
1269 (list '< temp-idx | |
1270 (list 'length temp-seq)))) | |
1271 loop-body) | |
2153 | 1272 (push (list var (list 'if (list 'consp temp-seq) |
428 | 1273 (list 'pop temp-seq) |
1274 (list 'aref temp-seq temp-idx))) | |
1275 loop-for-sets)) | |
2153 | 1276 (push (list temp-idx (list '1+ temp-idx)) |
428 | 1277 loop-for-steps))) |
1278 | |
1279 ((memq word hash-types) | |
1280 (or (memq (car args) '(in of)) (error "Expected `of'")) | |
1281 (let* ((table (cl-pop2 args)) | |
1282 (other (if (eq (car args) 'using) | |
1283 (if (and (= (length (cadr args)) 2) | |
1284 (memq (caadr args) hash-types) | |
1285 (not (eq (caadr args) word))) | |
1286 (cadr (cl-pop2 args)) | |
1287 (error "Bad `using' clause")) | |
1288 (gensym)))) | |
1289 (if (memq word '(hash-value hash-values)) | |
1290 (setq var (prog1 other (setq other var)))) | |
1291 (setq loop-map-form | |
1292 (list 'maphash (list 'function | |
1293 (list* 'lambda (list var other) | |
1294 '--cl-map)) table)))) | |
1295 | |
1296 ((memq word '(symbol present-symbol external-symbol | |
1297 symbols present-symbols external-symbols)) | |
1298 (let ((ob (and (memq (car args) '(in of)) (cl-pop2 args)))) | |
1299 (setq loop-map-form | |
1300 (list 'mapatoms (list 'function | |
1301 (list* 'lambda (list var) | |
1302 '--cl-map)) ob)))) | |
1303 | |
1304 ((memq word '(overlay overlays extent extents)) | |
1305 (let ((buf nil) (from nil) (to nil)) | |
1306 (while (memq (car args) '(in of from to)) | |
1307 (cond ((eq (car args) 'from) (setq from (cl-pop2 args))) | |
1308 ((eq (car args) 'to) (setq to (cl-pop2 args))) | |
1309 (t (setq buf (cl-pop2 args))))) | |
1310 (setq loop-map-form | |
1311 (list 'cl-map-extents | |
1312 (list 'function (list 'lambda (list var (gensym)) | |
1313 '(progn . --cl-map) nil)) | |
1314 buf from to)))) | |
1315 | |
1316 ((memq word '(interval intervals)) | |
1317 (let ((buf nil) (prop nil) (from nil) (to nil) | |
1318 (var1 (gensym)) (var2 (gensym))) | |
1319 (while (memq (car args) '(in of property from to)) | |
1320 (cond ((eq (car args) 'from) (setq from (cl-pop2 args))) | |
1321 ((eq (car args) 'to) (setq to (cl-pop2 args))) | |
1322 ((eq (car args) 'property) | |
1323 (setq prop (cl-pop2 args))) | |
1324 (t (setq buf (cl-pop2 args))))) | |
1325 (if (and (consp var) (symbolp (car var)) (symbolp (cdr var))) | |
1326 (setq var1 (car var) var2 (cdr var)) | |
2153 | 1327 (push (list var (list 'cons var1 var2)) loop-for-sets)) |
428 | 1328 (setq loop-map-form |
1329 (list 'cl-map-intervals | |
1330 (list 'function (list 'lambda (list var1 var2) | |
1331 '(progn . --cl-map))) | |
1332 buf prop from to)))) | |
1333 | |
1334 ((memq word key-types) | |
1335 (or (memq (car args) '(in of)) (error "Expected `of'")) | |
800 | 1336 (let* ((map (cl-pop2 args)) |
1337 other-word | |
1338 (other (if (eq (car args) 'using) | |
1339 (if (and (= (length (cadr args)) 2) | |
1340 (memq (setq other-word (caadr args)) | |
1341 key-types) | |
1342 (not (eq (caadr args) word))) | |
1343 (cadr (cl-pop2 args)) | |
1344 (error "Bad `using' clause")) | |
428 | 1345 (gensym)))) |
2153 | 1346 ;; XEmacs addition: track other-word |
800 | 1347 (when (memq word '(key-binding key-bindings)) |
1348 (setq var (prog1 other (setq other var))) | |
1349 (and other-word (setq word other-word))) | |
428 | 1350 (setq loop-map-form |
1351 (list (if (memq word '(key-seq key-seqs)) | |
2153 | 1352 'cl-map-keymap-recursively 'map-keymap) |
428 | 1353 (list 'function (list* 'lambda (list var other) |
1354 '--cl-map)) map)))) | |
1355 | |
1356 ((memq word '(frame frames screen screens)) | |
1357 (let ((temp (gensym))) | |
2153 | 1358 (push (list var '(selected-frame)) |
428 | 1359 loop-for-bindings) |
2153 | 1360 (push (list temp nil) loop-for-bindings) |
1361 (push (list 'prog1 (list 'not (list 'eq var temp)) | |
428 | 1362 (list 'or temp (list 'setq temp var))) |
1363 loop-body) | |
2153 | 1364 (push (list var (list 'next-frame var)) |
428 | 1365 loop-for-steps))) |
1366 | |
1367 ((memq word '(window windows)) | |
1368 (let ((scr (and (memq (car args) '(in of)) (cl-pop2 args))) | |
1369 (temp (gensym))) | |
2153 | 1370 (push (list var (if scr |
428 | 1371 (list 'frame-selected-window scr) |
1372 '(selected-window))) | |
1373 loop-for-bindings) | |
2153 | 1374 (push (list temp nil) loop-for-bindings) |
1375 (push (list 'prog1 (list 'not (list 'eq var temp)) | |
428 | 1376 (list 'or temp (list 'setq temp var))) |
1377 loop-body) | |
2153 | 1378 (push (list var (list 'next-window var)) loop-for-steps))) |
428 | 1379 |
1380 (t | |
1381 (let ((handler (and (symbolp word) | |
1382 (get word 'cl-loop-for-handler)))) | |
1383 (if handler | |
1384 (funcall handler var) | |
1385 (error "Expected a `for' preposition, found %s" word))))) | |
1386 (eq (car args) 'and)) | |
1387 (setq ands t) | |
2153 | 1388 (pop args)) |
428 | 1389 (if (and ands loop-for-bindings) |
2153 | 1390 (push (nreverse loop-for-bindings) loop-bindings) |
428 | 1391 (setq loop-bindings (nconc (mapcar 'list loop-for-bindings) |
1392 loop-bindings))) | |
1393 (if loop-for-sets | |
2153 | 1394 (push (list 'progn |
428 | 1395 (cl-loop-let (nreverse loop-for-sets) 'setq ands) |
1396 t) loop-body)) | |
1397 (if loop-for-steps | |
2153 | 1398 (push (cons (if ands 'psetq 'setq) |
428 | 1399 (apply 'append (nreverse loop-for-steps))) |
1400 loop-steps)))) | |
1401 | |
1402 ((eq word 'repeat) | |
1403 (let ((temp (gensym))) | |
2153 | 1404 (push (list (list temp (pop args))) loop-bindings) |
1405 (push (list '>= (list 'setq temp (list '1- temp)) 0) loop-body))) | |
1406 | |
1407 ((memq word '(collect collecting)) | |
1408 (let ((what (pop args)) | |
428 | 1409 (var (cl-loop-handle-accum nil 'nreverse))) |
1410 (if (eq var loop-accum-var) | |
2153 | 1411 (push (list 'progn (list 'push what var) t) loop-body) |
1412 (push (list 'progn | |
428 | 1413 (list 'setq var (list 'nconc var (list 'list what))) |
1414 t) loop-body)))) | |
1415 | |
1416 ((memq word '(nconc nconcing append appending)) | |
2153 | 1417 (let ((what (pop args)) |
428 | 1418 (var (cl-loop-handle-accum nil 'nreverse))) |
2153 | 1419 (push (list 'progn |
428 | 1420 (list 'setq var |
1421 (if (eq var loop-accum-var) | |
1422 (list 'nconc | |
1423 (list (if (memq word '(nconc nconcing)) | |
1424 'nreverse 'reverse) | |
1425 what) | |
1426 var) | |
1427 (list (if (memq word '(nconc nconcing)) | |
1428 'nconc 'append) | |
1429 var what))) t) loop-body))) | |
1430 | |
1431 ((memq word '(concat concating)) | |
2153 | 1432 (let ((what (pop args)) |
428 | 1433 (var (cl-loop-handle-accum ""))) |
2153 | 1434 (push (list 'progn (list 'callf 'concat var what) t) loop-body))) |
428 | 1435 |
1436 ((memq word '(vconcat vconcating)) | |
2153 | 1437 (let ((what (pop args)) |
428 | 1438 (var (cl-loop-handle-accum []))) |
2153 | 1439 (push (list 'progn (list 'callf 'vconcat var what) t) loop-body))) |
1440 | |
1441 ;; XEmacs addition: handle bit-vectors | |
800 | 1442 ((memq word '(bvconcat bvconcating)) |
2153 | 1443 (let ((what (pop args)) |
800 | 1444 (var (cl-loop-handle-accum #*))) |
2153 | 1445 (push (list 'progn (list 'callf 'bvconcat var what) t) loop-body))) |
800 | 1446 |
428 | 1447 ((memq word '(sum summing)) |
2153 | 1448 (let ((what (pop args)) |
428 | 1449 (var (cl-loop-handle-accum 0))) |
2153 | 1450 (push (list 'progn (list 'incf var what) t) loop-body))) |
428 | 1451 |
1452 ((memq word '(count counting)) | |
2153 | 1453 (let ((what (pop args)) |
428 | 1454 (var (cl-loop-handle-accum 0))) |
2153 | 1455 (push (list 'progn (list 'if what (list 'incf var)) t) loop-body))) |
428 | 1456 |
1457 ((memq word '(minimize minimizing maximize maximizing)) | |
2153 | 1458 (let* ((what (pop args)) |
428 | 1459 (temp (if (cl-simple-expr-p what) what (gensym))) |
1460 (var (cl-loop-handle-accum nil)) | |
1461 (func (intern (substring (symbol-name word) 0 3))) | |
1462 (set (list 'setq var (list 'if var (list func var temp) temp)))) | |
2153 | 1463 (push (list 'progn (if (eq temp what) set |
428 | 1464 (list 'let (list (list temp what)) set)) |
1465 t) loop-body))) | |
1466 | |
1467 ((eq word 'with) | |
1468 (let ((bindings nil)) | |
2153 | 1469 (while (progn (push (list (pop args) |
428 | 1470 (and (eq (car args) '=) (cl-pop2 args))) |
1471 bindings) | |
1472 (eq (car args) 'and)) | |
2153 | 1473 (pop args)) |
1474 (push (nreverse bindings) loop-bindings))) | |
428 | 1475 |
1476 ((eq word 'while) | |
2153 | 1477 (push (pop args) loop-body)) |
428 | 1478 |
1479 ((eq word 'until) | |
2153 | 1480 (push (list 'not (pop args)) loop-body)) |
428 | 1481 |
1482 ((eq word 'always) | |
1483 (or loop-finish-flag (setq loop-finish-flag (gensym))) | |
2153 | 1484 (push (list 'setq loop-finish-flag (pop args)) loop-body) |
428 | 1485 (setq loop-result t)) |
1486 | |
1487 ((eq word 'never) | |
1488 (or loop-finish-flag (setq loop-finish-flag (gensym))) | |
2153 | 1489 (push (list 'setq loop-finish-flag (list 'not (pop args))) |
428 | 1490 loop-body) |
1491 (setq loop-result t)) | |
1492 | |
1493 ((eq word 'thereis) | |
1494 (or loop-finish-flag (setq loop-finish-flag (gensym))) | |
1495 (or loop-result-var (setq loop-result-var (gensym))) | |
2153 | 1496 (push (list 'setq loop-finish-flag |
1497 (list 'not (list 'setq loop-result-var (pop args)))) | |
428 | 1498 loop-body)) |
1499 | |
1500 ((memq word '(if when unless)) | |
2153 | 1501 (let* ((cond (pop args)) |
428 | 1502 (then (let ((loop-body nil)) |
1503 (cl-parse-loop-clause) | |
1504 (cl-loop-build-ands (nreverse loop-body)))) | |
1505 (else (let ((loop-body nil)) | |
1506 (if (eq (car args) 'else) | |
2153 | 1507 (progn (pop args) (cl-parse-loop-clause))) |
428 | 1508 (cl-loop-build-ands (nreverse loop-body)))) |
1509 (simple (and (eq (car then) t) (eq (car else) t)))) | |
2153 | 1510 (if (eq (car args) 'end) (pop args)) |
428 | 1511 (if (eq word 'unless) (setq then (prog1 else (setq else then)))) |
1512 (let ((form (cons (if simple (cons 'progn (nth 1 then)) (nth 2 then)) | |
1513 (if simple (nth 1 else) (list (nth 2 else)))))) | |
1514 (if (cl-expr-contains form 'it) | |
1515 (let ((temp (gensym))) | |
2153 | 1516 (push (list temp) loop-bindings) |
428 | 1517 (setq form (list* 'if (list 'setq temp cond) |
1518 (subst temp 'it form)))) | |
1519 (setq form (list* 'if cond form))) | |
2153 | 1520 (push (if simple (list 'progn form t) form) loop-body)))) |
428 | 1521 |
1522 ((memq word '(do doing)) | |
1523 (let ((body nil)) | |
1524 (or (consp (car args)) (error "Syntax error on `do' clause")) | |
2153 | 1525 (while (consp (car args)) (push (pop args) body)) |
1526 (push (cons 'progn (nreverse (cons t body))) loop-body))) | |
428 | 1527 |
1528 ((eq word 'return) | |
1529 (or loop-finish-flag (setq loop-finish-flag (gensym))) | |
1530 (or loop-result-var (setq loop-result-var (gensym))) | |
2153 | 1531 (push (list 'setq loop-result-var (pop args) |
428 | 1532 loop-finish-flag nil) loop-body)) |
1533 | |
1534 (t | |
1535 (let ((handler (and (symbolp word) (get word 'cl-loop-handler)))) | |
1536 (or handler (error "Expected a loop keyword, found %s" word)) | |
1537 (funcall handler)))) | |
1538 (if (eq (car args) 'and) | |
2153 | 1539 (progn (pop args) (cl-parse-loop-clause))))) |
428 | 1540 |
1541 (defun cl-loop-let (specs body par) ; uses loop-* | |
1542 (let ((p specs) (temps nil) (new nil)) | |
1543 (while (and p (or (symbolp (car-safe (car p))) (null (cadar p)))) | |
1544 (setq p (cdr p))) | |
1545 (and par p | |
1546 (progn | |
1547 (setq par nil p specs) | |
1548 (while p | |
1549 (or (cl-const-expr-p (cadar p)) | |
1550 (let ((temp (gensym))) | |
2153 | 1551 (push (list temp (cadar p)) temps) |
428 | 1552 (setcar (cdar p) temp))) |
1553 (setq p (cdr p))))) | |
1554 (while specs | |
1555 (if (and (consp (car specs)) (listp (caar specs))) | |
1556 (let* ((spec (caar specs)) (nspecs nil) | |
2153 | 1557 (expr (cadr (pop specs))) |
428 | 1558 (temp (cdr (or (assq spec loop-destr-temps) |
2153 | 1559 (car (push (cons spec (or (last spec 0) |
428 | 1560 (gensym))) |
1561 loop-destr-temps)))))) | |
2153 | 1562 (push (list temp expr) new) |
428 | 1563 (while (consp spec) |
2153 | 1564 (push (list (pop spec) |
428 | 1565 (and expr (list (if spec 'pop 'car) temp))) |
1566 nspecs)) | |
1567 (setq specs (nconc (nreverse nspecs) specs))) | |
2153 | 1568 (push (pop specs) new))) |
428 | 1569 (if (eq body 'setq) |
1570 (let ((set (cons (if par 'psetq 'setq) (apply 'nconc (nreverse new))))) | |
1571 (if temps (list 'let* (nreverse temps) set) set)) | |
1572 (list* (if par 'let 'let*) | |
1573 (nconc (nreverse temps) (nreverse new)) body)))) | |
1574 | |
1575 (defun cl-loop-handle-accum (def &optional func) ; uses args, loop-* | |
1576 (if (eq (car args) 'into) | |
1577 (let ((var (cl-pop2 args))) | |
1578 (or (memq var loop-accum-vars) | |
2153 | 1579 (progn (push (list (list var def)) loop-bindings) |
1580 (push var loop-accum-vars))) | |
428 | 1581 var) |
1582 (or loop-accum-var | |
1583 (progn | |
2153 | 1584 (push (list (list (setq loop-accum-var (gensym)) def)) |
428 | 1585 loop-bindings) |
1586 (setq loop-result (if func (list func loop-accum-var) | |
1587 loop-accum-var)) | |
1588 loop-accum-var)))) | |
1589 | |
1590 (defun cl-loop-build-ands (clauses) | |
1591 (let ((ands nil) | |
1592 (body nil)) | |
1593 (while clauses | |
1594 (if (and (eq (car-safe (car clauses)) 'progn) | |
1595 (eq (car (last (car clauses))) t)) | |
1596 (if (cdr clauses) | |
1597 (setq clauses (cons (nconc (butlast (car clauses)) | |
1598 (if (eq (car-safe (cadr clauses)) | |
1599 'progn) | |
1600 (cdadr clauses) | |
1601 (list (cadr clauses)))) | |
1602 (cddr clauses))) | |
2153 | 1603 (setq body (cdr (butlast (pop clauses))))) |
1604 (push (pop clauses) ands))) | |
428 | 1605 (setq ands (or (nreverse ands) (list t))) |
1606 (list (if (cdr ands) (cons 'and ands) (car ands)) | |
1607 body | |
1608 (let ((full (if body | |
1609 (append ands (list (cons 'progn (append body '(t))))) | |
1610 ands))) | |
1611 (if (cdr full) (cons 'and full) (car full)))))) | |
1612 | |
1613 | |
1614 ;;; Other iteration control structures. | |
1615 | |
1616 ;;;###autoload | |
1617 (defmacro do (steps endtest &rest body) | |
1618 "The Common Lisp `do' loop. | |
1619 Format is: (do ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)" | |
1620 (cl-expand-do-loop steps endtest body nil)) | |
1621 | |
1622 ;;;###autoload | |
1623 (defmacro do* (steps endtest &rest body) | |
1624 "The Common Lisp `do*' loop. | |
1625 Format is: (do* ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)" | |
1626 (cl-expand-do-loop steps endtest body t)) | |
1627 | |
1628 (defun cl-expand-do-loop (steps endtest body star) | |
1629 (list 'block nil | |
1630 (list* (if star 'let* 'let) | |
1631 (mapcar #'(lambda (c) (if (consp c) (list (car c) (nth 1 c)) c)) | |
1632 steps) | |
1633 (list* 'while (list 'not (car endtest)) | |
1634 (append body | |
1635 (let ((sets (mapcar | |
1636 #'(lambda (c) | |
1637 (and (consp c) (cdr (cdr c)) | |
1638 (list (car c) (nth 2 c)))) | |
1639 steps))) | |
1640 (setq sets (delq nil sets)) | |
1641 (and sets | |
1642 (list (cons (if (or star (not (cdr sets))) | |
1643 'setq 'psetq) | |
1644 (apply 'append sets))))))) | |
1645 (or (cdr endtest) '(nil))))) | |
1646 | |
1647 ;;;###autoload | |
1648 (defmacro dolist (spec &rest body) | |
1649 "(dolist (VAR LIST [RESULT]) BODY...): loop over a list. | |
1650 Evaluate BODY with VAR bound to each `car' from LIST, in turn. | |
1651 Then evaluate RESULT to get return value, default nil." | |
1652 (let ((temp (gensym "--dolist-temp--"))) | |
1653 (list 'block nil | |
1654 (list* 'let (list (list temp (nth 1 spec)) (car spec)) | |
1655 (list* 'while temp (list 'setq (car spec) (list 'car temp)) | |
1656 (append body (list (list 'setq temp | |
1657 (list 'cdr temp))))) | |
1658 (if (cdr (cdr spec)) | |
1659 (cons (list 'setq (car spec) nil) (cdr (cdr spec))) | |
1660 '(nil)))))) | |
1661 | |
1662 ;;;###autoload | |
1663 (defmacro dotimes (spec &rest body) | |
1664 "(dotimes (VAR COUNT [RESULT]) BODY...): loop a certain number of times. | |
1665 Evaluate BODY with VAR bound to successive integers from 0, inclusive, | |
1666 to COUNT, exclusive. Then evaluate RESULT to get return value, default | |
1667 nil." | |
1668 (let ((temp (gensym "--dotimes-temp--"))) | |
1669 (list 'block nil | |
1670 (list* 'let (list (list temp (nth 1 spec)) (list (car spec) 0)) | |
1671 (list* 'while (list '< (car spec) temp) | |
1672 (append body (list (list 'incf (car spec))))) | |
1673 (or (cdr (cdr spec)) '(nil)))))) | |
1674 | |
1675 ;;;###autoload | |
1676 (defmacro do-symbols (spec &rest body) | |
1677 "(dosymbols (VAR [OBARRAY [RESULT]]) BODY...): loop over all symbols. | |
1678 Evaluate BODY with VAR bound to each interned symbol, or to each symbol | |
1679 from OBARRAY." | |
1680 ;; Apparently this doesn't have an implicit block. | |
1681 (list 'block nil | |
1682 (list 'let (list (car spec)) | |
1683 (list* 'mapatoms | |
1684 (list 'function (list* 'lambda (list (car spec)) body)) | |
1685 (and (cadr spec) (list (cadr spec)))) | |
1686 (caddr spec)))) | |
1687 | |
1688 ;;;###autoload | |
1689 (defmacro do-all-symbols (spec &rest body) | |
1690 (list* 'do-symbols (list (car spec) nil (cadr spec)) body)) | |
1691 | |
1692 | |
1693 ;;; Assignments. | |
1694 | |
1695 ;;;###autoload | |
1696 (defmacro psetq (&rest args) | |
1697 "(psetq SYM VAL SYM VAL ...): set SYMs to the values VALs in parallel. | |
1698 This is like `setq', except that all VAL forms are evaluated (in order) | |
1699 before assigning any symbols SYM to the corresponding values." | |
1700 (cons 'psetf args)) | |
1701 | |
1702 | |
1703 ;;; Binding control structures. | |
1704 | |
1705 ;;;###autoload | |
1706 (defmacro progv (symbols values &rest body) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
1707 "Bind SYMBOLS to VALUES dynamically in BODY. |
428 | 1708 The forms SYMBOLS and VALUES are evaluated, and must evaluate to lists. |
1709 Each SYMBOL in the first list is bound to the corresponding VALUE in the | |
1710 second list (or made unbound if VALUES is shorter than SYMBOLS); then the | |
1711 BODY forms are executed and their result is returned. This is much like | |
1712 a `let' form, except that the list of symbols can be computed at run-time." | |
1713 (list 'let '((cl-progv-save nil)) | |
1714 (list 'unwind-protect | |
1715 (list* 'progn (list 'cl-progv-before symbols values) body) | |
1716 '(cl-progv-after)))) | |
1717 | |
1718 ;;; This should really have some way to shadow 'byte-compile properties, etc. | |
1719 ;;;###autoload | |
1720 (defmacro flet (bindings &rest body) | |
1721 "(flet ((FUNC ARGLIST BODY...) ...) FORM...): make temporary function defns. | |
1722 This is an analogue of `let' that operates on the function cell of FUNC | |
1723 rather than its value cell. The FORMs are evaluated with the specified | |
1724 function definitions in place, then the definitions are undone (the FUNCs | |
1725 go back to their previous definitions, or lack thereof)." | |
1726 (list* 'letf* | |
1727 (mapcar | |
1728 #'(lambda (x) | |
1729 (if (or (and (fboundp (car x)) | |
1730 (eq (car-safe (symbol-function (car x))) 'macro)) | |
1731 (cdr (assq (car x) cl-macro-environment))) | |
1732 (error "Use `labels', not `flet', to rebind macro names")) | |
1733 (let ((func (list 'function* | |
1734 (list 'lambda (cadr x) | |
1735 (list* 'block (car x) (cddr x)))))) | |
1736 (if (and (cl-compiling-file) | |
1737 (boundp 'byte-compile-function-environment)) | |
2153 | 1738 (push (cons (car x) (eval func)) |
428 | 1739 byte-compile-function-environment)) |
1740 (list (list 'symbol-function (list 'quote (car x))) func))) | |
1741 bindings) | |
1742 body)) | |
1743 | |
1744 ;;;###autoload | |
1745 (defmacro labels (bindings &rest body) | |
1746 "(labels ((FUNC ARGLIST BODY...) ...) FORM...): make temporary func bindings. | |
1747 This is like `flet', except the bindings are lexical instead of dynamic. | |
1748 Unlike `flet', this macro is fully compliant with the Common Lisp standard." | |
1749 (let ((vars nil) (sets nil) (cl-macro-environment cl-macro-environment)) | |
1750 (while bindings | |
1751 (let ((var (gensym))) | |
2153 | 1752 (push var vars) |
1753 (push (list 'function* (cons 'lambda (cdar bindings))) sets) | |
1754 (push var sets) | |
1755 (push (list (car (pop bindings)) 'lambda '(&rest cl-labels-args) | |
428 | 1756 (list 'list* '(quote funcall) (list 'quote var) |
1757 'cl-labels-args)) | |
1758 cl-macro-environment))) | |
1759 (cl-macroexpand-all (list* 'lexical-let vars (cons (cons 'setq sets) body)) | |
1760 cl-macro-environment))) | |
1761 | |
1762 ;; The following ought to have a better definition for use with newer | |
1763 ;; byte compilers. | |
1764 ;;;###autoload | |
1765 (defmacro macrolet (bindings &rest body) | |
1766 "(macrolet ((NAME ARGLIST BODY...) ...) FORM...): make temporary macro defns. | |
1767 This is like `flet', but for macros instead of functions." | |
1768 (if (cdr bindings) | |
1769 (list 'macrolet | |
1770 (list (car bindings)) (list* 'macrolet (cdr bindings) body)) | |
1771 (if (null bindings) (cons 'progn body) | |
1772 (let* ((name (caar bindings)) | |
1773 (res (cl-transform-lambda (cdar bindings) name))) | |
1774 (eval (car res)) | |
1775 (cl-macroexpand-all (cons 'progn body) | |
1776 (cons (list* name 'lambda (cdr res)) | |
1777 cl-macro-environment)))))) | |
1778 | |
1779 ;;;###autoload | |
1780 (defmacro symbol-macrolet (bindings &rest body) | |
1781 "(symbol-macrolet ((NAME EXPANSION) ...) FORM...): make symbol macro defns. | |
1782 Within the body FORMs, references to the variable NAME will be replaced | |
1783 by EXPANSION, and (setq NAME ...) will act like (setf EXPANSION ...)." | |
1784 (if (cdr bindings) | |
1785 (list 'symbol-macrolet | |
1786 (list (car bindings)) (list* 'symbol-macrolet (cdr bindings) body)) | |
1787 (if (null bindings) (cons 'progn body) | |
1788 (cl-macroexpand-all (cons 'progn body) | |
1789 (cons (list (symbol-name (caar bindings)) | |
1790 (cadar bindings)) | |
1791 cl-macro-environment))))) | |
1792 | |
1793 (defvar cl-closure-vars nil) | |
1794 ;;;###autoload | |
1795 (defmacro lexical-let (bindings &rest body) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
1796 "Like `let', but lexically scoped. |
428 | 1797 The main visible difference is that lambdas inside BODY will create |
1798 lexical closures as in Common Lisp." | |
1799 (let* ((cl-closure-vars cl-closure-vars) | |
1800 (vars (mapcar #'(lambda (x) | |
1801 (or (consp x) (setq x (list x))) | |
2153 | 1802 (push (gensym (format "--%s--" (car x))) |
428 | 1803 cl-closure-vars) |
2153 | 1804 (set (car cl-closure-vars) [bad-lexical-ref]) |
428 | 1805 (list (car x) (cadr x) (car cl-closure-vars))) |
1806 bindings)) | |
1807 (ebody | |
1808 (cl-macroexpand-all | |
1809 (cons 'progn body) | |
1810 (nconc (mapcar #'(lambda (x) | |
1811 (list (symbol-name (car x)) | |
1812 (list 'symbol-value (caddr x)) | |
1813 t)) | |
1814 vars) | |
1815 (list '(defun . cl-defun-expander)) | |
1816 cl-macro-environment)))) | |
1817 (if (not (get (car (last cl-closure-vars)) 'used)) | |
1818 (list 'let (mapcar #'(lambda (x) (list (caddr x) (cadr x))) vars) | |
1819 (sublis (mapcar #'(lambda (x) | |
1820 (cons (caddr x) (list 'quote (caddr x)))) | |
1821 vars) | |
1822 ebody)) | |
1823 (list 'let (mapcar #'(lambda (x) | |
1824 (list (caddr x) | |
1825 (list 'make-symbol | |
1826 (format "--%s--" (car x))))) | |
1827 vars) | |
1828 (apply 'append '(setf) | |
1829 (mapcar #'(lambda (x) | |
1830 (list (list 'symbol-value (caddr x)) (cadr x))) | |
1831 vars)) | |
1832 ebody)))) | |
1833 | |
1834 ;;;###autoload | |
1835 (defmacro lexical-let* (bindings &rest body) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
1836 "Like `let*', but lexically scoped. |
428 | 1837 The main visible difference is that lambdas inside BODY will create |
1838 lexical closures as in Common Lisp." | |
1839 (if (null bindings) (cons 'progn body) | |
1840 (setq bindings (reverse bindings)) | |
1841 (while bindings | |
2153 | 1842 (setq body (list (list* 'lexical-let (list (pop bindings)) body)))) |
428 | 1843 (car body))) |
1844 | |
1845 (defun cl-defun-expander (func &rest rest) | |
1846 (list 'progn | |
1847 (list 'defalias (list 'quote func) | |
1848 (list 'function (cons 'lambda rest))) | |
1849 (list 'quote func))) | |
1850 | |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1851 ;;; Multiple values. We support full Common Lisp conventions here. |
428 | 1852 |
1853 ;;;###autoload | |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1854 (defmacro multiple-value-bind (syms form &rest body) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1855 "Collect and bind multiple return values. |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1856 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1857 If FORM returns multiple values, each symbol in SYMS is bound to one of |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1858 them, in order, and BODY is executed. If FORM returns fewer multiple values |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1859 than there are SYMS, remaining SYMS are bound to nil. If FORM does |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1860 not return multiple values, it is treated as returning one multiple value. |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1861 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1862 Returns the value given by the last element of BODY." |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1863 (if (null syms) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1864 `(progn ,form ,@body) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1865 (if (= 1 (length syms)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1866 ;; Code written to deal with other "implementations" of multiple |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1867 ;; values may have a one-element SYMS. |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1868 `(let ((,(car syms) ,form)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1869 ,@body) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1870 (let ((temp (gensym))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1871 `(let* ((,temp (multiple-value-list-internal 0 ,(length syms) ,form)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1872 ,@(loop |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1873 for var in syms |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1874 collect `(,var (prog1 (car ,temp) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1875 (setq ,temp (cdr ,temp)))))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1876 ,@body))))) |
428 | 1877 |
1878 ;;;###autoload | |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1879 (defmacro multiple-value-setq (syms form) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1880 "Collect and set multiple values. |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1881 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1882 FORM should normally return multiple values; the first N values are stored |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1883 in the symbols in SYMS in turn. If FORM returns fewer than N values, the |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1884 remaining symbols have their values set to nil. FORM not returning multiple |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1885 values is treated as FORM returning one multiple value, with other elements |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1886 of SYMS initialized to nil. |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1887 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1888 Returns the first of the multiple values given by FORM." |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1889 (if (null syms) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1890 ;; Never return multiple values from multiple-value-setq: |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1891 (and form `(values ,form)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1892 (if (= 1 (length syms)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1893 `(setq ,(car syms) ,form) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1894 (let ((temp (gensym))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1895 `(let* ((,temp (multiple-value-list-internal 0 ,(length syms) ,form))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1896 (setq ,@(loop |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1897 for sym in syms |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1898 nconc `(,sym (car-safe ,temp) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1899 ,temp (cdr-safe ,temp)))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1900 ,(car syms)))))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1901 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1902 ;;;###autoload |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1903 (defmacro multiple-value-list (form) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1904 "Evaluate FORM and return a list of the multiple values it returned." |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1905 `(multiple-value-list-internal 0 multiple-values-limit ,form)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1906 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1907 ;;;###autoload |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1908 (defmacro nth-value (n form) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1909 "Evaluate FORM and return the Nth multiple value it returned." |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1910 (if (integerp n) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1911 `(car (multiple-value-list-internal ,n ,(1+ n) ,form)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1912 (let ((temp (gensym))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1913 `(let ((,temp ,n)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
1914 (car (multiple-value-list-internal ,temp (1+ ,temp) ,form)))))) |
428 | 1915 |
1916 ;;; Declarations. | |
1917 | |
1918 ;;;###autoload | |
1919 (defmacro locally (&rest body) (cons 'progn body)) | |
1920 ;;;###autoload | |
1921 (defmacro the (type form) form) | |
1922 | |
1923 (defvar cl-proclaim-history t) ; for future compilers | |
1924 (defvar cl-declare-stack t) ; for future compilers | |
1925 | |
1926 (defun cl-do-proclaim (spec hist) | |
2153 | 1927 (and hist (listp cl-proclaim-history) (push spec cl-proclaim-history)) |
428 | 1928 (cond ((eq (car-safe spec) 'special) |
1929 (if (boundp 'byte-compile-bound-variables) | |
1930 (setq byte-compile-bound-variables | |
442 | 1931 (append |
2153 | 1932 ;; XEmacs change |
442 | 1933 (mapcar #'(lambda (v) (cons v byte-compile-global-bit)) |
1934 (cdr spec)) | |
1935 byte-compile-bound-variables)))) | |
428 | 1936 |
1937 ((eq (car-safe spec) 'inline) | |
1938 (while (setq spec (cdr spec)) | |
1939 (or (memq (get (car spec) 'byte-optimizer) | |
1940 '(nil byte-compile-inline-expand)) | |
1941 (error "%s already has a byte-optimizer, can't make it inline" | |
1942 (car spec))) | |
1943 (put (car spec) 'byte-optimizer 'byte-compile-inline-expand))) | |
1944 | |
1945 ((eq (car-safe spec) 'notinline) | |
1946 (while (setq spec (cdr spec)) | |
1947 (if (eq (get (car spec) 'byte-optimizer) | |
1948 'byte-compile-inline-expand) | |
1949 (put (car spec) 'byte-optimizer nil)))) | |
1950 | |
1951 ((eq (car-safe spec) 'optimize) | |
1952 (let ((speed (assq (nth 1 (assq 'speed (cdr spec))) | |
446 | 1953 '((0 . nil) (1 . t) (2 . t) (3 . t)))) |
428 | 1954 (safety (assq (nth 1 (assq 'safety (cdr spec))) |
446 | 1955 '((0 . t) (1 . t) (2 . t) (3 . nil))))) |
1956 (when speed | |
1957 (setq cl-optimize-speed (car speed) | |
1958 byte-optimize (cdr speed))) | |
1959 (when safety | |
1960 (setq cl-optimize-safety (car safety) | |
1961 byte-compile-delete-errors (cdr safety))))) | |
428 | 1962 |
1963 ((and (eq (car-safe spec) 'warn) (boundp 'byte-compile-warnings)) | |
1964 (if (eq byte-compile-warnings t) | |
1965 ;; XEmacs change | |
1966 (setq byte-compile-warnings byte-compile-default-warnings)) | |
1967 (while (setq spec (cdr spec)) | |
1968 (if (consp (car spec)) | |
1969 (if (eq (cadar spec) 0) | |
1970 (setq byte-compile-warnings | |
1971 (delq (caar spec) byte-compile-warnings)) | |
1972 (setq byte-compile-warnings | |
1973 (adjoin (caar spec) byte-compile-warnings))))))) | |
1974 nil) | |
1975 | |
1976 ;;; Process any proclamations made before cl-macs was loaded. | |
1977 (defvar cl-proclaims-deferred) | |
1978 (let ((p (reverse cl-proclaims-deferred))) | |
2153 | 1979 (while p (cl-do-proclaim (pop p) t)) |
428 | 1980 (setq cl-proclaims-deferred nil)) |
1981 | |
1982 ;;;###autoload | |
1983 (defmacro declare (&rest specs) | |
1984 (if (cl-compiling-file) | |
1985 (while specs | |
2153 | 1986 (if (listp cl-declare-stack) (push (car specs) cl-declare-stack)) |
1987 (cl-do-proclaim (pop specs) nil))) | |
428 | 1988 nil) |
1989 | |
1990 | |
1991 | |
1992 ;;; Generalized variables. | |
1993 | |
1994 ;;;###autoload | |
1995 (defmacro define-setf-method (func args &rest body) | |
1996 "(define-setf-method NAME ARGLIST BODY...): define a `setf' method. | |
1997 This method shows how to handle `setf's to places of the form (NAME ARGS...). | |
1998 The argument forms ARGS are bound according to ARGLIST, as if NAME were | |
1999 going to be expanded as a macro, then the BODY forms are executed and must | |
2000 return a list of five elements: a temporary-variables list, a value-forms | |
2001 list, a store-variables list (of length one), a store-form, and an access- | |
2002 form. See `defsetf' for a simpler way to define most setf-methods." | |
2003 (append '(eval-when (compile load eval)) | |
2004 (if (stringp (car body)) | |
2005 (list (list 'put (list 'quote func) '(quote setf-documentation) | |
2153 | 2006 (pop body)))) |
428 | 2007 (list (cl-transform-function-property |
2008 func 'setf-method (cons args body))))) | |
2153 | 2009 (defalias 'define-setf-expander 'define-setf-method) |
428 | 2010 |
2011 ;;;###autoload | |
2012 (defmacro defsetf (func arg1 &rest args) | |
2013 "(defsetf NAME FUNC): define a `setf' method. | |
2014 This macro is an easy-to-use substitute for `define-setf-method' that works | |
2015 well for simple place forms. In the simple `defsetf' form, `setf's of | |
2016 the form (setf (NAME ARGS...) VAL) are transformed to function or macro | |
2017 calls of the form (FUNC ARGS... VAL). Example: (defsetf aref aset). | |
2018 Alternate form: (defsetf NAME ARGLIST (STORE) BODY...). | |
2019 Here, the above `setf' call is expanded by binding the argument forms ARGS | |
2020 according to ARGLIST, binding the value form VAL to STORE, then executing | |
2021 BODY, which must return a Lisp form that does the necessary `setf' operation. | |
2022 Actually, ARGLIST and STORE may be bound to temporary variables which are | |
2023 introduced automatically to preserve proper execution order of the arguments. | |
2024 Example: (defsetf nth (n x) (v) (list 'setcar (list 'nthcdr n x) v))." | |
2025 (if (listp arg1) | |
2026 (let* ((largs nil) (largsr nil) | |
2027 (temps nil) (tempsr nil) | |
2028 (restarg nil) (rest-temps nil) | |
2029 (store-var (car (prog1 (car args) (setq args (cdr args))))) | |
2030 (store-temp (intern (format "--%s--temp--" store-var))) | |
2031 (lets1 nil) (lets2 nil) | |
2032 (docstr nil) (p arg1)) | |
2033 (if (stringp (car args)) | |
2034 (setq docstr (prog1 (car args) (setq args (cdr args))))) | |
2035 (while (and p (not (eq (car p) '&aux))) | |
2036 (if (eq (car p) '&rest) | |
2037 (setq p (cdr p) restarg (car p)) | |
2038 (or (memq (car p) '(&optional &key &allow-other-keys)) | |
2039 (setq largs (cons (if (consp (car p)) (car (car p)) (car p)) | |
2040 largs) | |
2041 temps (cons (intern (format "--%s--temp--" (car largs))) | |
2042 temps)))) | |
2043 (setq p (cdr p))) | |
2044 (setq largs (nreverse largs) temps (nreverse temps)) | |
2045 (if restarg | |
2046 (setq largsr (append largs (list restarg)) | |
2047 rest-temps (intern (format "--%s--temp--" restarg)) | |
2048 tempsr (append temps (list rest-temps))) | |
2049 (setq largsr largs tempsr temps)) | |
2050 (let ((p1 largs) (p2 temps)) | |
2051 (while p1 | |
2052 (setq lets1 (cons (list (car p2) | |
2053 (list 'gensym (format "--%s--" (car p1)))) | |
2054 lets1) | |
2055 lets2 (cons (list (car p1) (car p2)) lets2) | |
2056 p1 (cdr p1) p2 (cdr p2)))) | |
2057 (if restarg (setq lets2 (cons (list restarg rest-temps) lets2))) | |
2058 (append (list 'define-setf-method func arg1) | |
2059 (and docstr (list docstr)) | |
2060 (list | |
2061 (list 'let* | |
2062 (nreverse | |
2063 (cons (list store-temp | |
2064 (list 'gensym (format "--%s--" store-var))) | |
2065 (if restarg | |
2066 (append | |
2067 (list | |
2068 (list rest-temps | |
2069 (list 'mapcar '(quote gensym) | |
2070 restarg))) | |
2071 lets1) | |
2072 lets1))) | |
2073 (list 'list ; 'values | |
2074 (cons (if restarg 'list* 'list) tempsr) | |
2075 (cons (if restarg 'list* 'list) largsr) | |
2076 (list 'list store-temp) | |
2077 (cons 'let* | |
2078 (cons (nreverse | |
2079 (cons (list store-var store-temp) | |
2080 lets2)) | |
2081 args)) | |
2082 (cons (if restarg 'list* 'list) | |
2083 (cons (list 'quote func) tempsr))))))) | |
2084 (list 'defsetf func '(&rest args) '(store) | |
2085 (let ((call (list 'cons (list 'quote arg1) | |
2086 '(append args (list store))))) | |
2087 (if (car args) | |
2088 (list 'list '(quote progn) call 'store) | |
2089 call))))) | |
2090 | |
2091 ;;; Some standard place types from Common Lisp. | |
2153 | 2092 (eval-when-compile (defvar ignored-arg)) ; XEmacs: warning suppression |
428 | 2093 (defsetf aref aset) |
2094 (defsetf car setcar) | |
2095 (defsetf cdr setcdr) | |
2153 | 2096 (defsetf caar (x) (val) (list 'setcar (list 'car x) val)) |
2097 (defsetf cadr (x) (val) (list 'setcar (list 'cdr x) val)) | |
2098 (defsetf cdar (x) (val) (list 'setcdr (list 'car x) val)) | |
2099 (defsetf cddr (x) (val) (list 'setcdr (list 'cdr x) val)) | |
428 | 2100 (defsetf elt (seq n) (store) |
2101 (list 'if (list 'listp seq) (list 'setcar (list 'nthcdr n seq) store) | |
2102 (list 'aset seq n store))) | |
2153 | 2103 ;; XEmacs change: ignore the optional DEFAULT arguments |
428 | 2104 (defsetf get (x y &optional ignored-arg) (store) (list 'put x y store)) |
2105 (defsetf get* (x y &optional ignored-arg) (store) (list 'put x y store)) | |
2153 | 2106 (defsetf gethash (x h &optional ignored-arg) (store) (list 'puthash x store h)) |
428 | 2107 (defsetf nth (n x) (store) (list 'setcar (list 'nthcdr n x) store)) |
2108 (defsetf subseq (seq start &optional end) (new) | |
2153 | 2109 (list 'progn (list 'replace seq new :start1 start :end1 end) new)) |
428 | 2110 (defsetf symbol-function fset) |
2111 (defsetf symbol-plist setplist) | |
2112 (defsetf symbol-value set) | |
2113 | |
2114 ;;; Various car/cdr aliases. Note that `cadr' is handled specially. | |
2115 (defsetf first setcar) | |
2116 (defsetf second (x) (store) (list 'setcar (list 'cdr x) store)) | |
2117 (defsetf third (x) (store) (list 'setcar (list 'cddr x) store)) | |
2118 (defsetf fourth (x) (store) (list 'setcar (list 'cdddr x) store)) | |
2119 (defsetf fifth (x) (store) (list 'setcar (list 'nthcdr 4 x) store)) | |
2120 (defsetf sixth (x) (store) (list 'setcar (list 'nthcdr 5 x) store)) | |
2121 (defsetf seventh (x) (store) (list 'setcar (list 'nthcdr 6 x) store)) | |
2122 (defsetf eighth (x) (store) (list 'setcar (list 'nthcdr 7 x) store)) | |
2123 (defsetf ninth (x) (store) (list 'setcar (list 'nthcdr 8 x) store)) | |
2124 (defsetf tenth (x) (store) (list 'setcar (list 'nthcdr 9 x) store)) | |
2125 (defsetf rest setcdr) | |
2126 | |
2127 ;;; Some more Emacs-related place types. | |
2128 (defsetf buffer-file-name set-visited-file-name t) | |
2153 | 2129 ;; XEmacs change: we do not need to wrap this in with-current-buffer |
428 | 2130 (defsetf buffer-modified-p set-buffer-modified-p t) |
2131 (defsetf buffer-name rename-buffer t) | |
2132 (defsetf buffer-string () (store) | |
2133 (list 'progn '(erase-buffer) (list 'insert store))) | |
2134 (defsetf buffer-substring cl-set-buffer-substring) | |
2135 (defsetf current-buffer set-buffer) | |
2136 (defsetf current-case-table set-case-table) | |
2137 (defsetf current-column move-to-column t) | |
2138 (defsetf current-global-map use-global-map t) | |
2139 (defsetf current-input-mode () (store) | |
2140 (list 'progn (list 'apply 'set-input-mode store) store)) | |
2141 (defsetf current-local-map use-local-map t) | |
2142 (defsetf current-window-configuration set-window-configuration t) | |
2143 (defsetf default-file-modes set-default-file-modes t) | |
2144 (defsetf default-value set-default) | |
2145 (defsetf documentation-property put) | |
2153 | 2146 ;;(defsetf extent-data set-extent-data) |
428 | 2147 (defsetf extent-face set-extent-face) |
2148 (defsetf extent-priority set-extent-priority) | |
2153 | 2149 ;; XEmacs addition |
428 | 2150 (defsetf extent-property (x y &optional ignored-arg) (arg) |
2151 (list 'set-extent-property x y arg)) | |
2153 | 2152 (defsetf extent-end-position (ext) (store) |
2153 `(progn (set-extent-endpoints ,ext (extent-start-position ,ext) ,store) | |
2154 ,store)) | |
428 | 2155 (defsetf extent-start-position (ext) (store) |
2156 `(progn (set-extent-endpoints ,ext ,store (extent-end-position ,ext)) | |
2157 ,store)) | |
2158 (defsetf face-background (f &optional s) (x) (list 'set-face-background f x s)) | |
2159 (defsetf face-background-pixmap (f &optional s) (x) | |
2160 (list 'set-face-background-pixmap f x s)) | |
2161 (defsetf face-font (f &optional s) (x) (list 'set-face-font f x s)) | |
2162 (defsetf face-foreground (f &optional s) (x) (list 'set-face-foreground f x s)) | |
2163 (defsetf face-underline-p (f &optional s) (x) | |
2164 (list 'set-face-underline-p f x s)) | |
2165 (defsetf file-modes set-file-modes t) | |
2153 | 2166 (defsetf frame-height (&optional f) (v) |
2167 `(progn (set-frame-height ,f ,v) ,v)) | |
428 | 2168 (defsetf frame-parameters modify-frame-parameters t) |
2169 (defsetf frame-visible-p cl-set-frame-visible-p) | |
2153 | 2170 (defsetf frame-width (&optional f) (v) |
2171 `(progn (set-frame-width ,f ,v) ,v)) | |
2172 ;; XEmacs change: frame-properties instead of frame-parameters | |
428 | 2173 (defsetf frame-properties (&optional f) (p) |
2174 `(progn (set-frame-properties ,f ,p) ,p)) | |
2175 (defsetf frame-property (f p &optional ignored-arg) (v) | |
2176 `(progn (set-frame-property ,f ,v) ,p)) | |
2153 | 2177 ;; XEmacs addition |
428 | 2178 (defsetf current-frame-configuration set-frame-configuration) |
2179 | |
2180 ;; XEmacs: new stuff | |
2181 ;; Consoles | |
2182 (defsetf selected-console select-console t) | |
2183 (defsetf selected-device select-device t) | |
2184 (defsetf device-baud-rate (&optional d) (v) | |
2185 `(set-device-baud-rate ,d ,v)) | |
2186 ;; This setf method is a bad idea, because set-specifier *adds* a | |
2187 ;; specification, rather than just setting it. The net effect is that | |
2188 ;; it makes specifier-instance return VAL, but other things don't work | |
2189 ;; as expected -- letf, to name one. | |
2190 ;(defsetf specifier-instance (spec &optional dom def nof) (val) | |
2191 ; `(set-specifier ,spec ,val ,dom)) | |
2192 | |
2193 ;; Annotations | |
2194 (defsetf annotation-glyph set-annotation-glyph) | |
2195 (defsetf annotation-down-glyph set-annotation-down-glyph) | |
2196 (defsetf annotation-face set-annotation-face) | |
2197 (defsetf annotation-layout set-annotation-layout) | |
2198 (defsetf annotation-data set-annotation-data) | |
2199 (defsetf annotation-action set-annotation-action) | |
2200 (defsetf annotation-menu set-annotation-menu) | |
2201 ;; Widget | |
2202 (defsetf widget-get widget-put t) | |
2203 (defsetf widget-value widget-value-set t) | |
2204 | |
2205 ;; Misc | |
2206 (defsetf recent-keys-ring-size set-recent-keys-ring-size) | |
2207 (defsetf symbol-value-in-buffer (s b &optional ignored-arg) (store) | |
2208 `(with-current-buffer ,b (set ,s ,store))) | |
2209 (defsetf symbol-value-in-console (s c &optional ignored-arg) (store) | |
2210 `(letf (((selected-console) ,c)) | |
2211 (set ,s ,store))) | |
2212 | |
2213 (defsetf buffer-dedicated-frame (&optional b) (v) | |
2214 `(set-buffer-dedicated-frame ,b ,v)) | |
2215 (defsetf console-type-image-conversion-list | |
2216 set-console-type-image-conversion-list) | |
2217 (defsetf default-toolbar-position set-default-toolbar-position) | |
2218 (defsetf device-class (&optional d) (v) | |
2219 `(set-device-class ,d ,v)) | |
2220 (defsetf extent-begin-glyph set-extent-begin-glyph) | |
2221 (defsetf extent-begin-glyph-layout set-extent-begin-glyph-layout) | |
2222 (defsetf extent-end-glyph set-extent-end-glyph) | |
2223 (defsetf extent-end-glyph-layout set-extent-end-glyph-layout) | |
2224 (defsetf extent-keymap set-extent-keymap) | |
2225 (defsetf extent-parent set-extent-parent) | |
2226 (defsetf extent-properties set-extent-properties) | |
2227 ;; Avoid adding various face and glyph functions. | |
2228 (defsetf frame-selected-window (&optional f) (v) | |
2229 `(set-frame-selected-window ,f ,v)) | |
2230 (defsetf glyph-image (glyph &optional domain) (i) | |
2231 (list 'set-glyph-image glyph i domain)) | |
2232 (defsetf itimer-function set-itimer-function) | |
2233 (defsetf itimer-function-arguments set-itimer-function-arguments) | |
2234 (defsetf itimer-is-idle set-itimer-is-idle) | |
2235 (defsetf itimer-recorded-run-time set-itimer-recorded-run-time) | |
2236 (defsetf itimer-restart set-itimer-restart) | |
2237 (defsetf itimer-uses-arguments set-itimer-uses-arguments) | |
2238 (defsetf itimer-value set-itimer-value) | |
2239 (defsetf keymap-parents set-keymap-parents) | |
2240 (defsetf marker-insertion-type set-marker-insertion-type) | |
2241 (defsetf mouse-pixel-position (&optional d) (v) | |
2242 `(progn | |
2243 (set-mouse-pixel-position ,d ,(car v) ,(car (cdr v)) ,(cdr (cdr v))) | |
2244 ,v)) | |
2245 (defsetf trunc-stack-length set-trunc-stack-length) | |
2246 (defsetf trunc-stack-stack set-trunc-stack-stack) | |
2247 (defsetf undoable-stack-max set-undoable-stack-max) | |
2248 (defsetf weak-list-list set-weak-list-list) | |
2153 | 2249 ;; End of new XEmacs stuff |
428 | 2250 |
2251 (defsetf getenv setenv t) | |
2252 (defsetf get-register set-register) | |
2253 (defsetf global-key-binding global-set-key) | |
2254 (defsetf keymap-parent set-keymap-parent) | |
2153 | 2255 ;; XEmacs addition: more keymap-related setf forms |
428 | 2256 (defsetf keymap-name set-keymap-name) |
2257 (defsetf keymap-prompt set-keymap-prompt) | |
2258 (defsetf keymap-default-binding set-keymap-default-binding) | |
2259 (defsetf local-key-binding local-set-key) | |
2260 (defsetf mark set-mark t) | |
2261 (defsetf mark-marker set-mark t) | |
2262 (defsetf marker-position set-marker t) | |
2263 (defsetf match-data store-match-data t) | |
2264 (defsetf mouse-position (scr) (store) | |
2265 (list 'set-mouse-position scr (list 'car store) (list 'cadr store) | |
2266 (list 'cddr store))) | |
2267 (defsetf overlay-get overlay-put) | |
2268 (defsetf overlay-start (ov) (store) | |
2269 (list 'progn (list 'move-overlay ov store (list 'overlay-end ov)) store)) | |
2270 (defsetf overlay-end (ov) (store) | |
2271 (list 'progn (list 'move-overlay ov (list 'overlay-start ov) store) store)) | |
2272 (defsetf point goto-char) | |
2273 (defsetf point-marker goto-char t) | |
2274 (defsetf point-max () (store) | |
2275 (list 'progn (list 'narrow-to-region '(point-min) store) store)) | |
2276 (defsetf point-min () (store) | |
2277 (list 'progn (list 'narrow-to-region store '(point-max)) store)) | |
2278 (defsetf process-buffer set-process-buffer) | |
2279 (defsetf process-filter set-process-filter) | |
2280 (defsetf process-sentinel set-process-sentinel) | |
2153 | 2281 ;;(defsetf process-get process-put) |
428 | 2282 (defsetf read-mouse-position (scr) (store) |
2283 (list 'set-mouse-position scr (list 'car store) (list 'cdr store))) | |
2153 | 2284 ;;(defsetf screen-height set-screen-height t) |
2285 ;;(defsetf screen-width set-screen-width t) | |
428 | 2286 (defsetf selected-window select-window) |
2153 | 2287 ;;(defsetf selected-screen select-screen) |
428 | 2288 (defsetf selected-frame select-frame) |
2289 (defsetf standard-case-table set-standard-case-table) | |
2290 (defsetf syntax-table set-syntax-table) | |
2291 (defsetf visited-file-modtime set-visited-file-modtime t) | |
2292 (defsetf window-buffer set-window-buffer t) | |
2293 (defsetf window-display-table set-window-display-table t) | |
2294 (defsetf window-dedicated-p set-window-dedicated-p t) | |
2295 (defsetf window-height (&optional window) (store) | |
2296 `(progn (enlarge-window (- ,store (window-height)) nil ,window) ,store)) | |
2297 (defsetf window-hscroll set-window-hscroll) | |
2298 (defsetf window-point set-window-point) | |
2299 (defsetf window-start set-window-start) | |
2300 (defsetf window-width (&optional window) (store) | |
2301 `(progn (enlarge-window (- ,store (window-width)) t ,window) ,store)) | |
2302 (defsetf x-get-cutbuffer x-store-cutbuffer t) | |
2303 (defsetf x-get-cut-buffer x-store-cut-buffer t) ; groan. | |
2304 (defsetf x-get-secondary-selection x-own-secondary-selection t) | |
2305 (defsetf x-get-selection x-own-selection t) | |
442 | 2306 (defsetf get-selection own-selection t) |
428 | 2307 |
2308 ;;; More complex setf-methods. | |
2309 ;;; These should take &environment arguments, but since full arglists aren't | |
2310 ;;; available while compiling cl-macs, we fake it by referring to the global | |
2311 ;;; variable cl-macro-environment directly. | |
2312 | |
2313 (define-setf-method apply (func arg1 &rest rest) | |
2314 (or (and (memq (car-safe func) '(quote function function*)) | |
2315 (symbolp (car-safe (cdr-safe func)))) | |
2316 (error "First arg to apply in setf is not (function SYM): %s" func)) | |
2317 (let* ((form (cons (nth 1 func) (cons arg1 rest))) | |
2318 (method (get-setf-method form cl-macro-environment))) | |
2319 (list (car method) (nth 1 method) (nth 2 method) | |
2320 (cl-setf-make-apply (nth 3 method) (cadr func) (car method)) | |
2321 (cl-setf-make-apply (nth 4 method) (cadr func) (car method))))) | |
2322 | |
2323 (defun cl-setf-make-apply (form func temps) | |
2324 (if (eq (car form) 'progn) | |
2325 (list* 'progn (cl-setf-make-apply (cadr form) func temps) (cddr form)) | |
2326 (or (equal (last form) (last temps)) | |
2327 (error "%s is not suitable for use with setf-of-apply" func)) | |
2328 (list* 'apply (list 'quote (car form)) (cdr form)))) | |
2329 | |
2330 (define-setf-method nthcdr (n place) | |
2331 (let ((method (get-setf-method place cl-macro-environment)) | |
2332 (n-temp (gensym "--nthcdr-n--")) | |
2333 (store-temp (gensym "--nthcdr-store--"))) | |
2334 (list (cons n-temp (car method)) | |
2335 (cons n (nth 1 method)) | |
2336 (list store-temp) | |
2337 (list 'let (list (list (car (nth 2 method)) | |
2338 (list 'cl-set-nthcdr n-temp (nth 4 method) | |
2339 store-temp))) | |
2340 (nth 3 method) store-temp) | |
2341 (list 'nthcdr n-temp (nth 4 method))))) | |
2342 | |
2343 (define-setf-method getf (place tag &optional def) | |
2344 (let ((method (get-setf-method place cl-macro-environment)) | |
2345 (tag-temp (gensym "--getf-tag--")) | |
2346 (def-temp (gensym "--getf-def--")) | |
2347 (store-temp (gensym "--getf-store--"))) | |
2348 (list (append (car method) (list tag-temp def-temp)) | |
2349 (append (nth 1 method) (list tag def)) | |
2350 (list store-temp) | |
2351 (list 'let (list (list (car (nth 2 method)) | |
2352 (list 'cl-set-getf (nth 4 method) | |
2353 tag-temp store-temp))) | |
2354 (nth 3 method) store-temp) | |
2355 (list 'getf (nth 4 method) tag-temp def-temp)))) | |
2356 | |
2357 (define-setf-method substring (place from &optional to) | |
2358 (let ((method (get-setf-method place cl-macro-environment)) | |
2359 (from-temp (gensym "--substring-from--")) | |
2360 (to-temp (gensym "--substring-to--")) | |
2361 (store-temp (gensym "--substring-store--"))) | |
2362 (list (append (car method) (list from-temp to-temp)) | |
2363 (append (nth 1 method) (list from to)) | |
2364 (list store-temp) | |
2365 (list 'let (list (list (car (nth 2 method)) | |
2366 (list 'cl-set-substring (nth 4 method) | |
2367 from-temp to-temp store-temp))) | |
2368 (nth 3 method) store-temp) | |
2369 (list 'substring (nth 4 method) from-temp to-temp)))) | |
2370 | |
2153 | 2371 ;; XEmacs addition |
428 | 2372 (define-setf-method values (&rest args) |
2373 (let ((methods (mapcar #'(lambda (x) | |
2374 (get-setf-method x cl-macro-environment)) | |
2375 args)) | |
2376 (store-temp (gensym "--values-store--"))) | |
2377 (list (apply 'append (mapcar 'first methods)) | |
2378 (apply 'append (mapcar 'second methods)) | |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2379 `((,store-temp |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2380 (multiple-value-list-internal 0 ,(if args (length args) 1)))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2381 (cons 'values |
428 | 2382 (mapcar #'(lambda (m) |
2383 (cl-setf-do-store (cons (car (third m)) (fourth m)) | |
2384 (list 'pop store-temp))) | |
2385 methods)) | |
2386 (cons 'list (mapcar 'fifth methods))))) | |
2387 | |
2388 ;;; Getting and optimizing setf-methods. | |
2389 ;;;###autoload | |
2390 (defun get-setf-method (place &optional env) | |
2391 "Return a list of five values describing the setf-method for PLACE. | |
2392 PLACE may be any Lisp form which can appear as the PLACE argument to | |
2393 a macro like `setf' or `incf'." | |
2394 (if (symbolp place) | |
2395 (let ((temp (gensym "--setf--"))) | |
2396 (list nil nil (list temp) (list 'setq place temp) place)) | |
2397 (or (and (symbolp (car place)) | |
2398 (let* ((func (car place)) | |
2399 (name (symbol-name func)) | |
2400 (method (get func 'setf-method)) | |
2401 (case-fold-search nil)) | |
2402 (or (and method | |
2403 (let ((cl-macro-environment env)) | |
2404 (setq method (apply method (cdr place)))) | |
2405 (if (and (consp method) (= (length method) 5)) | |
2406 method | |
2407 (error "Setf-method for %s returns malformed method" | |
2408 func))) | |
2409 (and (save-match-data | |
2410 (string-match "\\`c[ad][ad][ad]?[ad]?r\\'" name)) | |
2411 (get-setf-method (compiler-macroexpand place))) | |
2412 (and (eq func 'edebug-after) | |
2413 (get-setf-method (nth (1- (length place)) place) | |
2414 env))))) | |
2415 (if (eq place (setq place (macroexpand place env))) | |
2416 (if (and (symbolp (car place)) (fboundp (car place)) | |
2417 (symbolp (symbol-function (car place)))) | |
2418 (get-setf-method (cons (symbol-function (car place)) | |
2419 (cdr place)) env) | |
2420 (error "No setf-method known for %s" (car place))) | |
2421 (get-setf-method place env))))) | |
2422 | |
2423 (defun cl-setf-do-modify (place opt-expr) | |
2424 (let* ((method (get-setf-method place cl-macro-environment)) | |
2425 (temps (car method)) (values (nth 1 method)) | |
2426 (lets nil) (subs nil) | |
2427 (optimize (and (not (eq opt-expr 'no-opt)) | |
2428 (or (and (not (eq opt-expr 'unsafe)) | |
2429 (cl-safe-expr-p opt-expr)) | |
2430 (cl-setf-simple-store-p (car (nth 2 method)) | |
2431 (nth 3 method))))) | |
2432 (simple (and optimize (consp place) (cl-simple-exprs-p (cdr place))))) | |
2433 (while values | |
2434 (if (or simple (cl-const-expr-p (car values))) | |
2153 | 2435 (push (cons (pop temps) (pop values)) subs) |
2436 (push (list (pop temps) (pop values)) lets))) | |
428 | 2437 (list (nreverse lets) |
2438 (cons (car (nth 2 method)) (sublis subs (nth 3 method))) | |
2439 (sublis subs (nth 4 method))))) | |
2440 | |
2441 (defun cl-setf-do-store (spec val) | |
2442 (let ((sym (car spec)) | |
2443 (form (cdr spec))) | |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2444 (if (consp sym) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2445 ;; XEmacs change, only used for implementing #'values at the moment. |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2446 (let* ((orig (copy-list sym)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2447 (intermediate (last orig)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2448 (circular-limit 32)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2449 (while (consp (car intermediate)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2450 (when (zerop circular-limit) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2451 (error 'circular-list "Form seems to contain loops")) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2452 (setq intermediate (last (car intermediate)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2453 circular-limit (1- circular-limit))) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2454 (setcdr intermediate (list val)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2455 `(let (,orig) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2456 ,form)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2457 (if (or (cl-const-expr-p val) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2458 (and (cl-simple-expr-p val) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2459 (eq (cl-expr-contains form sym) 1)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2460 (cl-setf-simple-store-p sym form)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2461 (subst val sym form) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
2462 (list 'let (list (list sym val)) form))))) |
428 | 2463 |
2464 (defun cl-setf-simple-store-p (sym form) | |
2465 (and (consp form) (eq (cl-expr-contains form sym) 1) | |
2466 (eq (nth (1- (length form)) form) sym) | |
2467 (symbolp (car form)) (fboundp (car form)) | |
2468 (not (eq (car-safe (symbol-function (car form))) 'macro)))) | |
2469 | |
2470 ;;; The standard modify macros. | |
2471 ;;;###autoload | |
2472 (defmacro setf (&rest args) | |
2473 "(setf PLACE VAL PLACE VAL ...): set each PLACE to the value of its VAL. | |
2474 This is a generalized version of `setq'; the PLACEs may be symbolic | |
2475 references such as (car x) or (aref x i), as well as plain symbols. | |
2476 For example, (setf (cadar x) y) is equivalent to (setcar (cdar x) y). | |
2477 The return value is the last VAL in the list." | |
2478 (if (cdr (cdr args)) | |
2479 (let ((sets nil)) | |
2153 | 2480 (while args (push (list 'setf (pop args) (pop args)) sets)) |
428 | 2481 (cons 'progn (nreverse sets))) |
2482 (if (symbolp (car args)) | |
2483 (and args (cons 'setq args)) | |
2484 (let* ((method (cl-setf-do-modify (car args) (nth 1 args))) | |
2485 (store (cl-setf-do-store (nth 1 method) (nth 1 args)))) | |
2486 (if (car method) (list 'let* (car method) store) store))))) | |
2487 | |
2488 ;;;###autoload | |
2489 (defmacro psetf (&rest args) | |
2490 "(psetf PLACE VAL PLACE VAL ...): set PLACEs to the values VALs in parallel. | |
2491 This is like `setf', except that all VAL forms are evaluated (in order) | |
2492 before assigning any PLACEs to the corresponding values." | |
2493 (let ((p args) (simple t) (vars nil)) | |
2494 (while p | |
2495 (if (or (not (symbolp (car p))) (cl-expr-depends-p (nth 1 p) vars)) | |
2496 (setq simple nil)) | |
2497 (if (memq (car p) vars) | |
2498 (error "Destination duplicated in psetf: %s" (car p))) | |
2153 | 2499 (push (pop p) vars) |
428 | 2500 (or p (error "Odd number of arguments to psetf")) |
2153 | 2501 (pop p)) |
428 | 2502 (if simple |
2503 (list 'progn (cons 'setf args) nil) | |
2504 (setq args (reverse args)) | |
2505 (let ((expr (list 'setf (cadr args) (car args)))) | |
2506 (while (setq args (cddr args)) | |
2507 (setq expr (list 'setf (cadr args) (list 'prog1 (car args) expr)))) | |
2508 (list 'progn expr nil))))) | |
2509 | |
2510 ;;;###autoload | |
2511 (defun cl-do-pop (place) | |
2512 (if (cl-simple-expr-p place) | |
2513 (list 'prog1 (list 'car place) (list 'setf place (list 'cdr place))) | |
2514 (let* ((method (cl-setf-do-modify place t)) | |
2515 (temp (gensym "--pop--"))) | |
2516 (list 'let* | |
2517 (append (car method) | |
2518 (list (list temp (nth 2 method)))) | |
2519 (list 'prog1 | |
2520 (list 'car temp) | |
2521 (cl-setf-do-store (nth 1 method) (list 'cdr temp))))))) | |
2522 | |
2523 ;;;###autoload | |
2524 (defmacro remf (place tag) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
2525 "Remove TAG from property list PLACE. |
428 | 2526 PLACE may be a symbol, or any generalized variable allowed by `setf'. |
2527 The form returns true if TAG was found and removed, nil otherwise." | |
2528 (let* ((method (cl-setf-do-modify place t)) | |
2529 (tag-temp (and (not (cl-const-expr-p tag)) (gensym "--remf-tag--"))) | |
2530 (val-temp (and (not (cl-simple-expr-p place)) | |
2531 (gensym "--remf-place--"))) | |
2532 (ttag (or tag-temp tag)) | |
2533 (tval (or val-temp (nth 2 method)))) | |
2534 (list 'let* | |
2535 (append (car method) | |
2536 (and val-temp (list (list val-temp (nth 2 method)))) | |
2537 (and tag-temp (list (list tag-temp tag)))) | |
2538 (list 'if (list 'eq ttag (list 'car tval)) | |
2539 (list 'progn | |
2540 (cl-setf-do-store (nth 1 method) (list 'cddr tval)) | |
2541 t) | |
2542 (list 'cl-do-remf tval ttag))))) | |
2543 | |
2544 ;;;###autoload | |
2545 (defmacro shiftf (place &rest args) | |
2546 "(shiftf PLACE PLACE... VAL): shift left among PLACEs. | |
2547 Example: (shiftf A B C) sets A to B, B to C, and returns the old A. | |
2548 Each PLACE may be a symbol, or any generalized variable allowed by `setf'." | |
2153 | 2549 ;; XEmacs change: use iteration instead of recursion |
428 | 2550 (if (not (memq nil (mapcar 'symbolp (butlast (cons place args))))) |
2551 (list* 'prog1 place | |
2552 (let ((sets nil)) | |
2553 (while args | |
2153 | 2554 (push (list 'setq place (car args)) sets) |
2555 (setq place (pop args))) | |
428 | 2556 (nreverse sets))) |
2557 (let* ((places (reverse (cons place args))) | |
2153 | 2558 (form (pop places))) |
428 | 2559 (while places |
2153 | 2560 (let ((method (cl-setf-do-modify (pop places) 'unsafe))) |
428 | 2561 (setq form (list 'let* (car method) |
2562 (list 'prog1 (nth 2 method) | |
2563 (cl-setf-do-store (nth 1 method) form)))))) | |
2564 form))) | |
2565 | |
2566 ;;;###autoload | |
2567 (defmacro rotatef (&rest args) | |
2568 "(rotatef PLACE...): rotate left among PLACEs. | |
2569 Example: (rotatef A B C) sets A to B, B to C, and C to A. It returns nil. | |
2570 Each PLACE may be a symbol, or any generalized variable allowed by `setf'." | |
2571 (if (not (memq nil (mapcar 'symbolp args))) | |
2572 (and (cdr args) | |
2573 (let ((sets nil) | |
2574 (first (car args))) | |
2575 (while (cdr args) | |
2153 | 2576 (setq sets (nconc sets (list (pop args) (car args))))) |
428 | 2577 (nconc (list 'psetf) sets (list (car args) first)))) |
2578 (let* ((places (reverse args)) | |
2579 (temp (gensym "--rotatef--")) | |
2580 (form temp)) | |
2581 (while (cdr places) | |
2153 | 2582 (let ((method (cl-setf-do-modify (pop places) 'unsafe))) |
428 | 2583 (setq form (list 'let* (car method) |
2584 (list 'prog1 (nth 2 method) | |
2585 (cl-setf-do-store (nth 1 method) form)))))) | |
2586 (let ((method (cl-setf-do-modify (car places) 'unsafe))) | |
2587 (list 'let* (append (car method) (list (list temp (nth 2 method)))) | |
2588 (cl-setf-do-store (nth 1 method) form) nil))))) | |
2589 | |
4742
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2590 ;; This function is not in Common Lisp, and there are gaps in its structure and |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2591 ;; implementation that reflect that it was never well-specified. E.g. with |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2592 ;; setf, the question of whether a PLACE is bound or not and how to make it |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2593 ;; unbound doesn't arise, but we need some way of specifying that for letf to |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2594 ;; be sensible for gethash, symbol-value and so on; currently we just hard-code |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2595 ;; symbol-value, symbol-function and values (the latter is XEmacs work that |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2596 ;; I've just done) in the body of this function, and the following gives the |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2597 ;; wrong behaviour for gethash: |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2598 ;; |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2599 ;; (setq my-hash-table #s(hash-table test equal data ()) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2600 ;; print-gensym t) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2601 ;; => t |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2602 ;; (gethash "my-key" my-hash-table (gensym)) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2603 ;; => #:G68010 |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2604 ;; (letf (((gethash "my-key" my-hash-table) 4000)) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2605 ;; (message "key value is %S" (gethash "my-key" my-hash-table))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2606 ;; => "key value is 4000" |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2607 ;; (gethash "my-key" my-hash-table (gensym)) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2608 ;; => nil ;; should be an uninterned symbol. |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2609 ;; |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2610 ;; Aidan Kehoe, Fr Nov 13 16:12:21 GMT 2009 |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2611 |
428 | 2612 ;;;###autoload |
2613 (defmacro letf (bindings &rest body) | |
2614 "(letf ((PLACE VALUE) ...) BODY...): temporarily bind to PLACEs. | |
2615 This is the analogue of `let', but with generalized variables (in the | |
2616 sense of `setf') for the PLACEs. Each PLACE is set to the corresponding | |
2617 VALUE, then the BODY forms are executed. On exit, either normally or | |
2618 because of a `throw' or error, the PLACEs are set back to their original | |
2619 values. Note that this macro is *not* available in Common Lisp. | |
2620 As a special case, if `(PLACE)' is used instead of `(PLACE VALUE)', | |
2621 the PLACE is not modified before executing BODY." | |
2622 (if (and (not (cdr bindings)) (cdar bindings) (symbolp (caar bindings))) | |
2623 (list* 'let bindings body) | |
2624 (let ((lets nil) | |
2625 (rev (reverse bindings))) | |
2626 (while rev | |
2627 (let* ((place (if (symbolp (caar rev)) | |
2628 (list 'symbol-value (list 'quote (caar rev))) | |
2629 (caar rev))) | |
2630 (value (cadar rev)) | |
2631 (method (cl-setf-do-modify place 'no-opt)) | |
2632 (save (gensym "--letf-save--")) | |
4742
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2633 (bound (and (memq (car place) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2634 '(symbol-value symbol-function values)) |
428 | 2635 (gensym "--letf-bound--"))) |
2636 (temp (and (not (cl-const-expr-p value)) (cdr bindings) | |
4742
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2637 (gensym "--letf-val--"))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2638 (syms (and (eq 'values (car place)) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2639 (gensym "--letf-syms--"))) |
4783
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4742
diff
changeset
|
2640 (cursor (and syms (gensym "--letf-cursor--")))) |
428 | 2641 (setq lets (nconc (car method) |
4742
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2642 (cond |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2643 (syms |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2644 `((,syms ',(loop |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2645 for sym in (cdr place) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2646 nconc (if (symbolp sym) (list sym)))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2647 (,cursor ,syms) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2648 (,bound nil) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2649 (,save |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2650 (prog2 |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2651 (while (consp ,cursor) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2652 (setq ,bound |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2653 (cons (and (boundp (car ,cursor)) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2654 (symbol-value |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2655 (car ,cursor))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2656 ,bound) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2657 ,cursor (cdr ,cursor))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2658 ;; Just using ,bound as a temporary |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2659 ;; variable here, to initialise ,save: |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2660 (nreverse ,bound) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2661 ;; Now, really initialise ,bound: |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2662 (setq ,cursor ,syms |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2663 ,bound nil |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2664 ,bound |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2665 (progn (while (consp ,cursor) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2666 (setq ,bound |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2667 (cons |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2668 (boundp (car ,cursor)) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2669 ,bound) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2670 ,cursor (cdr ,cursor))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2671 (nreverse ,bound))))))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2672 (bound |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2673 (list (list bound |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2674 (list (if (eq (car place) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2675 'symbol-value) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2676 'boundp 'fboundp) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2677 (nth 1 (nth 2 method)))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2678 (list save (list 'and bound |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2679 (nth 2 method))))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2680 (t |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2681 (list (list save (nth 2 method))))) |
428 | 2682 (and temp (list (list temp value))) |
2683 lets) | |
2684 body (list | |
2685 (list 'unwind-protect | |
2686 (cons 'progn | |
2687 (if (cdr (car rev)) | |
2688 (cons (cl-setf-do-store (nth 1 method) | |
2689 (or temp value)) | |
2690 body) | |
2691 body)) | |
4742
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2692 (cond |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2693 (syms |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2694 `(while (consp ,syms) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2695 (if (car ,bound) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2696 (set (car ,syms) (car ,save)) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2697 (makunbound (car ,syms))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2698 (setq ,syms (cdr ,syms) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2699 ,bound (cdr ,bound) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2700 ,save (cdr ,save)))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2701 (bound |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2702 (list 'if bound |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2703 (cl-setf-do-store (nth 1 method) save) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2704 (list (if (eq (car place) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2705 'symbol-function) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2706 'fmakunbound |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2707 'makunbound) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2708 (nth 1 (nth 2 method))))) |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2709 (t |
4cf435fcebbc
Make #'letf not error if handed a #'values form.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4723
diff
changeset
|
2710 (cl-setf-do-store (nth 1 method) save))))) |
428 | 2711 rev (cdr rev)))) |
2712 (list* 'let* lets body)))) | |
2713 | |
2714 ;;;###autoload | |
2715 (defmacro letf* (bindings &rest body) | |
2716 "(letf* ((PLACE VALUE) ...) BODY...): temporarily bind to PLACEs. | |
2717 This is the analogue of `let*', but with generalized variables (in the | |
2718 sense of `setf') for the PLACEs. Each PLACE is set to the corresponding | |
2719 VALUE, then the BODY forms are executed. On exit, either normally or | |
2720 because of a `throw' or error, the PLACEs are set back to their original | |
2721 values. Note that this macro is *not* available in Common Lisp. | |
2722 As a special case, if `(PLACE)' is used instead of `(PLACE VALUE)', | |
2723 the PLACE is not modified before executing BODY." | |
2724 (if (null bindings) | |
2725 (cons 'progn body) | |
2726 (setq bindings (reverse bindings)) | |
2727 (while bindings | |
2153 | 2728 (setq body (list (list* 'letf (list (pop bindings)) body)))) |
428 | 2729 (car body))) |
2730 | |
2731 ;;;###autoload | |
2732 (defmacro callf (func place &rest args) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
2733 "Set PLACE to (FUNC PLACE ARGS...). |
428 | 2734 FUNC should be an unquoted function name. PLACE may be a symbol, |
2735 or any generalized variable allowed by `setf'." | |
2736 (let* ((method (cl-setf-do-modify place (cons 'list args))) | |
2737 (rargs (cons (nth 2 method) args))) | |
2738 (list 'let* (car method) | |
2739 (cl-setf-do-store (nth 1 method) | |
2740 (if (symbolp func) (cons func rargs) | |
2741 (list* 'funcall (list 'function func) | |
2742 rargs)))))) | |
2743 | |
2744 ;;;###autoload | |
2745 (defmacro callf2 (func arg1 place &rest args) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
2746 "Set PLACE to (FUNC ARG1 PLACE ARGS...). |
428 | 2747 Like `callf', but PLACE is the second argument of FUNC, not the first." |
2748 (if (and (cl-safe-expr-p arg1) (cl-simple-expr-p place) (symbolp func)) | |
2749 (list 'setf place (list* func arg1 place args)) | |
2750 (let* ((method (cl-setf-do-modify place (cons 'list args))) | |
2751 (temp (and (not (cl-const-expr-p arg1)) (gensym "--arg1--"))) | |
2752 (rargs (list* (or temp arg1) (nth 2 method) args))) | |
2753 (list 'let* (append (and temp (list (list temp arg1))) (car method)) | |
2754 (cl-setf-do-store (nth 1 method) | |
2755 (if (symbolp func) (cons func rargs) | |
2756 (list* 'funcall (list 'function func) | |
2757 rargs))))))) | |
2758 | |
2759 ;;;###autoload | |
2760 (defmacro define-modify-macro (name arglist func &optional doc) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
2761 "Define a `setf'-like modify macro. |
428 | 2762 If NAME is called, it combines its PLACE argument with the other arguments |
2763 from ARGLIST using FUNC: (define-modify-macro incf (&optional (n 1)) +)" | |
2764 (if (memq '&key arglist) (error "&key not allowed in define-modify-macro")) | |
2765 (let ((place (gensym "--place--"))) | |
2766 (list 'defmacro* name (cons place arglist) doc | |
2767 (list* (if (memq '&rest arglist) 'list* 'list) | |
2768 '(quote callf) (list 'quote func) place | |
2769 (cl-arglist-args arglist))))) | |
2770 | |
2771 | |
2772 ;;; Structures. | |
2773 | |
2774 ;;;###autoload | |
2775 (defmacro defstruct (struct &rest descs) | |
2776 "(defstruct (NAME OPTIONS...) (SLOT SLOT-OPTS...)...): define a struct type. | |
2777 This macro defines a new Lisp data type called NAME, which contains data | |
2778 stored in SLOTs. This defines a `make-NAME' constructor, a `copy-NAME' | |
2779 copier, a `NAME-p' predicate, and setf-able `NAME-SLOT' accessors." | |
2780 (let* ((name (if (consp struct) (car struct) struct)) | |
2781 (opts (cdr-safe struct)) | |
2782 (slots nil) | |
2783 (defaults nil) | |
2784 (conc-name (concat (symbol-name name) "-")) | |
2785 (constructor (intern (format "make-%s" name))) | |
2786 (constrs nil) | |
2787 (copier (intern (format "copy-%s" name))) | |
2788 (predicate (intern (format "%s-p" name))) | |
2789 (print-func nil) (print-auto nil) | |
2790 (safety (if (cl-compiling-file) cl-optimize-safety 3)) | |
2791 (include nil) | |
2792 (tag (intern (format "cl-struct-%s" name))) | |
2793 (tag-symbol (intern (format "cl-struct-%s-tags" name))) | |
2794 (include-descs nil) | |
2795 (side-eff nil) | |
2796 (type nil) | |
2797 (named nil) | |
2798 (forms nil) | |
2799 pred-form pred-check) | |
2800 (if (stringp (car descs)) | |
2153 | 2801 (push (list 'put (list 'quote name) '(quote structure-documentation) |
2802 (pop descs)) forms)) | |
428 | 2803 (setq descs (cons '(cl-tag-slot) |
2804 (mapcar #'(lambda (x) (if (consp x) x (list x))) | |
2805 descs))) | |
2806 (while opts | |
2807 (let ((opt (if (consp (car opts)) (caar opts) (car opts))) | |
2153 | 2808 (args (cdr-safe (pop opts)))) |
2809 (cond ((eq opt :conc-name) | |
428 | 2810 (if args |
2811 (setq conc-name (if (car args) | |
2812 (symbol-name (car args)) "")))) | |
2153 | 2813 ((eq opt :constructor) |
428 | 2814 (if (cdr args) |
2153 | 2815 (push args constrs) |
428 | 2816 (if args (setq constructor (car args))))) |
2153 | 2817 ((eq opt :copier) |
428 | 2818 (if args (setq copier (car args)))) |
2153 | 2819 ((eq opt :predicate) |
428 | 2820 (if args (setq predicate (car args)))) |
2153 | 2821 ((eq opt :include) |
428 | 2822 (setq include (car args) |
2823 include-descs (mapcar #'(lambda (x) | |
2824 (if (consp x) x (list x))) | |
2825 (cdr args)))) | |
2153 | 2826 ((eq opt :print-function) |
428 | 2827 (setq print-func (car args))) |
2153 | 2828 ((eq opt :type) |
428 | 2829 (setq type (car args))) |
2153 | 2830 ((eq opt :named) |
428 | 2831 (setq named t)) |
2153 | 2832 ((eq opt :initial-offset) |
428 | 2833 (setq descs (nconc (make-list (car args) '(cl-skip-slot)) |
2834 descs))) | |
2835 (t | |
2836 (error "Slot option %s unrecognized" opt))))) | |
2837 (if print-func | |
2838 (setq print-func (list 'progn | |
2839 (list 'funcall (list 'function print-func) | |
2840 'cl-x 'cl-s 'cl-n) t)) | |
2841 (or type (and include (not (get include 'cl-struct-print))) | |
2842 (setq print-auto t | |
2843 print-func (and (or (not (or include type)) (null print-func)) | |
2844 (list 'progn | |
2845 (list 'princ (format "#S(%s" name) | |
2846 'cl-s)))))) | |
2847 (if include | |
2848 (let ((inc-type (get include 'cl-struct-type)) | |
2849 (old-descs (get include 'cl-struct-slots))) | |
2850 (or inc-type (error "%s is not a struct name" include)) | |
2851 (and type (not (eq (car inc-type) type)) | |
2852 (error ":type disagrees with :include for %s" name)) | |
2853 (while include-descs | |
2854 (setcar (memq (or (assq (caar include-descs) old-descs) | |
2855 (error "No slot %s in included struct %s" | |
2856 (caar include-descs) include)) | |
2857 old-descs) | |
2153 | 2858 (pop include-descs))) |
428 | 2859 (setq descs (append old-descs (delq (assq 'cl-tag-slot descs) descs)) |
2860 type (car inc-type) | |
2861 named (assq 'cl-tag-slot descs)) | |
2862 (if (cadr inc-type) (setq tag name named t)) | |
2863 (let ((incl include)) | |
2864 (while incl | |
2153 | 2865 (push (list 'pushnew (list 'quote tag) |
428 | 2866 (intern (format "cl-struct-%s-tags" incl))) |
2867 forms) | |
2868 (setq incl (get incl 'cl-struct-include))))) | |
2869 (if type | |
2870 (progn | |
2871 (or (memq type '(vector list)) | |
2872 (error "Illegal :type specifier: %s" type)) | |
2873 (if named (setq tag name))) | |
2874 (setq type 'vector named 'true))) | |
2875 (or named (setq descs (delq (assq 'cl-tag-slot descs) descs))) | |
2153 | 2876 (push (list 'defvar tag-symbol) forms) |
428 | 2877 (setq pred-form (and named |
2878 (let ((pos (- (length descs) | |
2879 (length (memq (assq 'cl-tag-slot descs) | |
2880 descs))))) | |
2881 (if (eq type 'vector) | |
2882 (list 'and '(vectorp cl-x) | |
2883 (list '>= '(length cl-x) (length descs)) | |
2884 (list 'memq (list 'aref 'cl-x pos) | |
2885 tag-symbol)) | |
2886 (if (= pos 0) | |
2887 (list 'memq '(car-safe cl-x) tag-symbol) | |
2888 (list 'and '(consp cl-x) | |
2889 (list 'memq (list 'nth pos 'cl-x) | |
2890 tag-symbol)))))) | |
2891 pred-check (and pred-form (> safety 0) | |
2892 (if (and (eq (caadr pred-form) 'vectorp) | |
2893 (= safety 1)) | |
2894 (cons 'and (cdddr pred-form)) pred-form))) | |
2895 (let ((pos 0) (descp descs)) | |
2896 (while descp | |
2153 | 2897 (let* ((desc (pop descp)) |
428 | 2898 (slot (car desc))) |
2899 (if (memq slot '(cl-tag-slot cl-skip-slot)) | |
2900 (progn | |
2153 | 2901 (push nil slots) |
2902 (push (and (eq slot 'cl-tag-slot) (list 'quote tag)) | |
428 | 2903 defaults)) |
2904 (if (assq slot descp) | |
2905 (error "Duplicate slots named %s in %s" slot name)) | |
2906 (let ((accessor (intern (format "%s%s" conc-name slot)))) | |
2153 | 2907 (push slot slots) |
2908 (push (nth 1 desc) defaults) | |
2909 (push (list* | |
428 | 2910 'defsubst* accessor '(cl-x) |
2911 (append | |
2912 (and pred-check | |
2913 (list (list 'or pred-check | |
2914 (list 'error | |
2915 (format "%s accessing a non-%s" | |
2916 accessor name) | |
2917 'cl-x)))) | |
2918 (list (if (eq type 'vector) (list 'aref 'cl-x pos) | |
2919 (if (= pos 0) '(car cl-x) | |
2920 (list 'nth pos 'cl-x)))))) forms) | |
2153 | 2921 (push (cons accessor t) side-eff) |
2922 (push (list 'define-setf-method accessor '(cl-x) | |
2923 (if (cadr (memq :read-only (cddr desc))) | |
428 | 2924 (list 'error (format "%s is a read-only slot" |
2925 accessor)) | |
2926 (list 'cl-struct-setf-expander 'cl-x | |
2927 (list 'quote name) (list 'quote accessor) | |
2928 (and pred-check (list 'quote pred-check)) | |
2929 pos))) | |
2930 forms) | |
2931 (if print-auto | |
2932 (nconc print-func | |
2933 (list (list 'princ (format " %s" slot) 'cl-s) | |
2934 (list 'prin1 (list accessor 'cl-x) 'cl-s))))))) | |
2935 (setq pos (1+ pos)))) | |
2936 (setq slots (nreverse slots) | |
2937 defaults (nreverse defaults)) | |
2938 (and predicate pred-form | |
2153 | 2939 (progn (push (list 'defsubst* predicate '(cl-x) |
428 | 2940 (if (eq (car pred-form) 'and) |
2941 (append pred-form '(t)) | |
2942 (list 'and pred-form t))) forms) | |
2153 | 2943 (push (cons predicate 'error-free) side-eff))) |
428 | 2944 (and copier |
2153 | 2945 (progn (push (list 'defun copier '(x) '(copy-sequence x)) forms) |
2946 (push (cons copier t) side-eff))) | |
428 | 2947 (if constructor |
2153 | 2948 (push (list constructor |
428 | 2949 (cons '&key (delq nil (copy-sequence slots)))) |
2950 constrs)) | |
2951 (while constrs | |
2952 (let* ((name (caar constrs)) | |
2153 | 2953 (args (cadr (pop constrs))) |
428 | 2954 (anames (cl-arglist-args args)) |
2955 (make (mapcar* #'(lambda (s d) (if (memq s anames) s d)) | |
2956 slots defaults))) | |
2153 | 2957 (push (list 'defsubst* name |
428 | 2958 (list* '&cl-defs (list 'quote (cons nil descs)) args) |
2959 (cons type make)) forms) | |
2960 (if (cl-safe-expr-p (cons 'progn (mapcar 'second descs))) | |
2153 | 2961 (push (cons name t) side-eff)))) |
428 | 2962 (if print-auto (nconc print-func (list '(princ ")" cl-s) t))) |
2963 (if print-func | |
2153 | 2964 (push (list 'push |
428 | 2965 (list 'function |
2966 (list 'lambda '(cl-x cl-s cl-n) | |
2967 (list 'and pred-form print-func))) | |
2968 'custom-print-functions) forms)) | |
2153 | 2969 (push (list 'setq tag-symbol (list 'list (list 'quote tag))) forms) |
2970 (push (list* 'eval-when '(compile load eval) | |
428 | 2971 (list 'put (list 'quote name) '(quote cl-struct-slots) |
2972 (list 'quote descs)) | |
2973 (list 'put (list 'quote name) '(quote cl-struct-type) | |
2974 (list 'quote (list type (eq named t)))) | |
2975 (list 'put (list 'quote name) '(quote cl-struct-include) | |
2976 (list 'quote include)) | |
2977 (list 'put (list 'quote name) '(quote cl-struct-print) | |
2978 print-auto) | |
2979 (mapcar #'(lambda (x) | |
2980 (list 'put (list 'quote (car x)) | |
2981 '(quote side-effect-free) | |
2982 (list 'quote (cdr x)))) | |
2983 side-eff)) | |
2984 forms) | |
2985 (cons 'progn (nreverse (cons (list 'quote name) forms))))) | |
2986 | |
2987 ;;;###autoload | |
2988 (defun cl-struct-setf-expander (x name accessor pred-form pos) | |
2989 (let* ((temp (gensym "--x--")) (store (gensym "--store--"))) | |
2990 (list (list temp) (list x) (list store) | |
2991 (append '(progn) | |
2992 (and pred-form | |
2993 (list (list 'or (subst temp 'cl-x pred-form) | |
2994 (list 'error | |
2995 (format | |
2996 "%s storing a non-%s" accessor name) | |
2997 temp)))) | |
2998 (list (if (eq (car (get name 'cl-struct-type)) 'vector) | |
2999 (list 'aset temp pos store) | |
3000 (list 'setcar | |
3001 (if (<= pos 5) | |
3002 (let ((xx temp)) | |
3003 (while (>= (setq pos (1- pos)) 0) | |
3004 (setq xx (list 'cdr xx))) | |
3005 xx) | |
3006 (list 'nthcdr pos temp)) | |
3007 store)))) | |
3008 (list accessor temp)))) | |
3009 | |
3010 | |
3011 ;;; Types and assertions. | |
3012 | |
3013 ;;;###autoload | |
2153 | 3014 (defmacro deftype (name arglist &rest body) |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
3015 "Define NAME as a new data type. |
428 | 3016 The type name can then be used in `typecase', `check-type', etc." |
3017 (list 'eval-when '(compile load eval) | |
3018 (cl-transform-function-property | |
2153 | 3019 name 'cl-deftype-handler (cons (list* '&cl-defs ''('*) arglist) body)))) |
428 | 3020 |
3021 (defun cl-make-type-test (val type) | |
3022 (if (symbolp type) | |
3023 (cond ((get type 'cl-deftype-handler) | |
3024 (cl-make-type-test val (funcall (get type 'cl-deftype-handler)))) | |
3025 ((memq type '(nil t)) type) | |
2153 | 3026 ((eq type 'null) `(null ,val)) |
3027 ((eq type 'float) `(floatp-safe ,val)) | |
3028 ((eq type 'real) `(numberp ,val)) | |
3029 ((eq type 'fixnum) `(integerp ,val)) | |
3030 ;; XEmacs change: we do not have char-valid-p | |
3031 ((memq type '(character string-char)) `(characterp ,val)) | |
428 | 3032 (t |
3033 (let* ((name (symbol-name type)) | |
3034 (namep (intern (concat name "p")))) | |
3035 (if (fboundp namep) (list namep val) | |
3036 (list (intern (concat name "-p")) val))))) | |
3037 (cond ((get (car type) 'cl-deftype-handler) | |
3038 (cl-make-type-test val (apply (get (car type) 'cl-deftype-handler) | |
3039 (cdr type)))) | |
3040 ((memq (car-safe type) '(integer float real number)) | |
3041 (delq t (list 'and (cl-make-type-test val (car type)) | |
3042 (if (memq (cadr type) '(* nil)) t | |
3043 (if (consp (cadr type)) (list '> val (caadr type)) | |
3044 (list '>= val (cadr type)))) | |
3045 (if (memq (caddr type) '(* nil)) t | |
3046 (if (consp (caddr type)) (list '< val (caaddr type)) | |
3047 (list '<= val (caddr type))))))) | |
3048 ((memq (car-safe type) '(and or not)) | |
3049 (cons (car type) | |
3050 (mapcar #'(lambda (x) (cl-make-type-test val x)) | |
3051 (cdr type)))) | |
3052 ((memq (car-safe type) '(member member*)) | |
3053 (list 'and (list 'member* val (list 'quote (cdr type))) t)) | |
3054 ((eq (car-safe type) 'satisfies) (list (cadr type) val)) | |
3055 (t (error "Bad type spec: %s" type))))) | |
3056 | |
3057 ;;;###autoload | |
444 | 3058 (defun typep (object type) ; See compiler macro below. |
428 | 3059 "Check that OBJECT is of type TYPE. |
3060 TYPE is a Common Lisp-style type specifier." | |
444 | 3061 (eval (cl-make-type-test 'object type))) |
428 | 3062 |
3063 ;;;###autoload | |
446 | 3064 (defmacro check-type (place type &optional string) |
3065 "Verify that PLACE is of type TYPE; signal a continuable error if not. | |
428 | 3066 STRING is an optional description of the desired type." |
2153 | 3067 (and (or (not (cl-compiling-file)) |
3068 (< cl-optimize-speed 3) (= cl-optimize-safety 3)) | |
3069 (let* ((temp (if (cl-simple-expr-p place 3) place (gensym))) | |
3070 (test (cl-make-type-test temp type)) | |
3071 (signal-error `(signal 'wrong-type-argument | |
3072 ,(list 'list (or string (list 'quote type)) | |
3073 temp (list 'quote place)))) | |
3074 (body | |
3075 (condition-case nil | |
3076 `(while (not ,test) | |
3077 ,(macroexpand `(setf ,place ,signal-error))) | |
3078 (error | |
3079 `(if ,test (progn ,signal-error nil)))))) | |
3080 (if (eq temp place) `(progn ,body nil) | |
3081 `(let ((,temp ,place)) ,body nil))))) | |
428 | 3082 |
3083 ;;;###autoload | |
3084 (defmacro assert (form &optional show-args string &rest args) | |
3085 "Verify that FORM returns non-nil; signal an error if not. | |
3086 Second arg SHOW-ARGS means to include arguments of FORM in message. | |
3087 Other args STRING and ARGS... are arguments to be passed to `error'. | |
3088 They are not evaluated unless the assertion fails. If STRING is | |
3089 omitted, a default message listing FORM itself is used." | |
3090 (and (or (not (cl-compiling-file)) | |
3091 (< cl-optimize-speed 3) (= cl-optimize-safety 3)) | |
3092 (let ((sargs (and show-args (delq nil (mapcar | |
3093 #'(lambda (x) | |
3094 (and (not (cl-const-expr-p x)) | |
3095 x)) | |
3096 (cdr form)))))) | |
3097 (list 'progn | |
3098 (list 'or form | |
3099 (if string | |
3100 (list* 'error string (append sargs args)) | |
3101 (list 'signal '(quote cl-assertion-failed) | |
3102 (list* 'list (list 'quote form) sargs)))) | |
3103 nil)))) | |
3104 | |
3105 ;;;###autoload | |
3106 (defmacro ignore-errors (&rest body) | |
2153 | 3107 "Execute BODY; if an error occurs, return nil. |
3108 Otherwise, return result of last form in BODY." | |
428 | 3109 `(condition-case nil (progn ,@body) (error nil))) |
3110 | |
2153 | 3111 ;; XEmacs addition |
428 | 3112 ;;;###autoload |
3113 (defmacro ignore-file-errors (&rest body) | |
3114 "Execute FORMS; if an error of type `file-error' occurs, return nil. | |
3115 Otherwise, return result of last FORM." | |
3116 `(condition-case nil (progn ,@body) (file-error nil))) | |
3117 | |
3118 | |
3119 ;;; Compiler macros. | |
3120 | |
3121 ;;;###autoload | |
3122 (defmacro define-compiler-macro (func args &rest body) | |
4695
fee33ab25966
Add arglist info for autoloaded functions and macros.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4694
diff
changeset
|
3123 "Define a compiler-only macro. |
428 | 3124 This is like `defmacro', but macro expansion occurs only if the call to |
3125 FUNC is compiled (i.e., not interpreted). Compiler macros should be used | |
3126 for optimizing the way calls to FUNC are compiled; the form returned by | |
3127 BODY should do the same thing as a call to the normal function called | |
3128 FUNC, though possibly more efficiently. Note that, like regular macros, | |
3129 compiler macros are expanded repeatedly until no further expansions are | |
3130 possible. Unlike regular macros, BODY can decide to \"punt\" and leave the | |
3131 original function call alone by declaring an initial `&whole foo' parameter | |
3132 and then returning foo." | |
3133 (let ((p (if (listp args) args (list '&rest args))) (res nil)) | |
2153 | 3134 (while (consp p) (push (pop p) res)) |
3135 (setq args (nconc (nreverse res) (and p (list '&rest p))))) | |
428 | 3136 (list 'eval-when '(compile load eval) |
3137 (cl-transform-function-property | |
3138 func 'cl-compiler-macro | |
3139 (cons (if (memq '&whole args) (delq '&whole args) | |
3140 (cons '--cl-whole-arg-- args)) body)) | |
3141 (list 'or (list 'get (list 'quote func) '(quote byte-compile)) | |
3142 (list 'put (list 'quote func) '(quote byte-compile) | |
3143 '(quote cl-byte-compile-compiler-macro))))) | |
3144 | |
3145 ;;;###autoload | |
3146 (defun compiler-macroexpand (form) | |
3147 (while | |
3148 (let ((func (car-safe form)) (handler nil)) | |
3149 (while (and (symbolp func) | |
3150 (not (setq handler (get func 'cl-compiler-macro))) | |
3151 (fboundp func) | |
3152 (or (not (eq (car-safe (symbol-function func)) 'autoload)) | |
3153 (load (nth 1 (symbol-function func))))) | |
3154 (setq func (symbol-function func))) | |
3155 (and handler | |
3156 (not (eq form (setq form (apply handler form (cdr form)))))))) | |
3157 form) | |
3158 | |
3159 (defun cl-byte-compile-compiler-macro (form) | |
3160 (if (eq form (setq form (compiler-macroexpand form))) | |
3161 (byte-compile-normal-call form) | |
3162 (byte-compile-form form))) | |
3163 | |
3164 (defmacro defsubst* (name args &rest body) | |
3165 "(defsubst* NAME ARGLIST [DOCSTRING] BODY...): define NAME as a function. | |
3166 Like `defun', except the function is automatically declared `inline', | |
3167 ARGLIST allows full Common Lisp conventions, and BODY is implicitly | |
3168 surrounded by (block NAME ...)." | |
3169 (let* ((argns (cl-arglist-args args)) (p argns) | |
3170 (pbody (cons 'progn body)) | |
3171 (unsafe (not (cl-safe-expr-p pbody)))) | |
2153 | 3172 (while (and p (eq (cl-expr-contains args (car p)) 1)) (pop p)) |
428 | 3173 (list 'progn |
3174 (if p nil ; give up if defaults refer to earlier args | |
3175 (list 'define-compiler-macro name | |
2153 | 3176 (if (memq '&key args) |
3177 (list* '&whole 'cl-whole '&cl-quote args) | |
3178 (cons '&cl-quote args)) | |
428 | 3179 (list* 'cl-defsubst-expand (list 'quote argns) |
3180 (list 'quote (list* 'block name body)) | |
3181 (not (or unsafe (cl-expr-access-order pbody argns))) | |
3182 (and (memq '&key args) 'cl-whole) unsafe argns))) | |
3183 (list* 'defun* name args body)))) | |
3184 | |
3185 (defun cl-defsubst-expand (argns body simple whole unsafe &rest argvs) | |
3186 (if (and whole (not (cl-safe-expr-p (cons 'progn argvs)))) whole | |
3187 (if (cl-simple-exprs-p argvs) (setq simple t)) | |
3188 (let ((lets (delq nil | |
3189 (mapcar* #'(lambda (argn argv) | |
3190 (if (or simple (cl-const-expr-p argv)) | |
3191 (progn (setq body (subst argv argn body)) | |
3192 (and unsafe (list argn argv))) | |
3193 (list argn argv))) | |
3194 argns argvs)))) | |
3195 (if lets (list 'let lets body) body)))) | |
3196 | |
3197 | |
3198 ;;; Compile-time optimizations for some functions defined in this package. | |
3199 ;;; Note that cl.el arranges to force cl-macs to be loaded at compile-time, | |
3200 ;;; mainly to make sure these macros will be present. | |
3201 | |
3202 (put 'eql 'byte-compile nil) | |
3203 (define-compiler-macro eql (&whole form a b) | |
3204 (cond ((eq (cl-const-expr-p a) t) | |
3205 (let ((val (cl-const-expr-val a))) | |
3206 (if (and (numberp val) (not (integerp val))) | |
3207 (list 'equal a b) | |
3208 (list 'eq a b)))) | |
3209 ((eq (cl-const-expr-p b) t) | |
3210 (let ((val (cl-const-expr-val b))) | |
3211 (if (and (numberp val) (not (integerp val))) | |
3212 (list 'equal a b) | |
3213 (list 'eq a b)))) | |
3214 ((cl-simple-expr-p a 5) | |
3215 (list 'if (list 'numberp a) | |
3216 (list 'equal a b) | |
3217 (list 'eq a b))) | |
3218 ((and (cl-safe-expr-p a) | |
3219 (cl-simple-expr-p b 5)) | |
3220 (list 'if (list 'numberp b) | |
3221 (list 'equal a b) | |
3222 (list 'eq a b))) | |
3223 (t form))) | |
3224 | |
3225 (define-compiler-macro member* (&whole form a list &rest keys) | |
2153 | 3226 (let ((test (and (= (length keys) 2) (eq (car keys) :test) |
428 | 3227 (cl-const-expr-val (nth 1 keys))))) |
3228 (cond ((eq test 'eq) (list 'memq a list)) | |
3229 ((eq test 'equal) (list 'member a list)) | |
3230 ((or (null keys) (eq test 'eql)) | |
3231 (if (eq (cl-const-expr-p a) t) | |
3232 (list (if (floatp-safe (cl-const-expr-val a)) 'member 'memq) | |
3233 a list) | |
3234 (if (eq (cl-const-expr-p list) t) | |
3235 (let ((p (cl-const-expr-val list)) (mb nil) (mq nil)) | |
3236 (if (not (cdr p)) | |
3237 (and p (list 'eql a (list 'quote (car p)))) | |
3238 (while p | |
3239 (if (floatp-safe (car p)) (setq mb t) | |
3240 (or (integerp (car p)) (symbolp (car p)) (setq mq t))) | |
3241 (setq p (cdr p))) | |
3242 (if (not mb) (list 'memq a list) | |
3243 (if (not mq) (list 'member a list) form)))) | |
3244 form))) | |
3245 (t form)))) | |
3246 | |
3247 (define-compiler-macro assoc* (&whole form a list &rest keys) | |
2153 | 3248 (let ((test (and (= (length keys) 2) (eq (car keys) :test) |
428 | 3249 (cl-const-expr-val (nth 1 keys))))) |
3250 (cond ((eq test 'eq) (list 'assq a list)) | |
3251 ((eq test 'equal) (list 'assoc a list)) | |
3252 ((and (eq (cl-const-expr-p a) t) (or (null keys) (eq test 'eql))) | |
3253 (if (floatp-safe (cl-const-expr-val a)) | |
3254 (list 'assoc a list) (list 'assq a list))) | |
3255 (t form)))) | |
3256 | |
3257 (define-compiler-macro adjoin (&whole form a list &rest keys) | |
3258 (if (and (cl-simple-expr-p a) (cl-simple-expr-p list) | |
2153 | 3259 (not (memq :key keys))) |
428 | 3260 (list 'if (list* 'member* a list keys) list (list 'cons a list)) |
3261 form)) | |
3262 | |
3263 (define-compiler-macro list* (arg &rest others) | |
3264 (let* ((args (reverse (cons arg others))) | |
3265 (form (car args))) | |
3266 (while (setq args (cdr args)) | |
3267 (setq form (list 'cons (car args) form))) | |
3268 form)) | |
3269 | |
2153 | 3270 ;; XEmacs change: our builtin get takes the default argument |
440 | 3271 (define-compiler-macro get* (sym prop &optional default) |
3272 (list 'get sym prop default)) | |
428 | 3273 |
442 | 3274 (define-compiler-macro getf (sym prop &optional default) |
3275 (list 'plist-get sym prop default)) | |
3276 | |
428 | 3277 (define-compiler-macro typep (&whole form val type) |
3278 (if (cl-const-expr-p type) | |
3279 (let ((res (cl-make-type-test val (cl-const-expr-val type)))) | |
3280 (if (or (memq (cl-expr-contains res val) '(nil 1)) | |
3281 (cl-simple-expr-p val)) res | |
3282 (let ((temp (gensym))) | |
3283 (list 'let (list (list temp val)) (subst temp val res))))) | |
3284 form)) | |
3285 | |
4607
517f6887fbc0
Remove duplicate functions, chiefly #'delete-duplicates reimplementations.
Aidan Kehoe <kehoea@parhasard.net>
parents:
2297
diff
changeset
|
3286 ;; XEmacs; inline delete-duplicates if it's called with a literal |
517f6887fbc0
Remove duplicate functions, chiefly #'delete-duplicates reimplementations.
Aidan Kehoe <kehoea@parhasard.net>
parents:
2297
diff
changeset
|
3287 ;; #'equal or #'eq and no other keywords, we want the speed in |
517f6887fbc0
Remove duplicate functions, chiefly #'delete-duplicates reimplementations.
Aidan Kehoe <kehoea@parhasard.net>
parents:
2297
diff
changeset
|
3288 ;; font-lock.el. |
517f6887fbc0
Remove duplicate functions, chiefly #'delete-duplicates reimplementations.
Aidan Kehoe <kehoea@parhasard.net>
parents:
2297
diff
changeset
|
3289 (define-compiler-macro delete-duplicates (&whole form cl-seq &rest cl-keys) |
4707
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3290 (let ((listp-check |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3291 (if (memq (car-safe cl-seq) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3292 ;; No need to check for a list at runtime with these. We |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3293 ;; could expand the list, but these are all the functions |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3294 ;; in the relevant context at the moment. |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3295 '(nreverse append nconc mapcan mapcar)) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3296 t |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3297 '(listp begin)))) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3298 (cond ((and (= 4 (length form)) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3299 (eq :test (third form)) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3300 (or (equal '(quote eq) (fourth form)) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3301 (equal '(function eq) (fourth form)))) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3302 `(let* ((begin ,cl-seq) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3303 (cl-seq begin)) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3304 (if ,listp-check |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3305 (progn |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3306 (while cl-seq |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3307 (setq cl-seq (setcdr cl-seq (delq (car cl-seq) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3308 (cdr cl-seq))))) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3309 begin) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3310 ;; Call cl-delete-duplicates explicitly, to avoid the form |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3311 ;; getting compiler-macroexpanded again: |
4714
84f870bbd17b
Fix another bug in the delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4707
diff
changeset
|
3312 (cl-delete-duplicates begin ',cl-keys nil)))) |
4707
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3313 ((and (= 4 (length form)) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3314 (eq :test (third form)) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3315 (or (equal '(quote equal) (fourth form)) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3316 (equal '(function equal) (fourth form)))) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3317 `(let* ((begin ,cl-seq) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3318 (cl-seq begin)) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3319 (if ,listp-check |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3320 (progn |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3321 (while cl-seq |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3322 (setq cl-seq (setcdr cl-seq (delete (car cl-seq) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3323 (cdr cl-seq))))) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3324 begin) |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3325 ;; Call cl-delete-duplicates explicitly, to avoid the form |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3326 ;; getting compiler-macroexpanded again: |
4714
84f870bbd17b
Fix another bug in the delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4707
diff
changeset
|
3327 (cl-delete-duplicates begin ',cl-keys nil)))) |
4707
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3328 (t |
5bb0735f56e0
Handle non-list sequences better, delete-duplicates compiler macro.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4702
diff
changeset
|
3329 form)))) |
428 | 3330 |
4716
dca5bb2adff1
Don't cons with #'mapcar calls where the result is discarded,
Aidan Kehoe <kehoea@parhasard.net>
parents:
4714
diff
changeset
|
3331 ;; XEmacs change, the GNU mapc doesn't accept the Common Lisp args, so this |
dca5bb2adff1
Don't cons with #'mapcar calls where the result is discarded,
Aidan Kehoe <kehoea@parhasard.net>
parents:
4714
diff
changeset
|
3332 ;; change isn't helpful. |
dca5bb2adff1
Don't cons with #'mapcar calls where the result is discarded,
Aidan Kehoe <kehoea@parhasard.net>
parents:
4714
diff
changeset
|
3333 (define-compiler-macro mapc (&whole form cl-func cl-seq &rest cl-rest) |
dca5bb2adff1
Don't cons with #'mapcar calls where the result is discarded,
Aidan Kehoe <kehoea@parhasard.net>
parents:
4714
diff
changeset
|
3334 (if cl-rest |
dca5bb2adff1
Don't cons with #'mapcar calls where the result is discarded,
Aidan Kehoe <kehoea@parhasard.net>
parents:
4714
diff
changeset
|
3335 form |
dca5bb2adff1
Don't cons with #'mapcar calls where the result is discarded,
Aidan Kehoe <kehoea@parhasard.net>
parents:
4714
diff
changeset
|
3336 (cons 'mapc-internal (cdr form)))) |
dca5bb2adff1
Don't cons with #'mapcar calls where the result is discarded,
Aidan Kehoe <kehoea@parhasard.net>
parents:
4714
diff
changeset
|
3337 |
4719
bd51ab22afa8
Make it possible to silence warnings issued when #'mapcar's result is discarded.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4716
diff
changeset
|
3338 (define-compiler-macro mapcar* (&whole form cl-func cl-x &rest cl-rest) |
bd51ab22afa8
Make it possible to silence warnings issued when #'mapcar's result is discarded.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4716
diff
changeset
|
3339 (if cl-rest |
bd51ab22afa8
Make it possible to silence warnings issued when #'mapcar's result is discarded.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4716
diff
changeset
|
3340 form |
bd51ab22afa8
Make it possible to silence warnings issued when #'mapcar's result is discarded.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4716
diff
changeset
|
3341 (cons 'mapcar (cdr form)))) |
bd51ab22afa8
Make it possible to silence warnings issued when #'mapcar's result is discarded.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4716
diff
changeset
|
3342 |
4723
ebca981a0012
If STRING is constant, call regexp-quote at compile time.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4719
diff
changeset
|
3343 ;; XEmacs; it's perfectly reasonable, and often much clearer to those |
ebca981a0012
If STRING is constant, call regexp-quote at compile time.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4719
diff
changeset
|
3344 ;; reading the code, to call regexp-quote on a constant string, which is |
ebca981a0012
If STRING is constant, call regexp-quote at compile time.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4719
diff
changeset
|
3345 ;; something we can optimise here easily. |
ebca981a0012
If STRING is constant, call regexp-quote at compile time.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4719
diff
changeset
|
3346 (define-compiler-macro regexp-quote (&whole form string) |
ebca981a0012
If STRING is constant, call regexp-quote at compile time.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4719
diff
changeset
|
3347 (if (stringp string) |
ebca981a0012
If STRING is constant, call regexp-quote at compile time.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4719
diff
changeset
|
3348 (regexp-quote string) |
ebca981a0012
If STRING is constant, call regexp-quote at compile time.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4719
diff
changeset
|
3349 form)) |
ebca981a0012
If STRING is constant, call regexp-quote at compile time.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4719
diff
changeset
|
3350 |
4792
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3351 (define-compiler-macro equalp (&whole form x y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3352 "Expand calls to `equalp' where X or Y is a constant expression. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3353 |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3354 Much of the processing that `equalp' does is dependent on the types of both |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3355 of its arguments, and with type information for one of them, we can |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3356 eliminate much of the body of the function at compile time. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3357 |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3358 Where both X and Y are constant expressions, `equalp' is evaluated at |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3359 compile time by byte-optimize.el--this compiler macro passes FORM through to |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3360 the byte optimizer in those cases." |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3361 ;; Cases where both arguments are constant are handled in |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3362 ;; byte-optimize.el, we only need to handle those cases where one is |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3363 ;; constant here. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3364 (let* ((equalp-sym (eval-when-compile (gensym))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3365 (let-form '(progn)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3366 (check-bit-vector t) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3367 (check-string t) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3368 (original-y y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3369 equalp-temp checked) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3370 (macrolet |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3371 ((unordered-check (check) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3372 `(prog1 |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3373 (setq checked |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3374 (or ,check |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3375 (prog1 ,(sublis '((x . y) (y . x)) check :test #'eq) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3376 (setq equalp-temp x x y y equalp-temp)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3377 (when checked |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3378 (unless (symbolp y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3379 (setq let-form `(let ((,equalp-sym ,y))) y equalp-sym)))))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3380 ;; In the bodies of the below clauses, x is always a constant expression |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3381 ;; of the type we're interested in, and y is always a symbol that refers |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3382 ;; to the result non-constant side of the comparison. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3383 (cond ((unordered-check (and (arrayp x) (not (cl-const-expr-p y)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3384 ;; Strings and other arrays. A vector containing the same |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3385 ;; character elements as a given string is equalp to that string; |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3386 ;; a bit-vector can only be equalp to a string if both are |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3387 ;; zero-length. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3388 (cond |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3389 ((member x '("" #* [])) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3390 ;; No need to protect against multiple evaluation here: |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3391 `(and (member ,original-y '("" #* [])) t)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3392 ((stringp x) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3393 `(,@let-form |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3394 (if (stringp ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3395 (eq t (compare-strings ,x nil nil |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3396 ,y nil nil t)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3397 (if (vectorp ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3398 (cl-string-vector-equalp ,x ,y))))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3399 ((bit-vector-p x) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3400 `(,@let-form |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3401 (if (bit-vector-p ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3402 ;; No need to call equalp on each element here: |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3403 (equal ,x ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3404 (if (vectorp ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3405 (cl-bit-vector-vector-equalp ,x ,y))))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3406 (t |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3407 (loop |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3408 for elt across x |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3409 ;; We may not need to check the other argument if it's a |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3410 ;; string or bit vector, depending on the contents of x: |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3411 always (progn |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3412 (unless (characterp elt) (setq check-string nil)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3413 (unless (and (numberp elt) (or (= elt 0) (= elt 1))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3414 (setq check-bit-vector nil)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3415 (or check-string check-bit-vector))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3416 `(,@let-form |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3417 (cond |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3418 ,@(if check-string |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3419 `(((stringp ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3420 (cl-string-vector-equalp ,y ,x)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3421 ,@(if check-bit-vector |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3422 `(((bit-vector-p ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3423 (cl-bit-vector-vector-equalp ,y ,x)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3424 ((vectorp ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3425 (cl-vector-array-equalp ,x ,y))))))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3426 ((unordered-check (and (characterp x) (not (cl-const-expr-p y)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3427 `(,@let-form |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3428 (or (eq ,x ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3429 ;; eq has a bytecode, char-equal doesn't. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3430 (and (characterp ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3431 (eq (downcase ,x) (downcase ,y)))))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3432 ((unordered-check (and (numberp x) (not (cl-const-expr-p y)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3433 `(,@let-form |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3434 (and (numberp ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3435 (= ,x ,y)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3436 ((unordered-check (and (hash-table-p x) (not (cl-const-expr-p y)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3437 ;; Hash tables; follow the CL spec. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3438 `(,@let-form |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3439 (and (hash-table-p ,y) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3440 (eq ',(hash-table-test x) (hash-table-test ,y)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3441 (= ,(hash-table-count x) (hash-table-count ,y)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3442 (cl-hash-table-contents-equalp ,x ,y)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3443 ((unordered-check |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3444 ;; Symbols; eq. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3445 (and (not (cl-const-expr-p y)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3446 (or (memq x '(nil t)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3447 (and (eq (car-safe x) 'quote) (symbolp (second x)))))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3448 (cons 'eq (cdr form))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3449 ((unordered-check |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3450 ;; Compare conses at runtime, there's no real upside to |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3451 ;; unrolling the function -> they fall through to the next |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3452 ;; clause in this function. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3453 (and (cl-const-expr-p x) (not (consp x)) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3454 (not (cl-const-expr-p y)))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3455 ;; All other types; use equal. |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3456 (cons 'equal (cdr form))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3457 ;; Neither side is a constant expression, do all our evaluation at |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3458 ;; runtime (or both are, and equalp will be called from |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3459 ;; byte-optimize.el). |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3460 (t form))))) |
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
3461 |
428 | 3462 (mapc |
3463 #'(lambda (y) | |
3464 (put (car y) 'side-effect-free t) | |
3465 (put (car y) 'byte-compile 'cl-byte-compile-compiler-macro) | |
3466 (put (car y) 'cl-compiler-macro | |
3467 (list 'lambda '(w x) | |
3468 (if (symbolp (cadr y)) | |
3469 (list 'list (list 'quote (cadr y)) | |
3470 (list 'list (list 'quote (caddr y)) 'x)) | |
3471 (cons 'list (cdr y)))))) | |
3472 '((first 'car x) (second 'cadr x) (third 'caddr x) (fourth 'cadddr x) | |
3473 (fifth 'nth 4 x) (sixth 'nth 5 x) (seventh 'nth 6 x) | |
3474 (eighth 'nth 7 x) (ninth 'nth 8 x) (tenth 'nth 9 x) | |
3475 (rest 'cdr x) (endp 'null x) (plusp '> x 0) (minusp '< x 0) | |
446 | 3476 (oddp 'eq (list 'logand x 1) 1) |
3477 (evenp 'eq (list 'logand x 1) 0) | |
428 | 3478 (caar car car) (cadr car cdr) (cdar cdr car) (cddr cdr cdr) |
3479 (caaar car caar) (caadr car cadr) (cadar car cdar) | |
3480 (caddr car cddr) (cdaar cdr caar) (cdadr cdr cadr) | |
3481 (cddar cdr cdar) (cdddr cdr cddr) (caaaar car caaar) | |
3482 (caaadr car caadr) (caadar car cadar) (caaddr car caddr) | |
3483 (cadaar car cdaar) (cadadr car cdadr) (caddar car cddar) | |
3484 (cadddr car cdddr) (cdaaar cdr caaar) (cdaadr cdr caadr) | |
3485 (cdadar cdr cadar) (cdaddr cdr caddr) (cddaar cdr cdaar) | |
3486 (cddadr cdr cdadr) (cdddar cdr cddar) (cddddr cdr cdddr))) | |
3487 | |
3488 ;;; Things that are inline. | |
3489 (proclaim '(inline floatp-safe acons map concatenate notany notevery | |
2153 | 3490 ;; XEmacs omission: gethash is builtin |
3491 cl-set-elt revappend nreconc)) | |
428 | 3492 |
3493 ;;; Things that are side-effect-free. Moved to byte-optimize.el | |
2153 | 3494 ;(mapcar (function (lambda (x) (put x 'side-effect-free t))) |
3495 ; '(oddp evenp signum last butlast ldiff pairlis gcd lcm | |
3496 ; isqrt floor* ceiling* truncate* round* mod* rem* subseq | |
3497 ; list-length get* getf)) | |
428 | 3498 |
3499 ;;; Things that are side-effect-and-error-free. Moved to byte-optimize.el | |
2153 | 3500 ;(mapcar (function (lambda (x) (put x 'side-effect-free 'error-free))) |
3501 ; '(eql floatp-safe list* subst acons equalp random-state-p | |
3502 ; copy-tree sublis)) | |
428 | 3503 |
3504 | |
3505 (run-hooks 'cl-macs-load-hook) | |
3506 | |
2153 | 3507 ;;; arch-tag: afd947a6-b553-4df1-bba5-000be6388f46 |
428 | 3508 ;;; cl-macs.el ends here |