/[cmucl]/src/code/macros.lisp
ViewVC logotype

Contents of /src/code/macros.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.76 - (hide annotations)
Mon Oct 28 19:36:59 2002 UTC (11 years, 5 months ago) by toy
Branch: MAIN
Changes since 1.75: +27 -37 lines
o Fix pushnew evaluation order.  (Fix provided by Gerd Moellman.)
o For push, pushnew, and pop, we can't shortcut get-setf-method
  because even though place might be a symbol, it might be from a
  symbol-macrolet.  Always use get-setf-method.
1 ram 1.1 ;;; -*- Log: code.log; Package: Lisp -*-
2     ;;;
3     ;;; **********************************************************************
4 ram 1.20 ;;; This code was written as part of the CMU Common Lisp project at
5     ;;; Carnegie Mellon University, and has been placed in the public domain.
6     ;;;
7     (ext:file-comment
8 toy 1.76 "$Header: /tiger/var/lib/cvsroots/cmucl/src/code/macros.lisp,v 1.76 2002/10/28 19:36:59 toy Exp $")
9 ram 1.20 ;;;
10 ram 1.1 ;;; **********************************************************************
11     ;;;
12     ;;; This file contains the macros that are part of the standard
13     ;;; Spice Lisp environment.
14     ;;;
15     ;;; Written by Scott Fahlman and Rob MacLachlan.
16 ram 1.22 ;;; Modified by Bill Chiles to adhere to the wall.
17 ram 1.1 ;;;
18 wlott 1.10 (in-package "LISP")
19 wlott 1.13 (export '(defvar defparameter defconstant when unless setf
20 ram 1.39 defsetf psetf shiftf rotatef push pushnew pop
21 ram 1.1 incf decf remf case typecase with-open-file
22     with-open-stream with-input-from-string with-output-to-string
23     locally etypecase ctypecase ecase ccase
24 ram 1.39 get-setf-expansion define-setf-expander
25 ram 1.18 define-modify-macro destructuring-bind nth-value
26 wlott 1.33 otherwise ; Sacred to CASE and related macros.
27 pw 1.67 define-compiler-macro))
28 ram 1.1
29     (in-package "EXTENSIONS")
30     (export '(do-anonymous collect iterate))
31    
32     (in-package "LISP")
33    
34    
35     ;;; Parse-Body -- Public
36     ;;;
37     ;;; Parse out declarations and doc strings, *not* expanding macros.
38     ;;; Eventually the environment arg should be flushed, since macros can't expand
39     ;;; into declarations anymore.
40     ;;;
41     (defun parse-body (body environment &optional (doc-string-allowed t))
42     "This function is to parse the declarations and doc-string out of the body of
43     a defun-like form. Body is the list of stuff which is to be parsed.
44     Environment is ignored. If Doc-String-Allowed is true, then a doc string
45     will be parsed out of the body and returned. If it is false then a string
46     will terminate the search for declarations. Three values are returned: the
47     tail of Body after the declarations and doc strings, a list of declare forms,
48     and the doc-string, or NIL if none."
49     (declare (ignore environment))
50     (let ((decls ())
51     (doc nil))
52     (do ((tail body (cdr tail)))
53     ((endp tail)
54     (values tail (nreverse decls) doc))
55     (let ((form (car tail)))
56     (cond ((and (stringp form) (cdr tail))
57     (if doc-string-allowed
58 pw 1.70 (setq doc form
59     ;; Only one doc string is allowed.
60     doc-string-allowed nil)
61 ram 1.1 (return (values tail (nreverse decls) doc))))
62     ((not (and (consp form) (symbolp (car form))))
63     (return (values tail (nreverse decls) doc)))
64     ((eq (car form) 'declare)
65     (push form decls))
66     (t
67     (return (values tail (nreverse decls) doc))))))))
68    
69    
70     ;;;; DEFMACRO:
71    
72     ;;; Defmacro -- Public
73     ;;;
74     ;;; Parse the definition and make an expander function. The actual
75     ;;; definition is done by %defmacro which we expand into.
76     ;;;
77     (defmacro defmacro (name lambda-list &body body)
78 wlott 1.13 (let ((whole (gensym "WHOLE-"))
79     (environment (gensym "ENV-")))
80 ram 1.1 (multiple-value-bind
81     (body local-decs doc)
82 wlott 1.13 (parse-defmacro lambda-list whole body name 'defmacro
83     :environment environment)
84 ram 1.1 (let ((def `(lambda (,whole ,environment)
85     ,@local-decs
86     (block ,name
87     ,body))))
88 pw 1.69 `(progn
89     (eval-when (:compile-toplevel)
90     (c::do-macro-compile-time ',name #',def))
91     (eval-when (:load-toplevel :execute)
92     (c::%defmacro ',name #',def ',lambda-list ,doc)))))))
93 ram 1.1
94    
95     ;;; %Defmacro, %%Defmacro -- Internal
96     ;;;
97     ;;; Defmacro expands into %Defmacro which is a function that is treated
98     ;;; magically the compiler. After the compiler has gotten the information it
99     ;;; wants out of macro definition, it compiles a call to %%Defmacro which
100     ;;; happens at load time. We have a %Defmacro function which just calls
101     ;;; %%Defmacro in order to keep the interpreter happy.
102     ;;;
103     ;;; Eventually %%Defmacro should deal with clearing old compiler information
104     ;;; for the functional value.
105     ;;;
106     (defun c::%defmacro (name definition lambda-list doc)
107 wlott 1.13 (assert (eval:interpreted-function-p definition))
108     (setf (eval:interpreted-function-name definition)
109     (format nil "DEFMACRO ~S" name))
110     (setf (eval:interpreted-function-arglist definition) lambda-list)
111 ram 1.1 (c::%%defmacro name definition doc))
112     ;;;
113     (defun c::%%defmacro (name definition doc)
114     (clear-info function where-from name)
115 wlott 1.10 (setf (macro-function name) definition)
116 ram 1.1 (setf (documentation name 'function) doc)
117     name)
118 wlott 1.33
119    
120    
121     ;;;; DEFINE-COMPILER-MACRO
122    
123     (defmacro define-compiler-macro (name lambda-list &body body)
124     "Define a compiler-macro for NAME."
125     (let ((whole (gensym "WHOLE-"))
126     (environment (gensym "ENV-")))
127     (multiple-value-bind
128     (body local-decs doc)
129     (parse-defmacro lambda-list whole body name 'define-compiler-macro
130     :environment environment)
131     (let ((def `(lambda (,whole ,environment)
132     ,@local-decs
133     (block ,name
134     ,body))))
135 pw 1.69 `(progn
136     (eval-when (:compile-toplevel)
137     (c::do-compiler-macro-compile-time ',name #',def))
138     (eval-when (:load-toplevel :execute)
139     (c::%define-compiler-macro ',name #',def ',lambda-list ,doc)))))))
140    
141 wlott 1.33
142     (defun c::%define-compiler-macro (name definition lambda-list doc)
143     (assert (eval:interpreted-function-p definition))
144     (setf (eval:interpreted-function-name definition)
145     (let ((*print-case* :upcase))
146     (format nil "DEFINE-COMPILER-MACRO ~S" name)))
147     (setf (eval:interpreted-function-arglist definition) lambda-list)
148     (c::%%define-compiler-macro name definition doc))
149     ;;;
150     (defun c::%%define-compiler-macro (name definition doc)
151     (setf (compiler-macro-function name) definition)
152     (setf (documentation name 'compiler-macro) doc)
153     name)
154    
155 ram 1.1
156 dtc 1.63
157     ;;;; DEFINE-SYMBOL-MACRO
158    
159     ;;; define-symbol-macro -- Public
160     ;;;
161     (defmacro define-symbol-macro (name expansion)
162     `(eval-when (compile load eval)
163     (%define-symbol-macro ',name ',expansion)))
164     ;;;
165     (defun %define-symbol-macro (name expansion)
166     (unless (symbolp name)
167     (error 'simple-type-error :datum name :expected-type 'symbol
168     :format-control "Symbol macro name is not a symbol: ~S."
169     :format-arguments (list name)))
170     (ecase (info variable kind name)
171     ((:macro :global nil)
172     (setf (info variable kind name) :macro)
173     (setf (info variable macro-expansion name) expansion))
174     (:special
175     (error 'simple-program-error
176     :format-control "Symbol macro name already declared special: ~S."
177     :format-arguments (list name)))
178     (:constant
179     (error 'simple-program-error
180     :format-control "Symbol macro name already declared constant: ~S."
181     :format-arguments (list name))))
182     name)
183    
184 ram 1.1
185     ;;; DEFTYPE is a lot like DEFMACRO.
186    
187     (defmacro deftype (name arglist &body body)
188     "Syntax like DEFMACRO, but defines a new type."
189     (unless (symbolp name)
190     (error "~S -- Type name not a symbol." name))
191    
192 wlott 1.13 (let ((whole (gensym "WHOLE-")))
193 ram 1.1 (multiple-value-bind (body local-decs doc)
194 wlott 1.13 (parse-defmacro arglist whole body name 'deftype
195     :default-default ''*)
196     `(eval-when (compile load eval)
197     (%deftype ',name
198     #'(lambda (,whole)
199     ,@local-decs
200     (block ,name ,body))
201     ,@(when doc `(,doc)))))))
202 ram 1.7 ;;;
203     (defun %deftype (name expander &optional doc)
204 ram 1.12 (ecase (info type kind name)
205     (:primitive
206 ram 1.36 (when *type-system-initialized*
207     (error "Illegal to redefine standard type: ~S." name)))
208     (:instance
209     (warn "Redefining class ~S to be a DEFTYPE." name)
210 ram 1.43 (undefine-structure (layout-info (class-layout (find-class name))))
211     (setf (class-cell-class (find-class-cell name)) nil)
212 ram 1.36 (setf (info type compiler-layout name) nil)
213     (setf (info type kind name) :defined))
214     (:defined)
215     ((nil)
216     (setf (info type kind name) :defined)))
217    
218 wlott 1.13 (setf (info type expander name) expander)
219 ram 1.7 (when doc
220     (setf (documentation name 'type) doc))
221 wlott 1.10 ;; ### Bootstrap hack -- we need to define types before %note-type-defined
222     ;; is defined.
223 ram 1.12 (when (fboundp 'c::%note-type-defined)
224 wlott 1.10 (c::%note-type-defined name))
225 ram 1.7 name)
226    
227 ram 1.1
228 ram 1.39 ;;; And so is DEFINE-SETF-EXPANDER.
229 ram 1.1
230     (defparameter defsetf-error-string "Setf expander for ~S cannot be called with ~S args.")
231    
232 ram 1.39 (defmacro define-setf-expander (access-fn lambda-list &body body)
233 pw 1.68 "Syntax like DEFMACRO, but creates a Setf-Expansion generator. The body
234 ram 1.1 must be a form that returns the five magical values."
235     (unless (symbolp access-fn)
236 dtc 1.58 (error "~S -- Access-function name not a symbol in DEFINE-SETF-EXPANDER."
237 ram 1.1 access-fn))
238    
239 wlott 1.13 (let ((whole (gensym "WHOLE-"))
240     (environment (gensym "ENV-")))
241 ram 1.1 (multiple-value-bind (body local-decs doc)
242     (parse-defmacro lambda-list whole body access-fn
243 dtc 1.58 'define-setf-expander
244 wlott 1.13 :environment environment)
245 ram 1.1 `(eval-when (load compile eval)
246 ram 1.22 (%define-setf-macro
247     ',access-fn
248     #'(lambda (,whole ,environment)
249     ,@local-decs
250     (block ,access-fn ,body))
251     nil
252     ',doc)))))
253 ram 1.1
254 ram 1.39 (defmacro define-setf-method (&rest stuff)
255     "Obsolete, use define-setf-expander."
256     `(define-setf-expander ,@stuff))
257 ram 1.22
258 ram 1.39
259 ram 1.22 ;;; %DEFINE-SETF-MACRO -- Internal
260     ;;;
261     ;;; Do stuff for defining a setf macro.
262     ;;;
263     (defun %define-setf-macro (name expander inverse doc)
264     (cond ((not (fboundp `(setf ,name))))
265     ((info function accessor-for name)
266     (warn "Defining setf macro for destruct slot accessor; redefining as ~
267     a normal function:~% ~S"
268     name)
269     (c::define-function-name name))
270     ((not (eq (symbol-package name) (symbol-package 'aref)))
271     (warn "Defining setf macro for ~S, but ~S is fbound."
272     name `(setf ,name))))
273     (when (or inverse (info setf inverse name))
274     (setf (info setf inverse name) inverse))
275     (when (or expander (info setf expander name))
276     (setf (info setf expander name) expander))
277     (when doc
278     (setf (documentation name 'setf) doc))
279     name)
280    
281 wlott 1.13
282     ;;;; Destructuring-bind
283 ram 1.1
284 wlott 1.13 (defmacro destructuring-bind (lambda-list arg-list &rest body)
285     "Bind the variables in LAMBDA-LIST to the contents of ARG-LIST."
286     (let* ((arg-list-name (gensym "ARG-LIST-")))
287     (multiple-value-bind
288 wlott 1.14 (body local-decls)
289 wlott 1.17 (parse-defmacro lambda-list arg-list-name body nil 'destructuring-bind
290 wlott 1.13 :annonymousp t :doc-string-allowed nil)
291     `(let ((,arg-list-name ,arg-list))
292 wlott 1.14 ,@local-decls
293 wlott 1.13 ,body))))
294    
295 ram 1.1
296     ;;;; Defun, Defvar, Defparameter, Defconstant:
297    
298     ;;; Defun -- Public
299     ;;;
300     ;;; Very similar to Defmacro, but simpler. We don't have to parse the
301     ;;; lambda-list.
302     ;;;
303 wlott 1.13 (defmacro defun (&whole source name lambda-list &body (body decls doc))
304 ram 1.1 (let ((def `(lambda ,lambda-list
305     ,@decls
306     (block ,(if (and (consp name) (eq (car name) 'setf))
307     (cadr name)
308     name)
309     ,@body))))
310     `(c::%defun ',name #',def ,doc ',source)))
311    
312    
313     ;;; %Defun, %%Defun -- Internal
314     ;;;
315     ;;; Similar to %Defmacro, ...
316     ;;;
317     (defun c::%%defun (name def doc &optional inline-expansion)
318     (setf (fdefinition name) def)
319     (when doc
320     (if (and (consp name) (eq (first name) 'setf))
321     (setf (documentation (second name) 'setf) doc)
322     (setf (documentation name 'function) doc)))
323 ram 1.12 (c::define-function-name name)
324     (when (eq (info function where-from name) :assumed)
325     (setf (info function where-from name) :defined)
326     (when (info function assumed-type name)
327     (setf (info function assumed-type name) nil)))
328 ram 1.1 (when (or inline-expansion
329     (info function inline-expansion name))
330     (setf (info function inline-expansion name) inline-expansion))
331     name)
332     ;;;
333     (defun c::%defun (name def doc source)
334     (declare (ignore source))
335 ram 1.3 (assert (eval:interpreted-function-p def))
336     (setf (eval:interpreted-function-name def) name)
337 ram 1.1 (c::%%defun name def doc))
338    
339    
340     ;;; DEFCONSTANT -- Public
341     ;;;
342     (defmacro defconstant (var val &optional doc)
343     "For defining global constants at top level. The DEFCONSTANT says that the
344     value is constant and may be compiled into code. If the variable already has
345     a value, and this is not equal to the init, an error is signalled. The third
346     argument is an optional documentation string for the variable."
347 moore 1.72 `(progn
348     (eval-when (:compile-toplevel)
349     (c::do-defconstant-compile-time ',var ,val ',doc))
350     (eval-when (:load-toplevel :execute)
351     (c::%%defconstant ',var ,val ',doc))))
352 ram 1.1
353     ;;; %Defconstant, %%Defconstant -- Internal
354     ;;;
355     ;;; Like the other %mumbles except that we currently actually do something
356     ;;; interesting at load time, namely checking if the constant is being
357     ;;; redefined.
358     ;;;
359     (defun c::%defconstant (name value doc)
360     (c::%%defconstant name value doc))
361     ;;;
362     (defun c::%%defconstant (name value doc)
363     (when doc
364     (setf (documentation name 'variable) doc))
365     (when (boundp name)
366     (unless (equalp (symbol-value name) value)
367     (cerror "Go ahead and change the value."
368     "Constant ~S being redefined." name)))
369     (setf (symbol-value name) value)
370     (setf (info variable kind name) :constant)
371     (clear-info variable constant-value name)
372     name)
373    
374    
375     (defmacro defvar (var &optional (val nil valp) (doc nil docp))
376     "For defining global variables at top level. Declares the variable
377     SPECIAL and, optionally, initializes it. If the variable already has a
378     value, the old value is not clobbered. The third argument is an optional
379     documentation string for the variable."
380     `(progn
381 pw 1.66 (declaim (special ,var))
382 ram 1.1 ,@(when valp
383     `((unless (boundp ',var)
384     (setq ,var ,val))))
385     ,@(when docp
386     `((setf (documentation ',var 'variable) ',doc)))
387     ',var))
388    
389     (defmacro defparameter (var val &optional (doc nil docp))
390     "Defines a parameter that is not normally changed by the program,
391     but that may be changed without causing an error. Declares the
392     variable special and sets its value to VAL. The third argument is
393     an optional documentation string for the parameter."
394     `(progn
395 pw 1.66 (declaim (special ,var))
396 ram 1.1 (setq ,var ,val)
397     ,@(when docp
398     `((setf (documentation ',var 'variable) ',doc)))
399     ',var))
400    
401    
402     ;;;; ASSORTED CONTROL STRUCTURES
403    
404    
405     (defmacro when (test &body forms)
406     "First arg is a predicate. If it is non-null, the rest of the forms are
407     evaluated as a PROGN."
408     `(cond (,test nil ,@forms)))
409    
410     (defmacro unless (test &rest forms)
411     "First arg is a predicate. If it is null, the rest of the forms are
412     evaluated as a PROGN."
413     `(cond ((not ,test) nil ,@forms)))
414    
415    
416     (defmacro return (&optional (value nil))
417     `(return-from nil ,value))
418    
419     (defmacro prog (varlist &body (body decls))
420     `(block nil
421     (let ,varlist
422     ,@decls
423     (tagbody ,@body))))
424    
425     (defmacro prog* (varlist &body (body decls))
426     `(block nil
427     (let* ,varlist
428     ,@decls
429     (tagbody ,@body))))
430    
431    
432     ;;; Prog1, Prog2 -- Public
433     ;;;
434     ;;; These just turn into a Let.
435     ;;;
436     (defmacro prog1 (result &rest body)
437     (let ((n-result (gensym)))
438     `(let ((,n-result ,result))
439     ,@body
440     ,n-result)))
441     ;;;
442     (defmacro prog2 (form1 result &rest body)
443     `(prog1 (progn ,form1 ,result) ,@body))
444    
445    
446     ;;; And, Or -- Public
447     ;;;
448     ;;; AND and OR are defined in terms of IF.
449     ;;;
450     (defmacro and (&rest forms)
451     (cond ((endp forms) t)
452     ((endp (rest forms)) (first forms))
453     (t
454     `(if ,(first forms)
455     (and ,@(rest forms))
456     nil))))
457     ;;;
458     (defmacro or (&rest forms)
459     (cond ((endp forms) nil)
460     ((endp (rest forms)) (first forms))
461     (t
462     (let ((n-result (gensym)))
463     `(let ((,n-result ,(first forms)))
464     (if ,n-result
465     ,n-result
466     (or ,@(rest forms))))))))
467    
468    
469     ;;; Cond -- Public
470     ;;;
471     ;;; COND also turns into IF.
472     ;;;
473     (defmacro cond (&rest clauses)
474     (if (endp clauses)
475     nil
476     (let ((clause (first clauses)))
477     (when (atom clause)
478     (error "Cond clause is not a list: ~S." clause))
479     (let ((test (first clause))
480     (forms (rest clause)))
481     (if (endp forms)
482     (let ((n-result (gensym)))
483     `(let ((,n-result ,test))
484     (if ,n-result
485     ,n-result
486     (cond ,@(rest clauses)))))
487     `(if ,test
488     (progn ,@forms)
489     (cond ,@(rest clauses))))))))
490    
491    
492     ;;;; Multiple value macros:
493    
494     ;;; Multiple-Value-XXX -- Public
495     ;;;
496     ;;; All the multiple-value receiving forms are defined in terms of
497     ;;; Multiple-Value-Call.
498     ;;;
499     (defmacro multiple-value-setq (varlist value-form)
500     (unless (and (listp varlist) (every #'symbolp varlist))
501     (error "Varlist is not a list of symbols: ~S." varlist))
502     (let ((temps (mapcar #'(lambda (x) (declare (ignore x)) (gensym)) varlist)))
503     `(multiple-value-bind ,temps ,value-form
504     ,@(mapcar #'(lambda (var temp)
505     `(setq ,var ,temp))
506     varlist temps)
507     ,(car temps))))
508     ;;;
509     (defmacro multiple-value-bind (varlist value-form &body body)
510     (unless (and (listp varlist) (every #'symbolp varlist))
511     (error "Varlist is not a list of symbols: ~S." varlist))
512     (if (= (length varlist) 1)
513     `(let ((,(car varlist) ,value-form))
514     ,@body)
515     (let ((ignore (gensym)))
516     `(multiple-value-call #'(lambda (&optional ,@varlist &rest ,ignore)
517     (declare (ignore ,ignore))
518     ,@body)
519     ,value-form))))
520     ;;;
521     (defmacro multiple-value-list (value-form)
522     `(multiple-value-call #'list ,value-form))
523 ram 1.18
524    
525     (defmacro nth-value (n form)
526     "Evaluates FORM and returns the Nth value (zero based). This involves no
527     consing when N is a trivial constant integer."
528     (if (integerp n)
529     (let ((dummy-list nil)
530 wlott 1.30 (keeper (gensym "KEEPER-")))
531 ram 1.26 ;; We build DUMMY-LIST, a list of variables to bind to useless
532     ;; values, then we explicitly IGNORE those bindings and return
533 wlott 1.30 ;; KEEPER, the only thing we're really interested in right now.
534 ram 1.26 (dotimes (i n)
535 wlott 1.30 (push (gensym "IGNORE-") dummy-list))
536     `(multiple-value-bind (,@dummy-list ,keeper)
537 ram 1.26 ,form
538     (declare (ignore ,@dummy-list))
539 wlott 1.30 ,keeper))
540     (once-only ((n n))
541 dtc 1.62 `(case (the (values fixnum &rest t) ,n)
542 wlott 1.30 (0 (nth-value 0 ,form))
543     (1 (nth-value 1 ,form))
544     (2 (nth-value 2 ,form))
545 dtc 1.62 (T (nth (the (values fixnum &rest t) ,n)
546     (multiple-value-list ,form)))))))
547 ram 1.1
548    
549     ;;;; SETF and friends.
550    
551     ;;; Note: The expansions for SETF and friends sometimes create needless
552     ;;; LET-bindings of argument values. The compiler will remove most of
553     ;;; these spurious bindings, so SETF doesn't worry too much about creating
554     ;;; them.
555    
556     ;;; The inverse for a generalized-variable reference function is stored in
557     ;;; one of two ways:
558     ;;;
559 ram 1.38 ;;; A SETF inverse property corresponds to the short form of DEFSETF. It is
560 ram 1.1 ;;; the name of a function takes the same args as the reference form, plus a
561     ;;; new-value arg at the end.
562     ;;;
563 ram 1.38 ;;; A SETF method expander is created by the long form of DEFSETF or
564 dtc 1.58 ;;; by DEFINE-SETF-EXPANDER. It is a function that is called on the reference
565 ram 1.1 ;;; form and that produces five values: a list of temporary variables, a list
566     ;;; of value forms, a list of the single store-value form, a storing function,
567     ;;; and an accessing function.
568    
569 ram 1.39 (defun get-setf-expansion (form &optional environment)
570 ram 1.1 "Returns five values needed by the SETF machinery: a list of temporary
571 wlott 1.29 variables, a list of values with which to fill them, a list of temporaries
572     for the new values, the setting function, and the accessing function."
573 ram 1.1 (let (temp)
574     (cond ((symbolp form)
575 wlott 1.32 (multiple-value-bind
576     (expansion expanded)
577     (macroexpand-1 form environment)
578     (if expanded
579 ram 1.39 (get-setf-expansion expansion environment)
580 wlott 1.32 (let ((new-var (gensym)))
581     (values nil nil (list new-var)
582     `(setq ,form ,new-var) form)))))
583 ram 1.25 ;;
584     ;; Local functions inhibit global setf methods...
585 ram 1.22 ((and environment
586 ram 1.36 (let ((name (car form)))
587     (dolist (x (c::lexenv-functions environment) nil)
588     (when (and (eq (car x) name)
589     (not (c::defined-function-p (cdr x))))
590     (return t)))))
591 ram 1.38 (expand-or-get-setf-inverse form environment))
592 ram 1.1 ((setq temp (info setf inverse (car form)))
593 wlott 1.10 (get-setf-method-inverse form `(,temp) nil))
594 ram 1.1 ((setq temp (info setf expander (car form)))
595     (funcall temp form environment))
596     (t
597 ram 1.38 (expand-or-get-setf-inverse form environment)))))
598    
599 ram 1.39 (defun get-setf-method-multiple-value (form &optional env)
600     "Obsolete: use GET-SETF-EXPANSION."
601     (get-setf-expansion form env))
602 ram 1.38
603     ;;;
604     ;;; If a macro, expand one level and try again. If not, go for the
605     ;;; SETF function.
606     (defun expand-or-get-setf-inverse (form environment)
607     (multiple-value-bind
608     (expansion expanded)
609     (macroexpand-1 form environment)
610     (if expanded
611 ram 1.39 (get-setf-expansion expansion environment)
612 ram 1.38 (get-setf-method-inverse form `(funcall #'(setf ,(car form)))
613     t))))
614    
615 ram 1.1
616 wlott 1.10 (defun get-setf-method-inverse (form inverse setf-function)
617 ram 1.1 (let ((new-var (gensym))
618     (vars nil)
619     (vals nil))
620     (dolist (x (cdr form))
621     (push (gensym) vars)
622     (push x vals))
623     (setq vals (nreverse vals))
624     (values vars vals (list new-var)
625 wlott 1.10 (if setf-function
626     `(,@inverse ,new-var ,@vars)
627     `(,@inverse ,@vars ,new-var))
628 ram 1.1 `(,(car form) ,@vars))))
629    
630    
631 wlott 1.29 (defun get-setf-method (form &optional environment)
632 ram 1.39 "Obsolete: use GET-SETF-EXPANSION and handle multiple store values."
633 wlott 1.29 (multiple-value-bind
634     (temps value-forms store-vars store-form access-form)
635 ram 1.39 (get-setf-expansion form environment)
636 wlott 1.29 (when (cdr store-vars)
637     (error "GET-SETF-METHOD used for a form with multiple store ~
638     variables:~% ~S" form))
639     (values temps value-forms store-vars store-form access-form)))
640 ram 1.1
641 wlott 1.29
642 wlott 1.16 (defun defsetter (fn rest)
643 wlott 1.14 (let ((arglist (car rest))
644     (arglist-var (gensym "ARGS-"))
645     (new-var (car (cadr rest))))
646     (multiple-value-bind
647     (body local-decs doc)
648 wlott 1.16 (parse-defmacro arglist arglist-var (cddr rest) fn 'defsetf)
649 ram 1.1 (values
650 wlott 1.14 `(lambda (,arglist-var ,new-var)
651     ,@local-decs
652 wlott 1.16 ,body)
653 wlott 1.15 doc))))
654 ram 1.1
655    
656 wlott 1.16 (defmacro defsetf (access-fn &rest rest)
657 ram 1.1 "Associates a SETF update function or macro with the specified access
658     function or macro. The format is complex. See the manual for
659     details."
660     (cond ((not (listp (car rest)))
661     `(eval-when (load compile eval)
662 ram 1.22 (%define-setf-macro ',access-fn nil ',(car rest)
663     ,(when (and (car rest) (stringp (cadr rest)))
664     `',(cadr rest)))))
665 wlott 1.29 ((and (cdr rest) (listp (cadr rest)))
666     (destructuring-bind
667     (lambda-list (&rest store-variables) &body body)
668     rest
669     (let ((arglist-var (gensym "ARGS-"))
670     (access-form-var (gensym "ACCESS-FORM-"))
671     (env-var (gensym "ENVIRONMENT-")))
672     (multiple-value-bind
673     (body local-decs doc)
674     (parse-defmacro `(,lambda-list ,@store-variables)
675     arglist-var body access-fn 'defsetf
676     :annonymousp t)
677     `(eval-when (load compile eval)
678     (%define-setf-macro
679     ',access-fn
680     #'(lambda (,access-form-var ,env-var)
681     (declare (ignore ,env-var))
682     (%defsetf ,access-form-var ,(length store-variables)
683     #'(lambda (,arglist-var)
684     ,@local-decs
685     (block ,access-fn
686     ,body))))
687     nil
688     ',doc))))))
689     (t
690     (error "Ill-formed DEFSETF for ~S." access-fn))))
691 ram 1.1
692 wlott 1.29 (defun %defsetf (orig-access-form num-store-vars expander)
693 wlott 1.34 (collect ((subforms) (subform-vars) (subform-exprs) (store-vars))
694     (dolist (subform (cdr orig-access-form))
695     (if (constantp subform)
696     (subforms subform)
697     (let ((var (gensym)))
698     (subforms var)
699     (subform-vars var)
700     (subform-exprs subform))))
701     (dotimes (i num-store-vars)
702     (store-vars (gensym)))
703     (values (subform-vars)
704     (subform-exprs)
705     (store-vars)
706     (funcall expander (cons (subforms) (store-vars)))
707     `(,(car orig-access-form) ,@(subforms)))))
708 wlott 1.29
709    
710 ram 1.23 ;;; SETF -- Public
711     ;;;
712     ;;; Except for atoms, we always call GET-SETF-METHOD, since it has some
713     ;;; non-trivial semantics. But when there is a setf inverse, and G-S-M uses
714     ;;; it, then we return a call to the inverse, rather than returning a hairy let
715     ;;; form. This is probably important mainly as a convenince in allowing the
716     ;;; use of setf inverses without the full interpreter.
717     ;;;
718 ram 1.1 (defmacro setf (&rest args &environment env)
719     "Takes pairs of arguments like SETQ. The first is a place and the second
720     is the value that is supposed to go into that place. Returns the last
721     value. The place argument may be any of the access forms for which SETF
722     knows a corresponding setting form."
723 ram 1.22 (let ((nargs (length args)))
724     (cond
725     ((= nargs 2)
726 ram 1.23 (let ((place (first args))
727     (value-form (second args)))
728     (if (atom place)
729     `(setq ,place ,value-form)
730     (multiple-value-bind (dummies vals newval setter getter)
731 ram 1.39 (get-setf-expansion place env)
732 ram 1.23 (declare (ignore getter))
733     (let ((inverse (info setf inverse (car place))))
734     (if (and inverse (eq inverse (car setter)))
735     `(,inverse ,@(cdr place) ,value-form)
736 wlott 1.29 `(let* (,@(mapcar #'list dummies vals))
737     (multiple-value-bind ,newval ,value-form
738     ,setter))))))))
739 ram 1.22 ((oddp nargs)
740     (error "Odd number of args to SETF."))
741     (t
742     (do ((a args (cddr a)) (l nil))
743     ((null a) `(progn ,@(nreverse l)))
744     (setq l (cons (list 'setf (car a) (cadr a)) l)))))))
745 ram 1.1
746     (defmacro psetf (&rest args &environment env)
747     "This is to SETF as PSETQ is to SETQ. Args are alternating place
748     expressions and values to go into those places. All of the subforms and
749     values are determined, left to right, and only then are the locations
750     updated. Returns NIL."
751 wlott 1.29 (collect ((let*-bindings) (mv-bindings) (setters))
752     (do ((a args (cddr a)))
753     ((endp a))
754     (if (endp (cdr a))
755     (error "Odd number of args to PSETF."))
756     (multiple-value-bind
757     (dummies vals newval setter getter)
758 ram 1.39 (get-setf-expansion (car a) env)
759 wlott 1.29 (declare (ignore getter))
760     (let*-bindings (mapcar #'list dummies vals))
761     (mv-bindings (list newval (cadr a)))
762     (setters setter)))
763     (labels ((thunk (let*-bindings mv-bindings)
764     (if let*-bindings
765     `(let* ,(car let*-bindings)
766     (multiple-value-bind ,@(car mv-bindings)
767     ,(thunk (cdr let*-bindings) (cdr mv-bindings))))
768     `(progn ,@(setters) nil))))
769     (thunk (let*-bindings) (mv-bindings)))))
770 ram 1.1
771 toy 1.73 (defmacro shiftf (&rest args &environment env)
772 ram 1.1 "One or more SETF-style place expressions, followed by a single
773 wlott 1.29 value expression. Evaluates all of the expressions in turn, then
774     assigns the value of each expression to the place on its left,
775     returning the value of the leftmost."
776 toy 1.73 (when args
777     (collect ((let*-bindings) (mv-bindings) (setters) (getters))
778     ;; The last arg isn't necessarily a place, so we have to handle
779     ;; that separately.
780     (dolist (arg (butlast args))
781     (multiple-value-bind
782     (temps subforms store-vars setter getter)
783     (get-setf-expansion arg env)
784     (loop
785     for temp in temps
786     for subform in subforms
787     do (let*-bindings `(,temp ,subform)))
788     (mv-bindings store-vars)
789     (setters setter)
790     (getters getter)))
791     ;; Handle the last arg specially here. Just put something to
792     ;; force the setter so the setter for the previous var gets set,
793     ;; and the getter is just the last arg itself.
794     (setters nil)
795     (getters (car (last args)))
796    
797     (labels ((thunk (mv-bindings getters)
798     (if mv-bindings
799     `((multiple-value-bind
800     ,(car mv-bindings)
801     ,(car getters)
802     ,@(thunk (cdr mv-bindings) (cdr getters))))
803     `(,@(butlast (setters))))))
804     `(let* ,(let*-bindings)
805     (multiple-value-bind ,(car (mv-bindings))
806     ,(car (getters))
807     ,@(thunk (mv-bindings) (cdr (getters)))
808     (values ,@(car (mv-bindings)))))))))
809 ram 1.1
810     (defmacro rotatef (&rest args &environment env)
811     "Takes any number of SETF-style place expressions. Evaluates all of the
812 wlott 1.29 expressions in turn, then assigns to each place the value of the form to
813     its right. The rightmost form gets the value of the leftmost.
814     Returns NIL."
815     (when args
816     (collect ((let*-bindings) (mv-bindings) (setters) (getters))
817     (dolist (arg args)
818     (multiple-value-bind
819     (temps subforms store-vars setter getter)
820 ram 1.39 (get-setf-expansion arg env)
821 wlott 1.29 (loop
822     for temp in temps
823     for subform in subforms
824     do (let*-bindings `(,temp ,subform)))
825     (mv-bindings store-vars)
826     (setters setter)
827     (getters getter)))
828     (setters nil)
829     (getters (car (getters)))
830     (labels ((thunk (mv-bindings getters)
831     (if mv-bindings
832     `((multiple-value-bind
833     ,(car mv-bindings)
834     ,(car getters)
835     ,@(thunk (cdr mv-bindings) (cdr getters))))
836     (setters))))
837     `(let* ,(let*-bindings)
838     ,@(thunk (mv-bindings) (cdr (getters))))))))
839 ram 1.1
840    
841     (defmacro define-modify-macro (name lambda-list function &optional doc-string)
842     "Creates a new read-modify-write macro like PUSH or INCF."
843     (let ((other-args nil)
844     (rest-arg nil)
845     (env (gensym))
846     (reference (gensym)))
847    
848     ;; Parse out the variable names and rest arg from the lambda list.
849     (do ((ll lambda-list (cdr ll))
850     (arg nil))
851     ((null ll))
852     (setq arg (car ll))
853     (cond ((eq arg '&optional))
854     ((eq arg '&rest)
855     (if (symbolp (cadr ll))
856     (setq rest-arg (cadr ll))
857     (error "Non-symbol &rest arg in definition of ~S." name))
858     (if (null (cddr ll))
859     (return nil)
860     (error "Illegal stuff after &rest arg in Define-Modify-Macro.")))
861     ((memq arg '(&key &allow-other-keys &aux))
862     (error "~S not allowed in Define-Modify-Macro lambda list." arg))
863     ((symbolp arg)
864     (push arg other-args))
865     ((and (listp arg) (symbolp (car arg)))
866     (push (car arg) other-args))
867     (t (error "Illegal stuff in lambda list of Define-Modify-Macro."))))
868     (setq other-args (nreverse other-args))
869     `(defmacro ,name (,reference ,@lambda-list &environment ,env)
870     ,doc-string
871     (multiple-value-bind (dummies vals newval setter getter)
872 wlott 1.13 (get-setf-method ,reference ,env)
873 ram 1.1 (do ((d dummies (cdr d))
874     (v vals (cdr v))
875     (let-list nil (cons (list (car d) (car v)) let-list)))
876     ((null d)
877     (push
878     (list (car newval)
879     ,(if rest-arg
880     `(list* ',function getter ,@other-args ,rest-arg)
881     `(list ',function getter ,@other-args)))
882     let-list)
883     `(let* ,(nreverse let-list)
884     ,setter)))))))
885    
886     (defmacro push (obj place &environment env)
887     "Takes an object and a location holding a list. Conses the object onto
888 pw 1.56 the list, returning the modified list. OBJ is evaluated before PLACE."
889 toy 1.76 (multiple-value-bind (dummies vals newval setter getter)
890     (get-setf-method place env)
891     (let ((g (gensym)))
892     `(let* ((,g ,obj)
893     ,@(mapcar #'list dummies vals)
894     (,(car newval) (cons ,g ,getter)))
895     ,setter))))
896 ram 1.1
897     (defmacro pushnew (obj place &rest keys &environment env)
898     "Takes an object and a location holding a list. If the object is already
899     in the list, does nothing. Else, conses the object onto the list. Returns
900     NIL. If there is a :TEST keyword, this is used for the comparison."
901 toy 1.76 (multiple-value-bind (vars vals stores setter getter)
902     (get-setf-method place env)
903     (let ((tem (gensym)))
904     `(let* ((,tem ,obj)
905     ,@(mapcar #'list vars vals)
906     (,(car stores) (adjoin ,tem ,getter ,@keys)))
907     ,setter))))
908 ram 1.1
909    
910     (defmacro pop (place &environment env)
911     "The argument is a location holding a list. Pops one item off the front
912     of the list and returns it."
913 toy 1.76 (multiple-value-bind (dummies vals newval setter getter)
914     (get-setf-method place env)
915     (do* ((d dummies (cdr d))
916     (v vals (cdr v))
917     (let-list nil))
918     ((null d)
919     (push (list (car newval) getter) let-list)
920     `(let* ,(nreverse let-list)
921     (prog1 (car ,(car newval))
922     (setq ,(car newval) (cdr ,(car newval)))
923     ,setter)))
924     (push (list (car d) (car v)) let-list))))
925 ram 1.1
926    
927     (define-modify-macro incf (&optional (delta 1)) +
928     "The first argument is some location holding a number. This number is
929     incremented by the second argument, DELTA, which defaults to 1.")
930    
931    
932     (define-modify-macro decf (&optional (delta 1)) -
933     "The first argument is some location holding a number. This number is
934     decremented by the second argument, DELTA, which defaults to 1.")
935    
936    
937     (defmacro remf (place indicator &environment env)
938     "Place may be any place expression acceptable to SETF, and is expected
939     to hold a property list or (). This list is destructively altered to
940     remove the property specified by the indicator. Returns T if such a
941     property was present, NIL if not."
942     (multiple-value-bind (dummies vals newval setter getter)
943 wlott 1.13 (get-setf-method place env)
944 ram 1.1 (do* ((d dummies (cdr d))
945     (v vals (cdr v))
946     (let-list nil)
947     (ind-temp (gensym))
948     (local1 (gensym))
949     (local2 (gensym)))
950     ((null d)
951     (push (list (car newval) getter) let-list)
952     (push (list ind-temp indicator) let-list)
953     `(let* ,(nreverse let-list)
954     (do ((,local1 ,(car newval) (cddr ,local1))
955     (,local2 nil ,local1))
956     ((atom ,local1) nil)
957     (cond ((atom (cdr ,local1))
958     (error "Odd-length property list in REMF."))
959     ((eq (car ,local1) ,ind-temp)
960     (cond (,local2
961     (rplacd (cdr ,local2) (cddr ,local1))
962     (return t))
963     (t (setq ,(car newval) (cddr ,(car newval)))
964     ,setter
965     (return t))))))))
966     (push (list (car d) (car v)) let-list))))
967    
968    
969     ;;; The built-in DEFSETFs.
970    
971     (defsetf car %rplaca)
972     (defsetf cdr %rplacd)
973     (defsetf caar (x) (v) `(%rplaca (car ,x) ,v))
974     (defsetf cadr (x) (v) `(%rplaca (cdr ,x) ,v))
975     (defsetf cdar (x) (v) `(%rplacd (car ,x) ,v))
976     (defsetf cddr (x) (v) `(%rplacd (cdr ,x) ,v))
977     (defsetf caaar (x) (v) `(%rplaca (caar ,x) ,v))
978     (defsetf cadar (x) (v) `(%rplaca (cdar ,x) ,v))
979     (defsetf cdaar (x) (v) `(%rplacd (caar ,x) ,v))
980     (defsetf cddar (x) (v) `(%rplacd (cdar ,x) ,v))
981     (defsetf caadr (x) (v) `(%rplaca (cadr ,x) ,v))
982     (defsetf caddr (x) (v) `(%rplaca (cddr ,x) ,v))
983     (defsetf cdadr (x) (v) `(%rplacd (cadr ,x) ,v))
984     (defsetf cdddr (x) (v) `(%rplacd (cddr ,x) ,v))
985     (defsetf caaaar (x) (v) `(%rplaca (caaar ,x) ,v))
986     (defsetf cadaar (x) (v) `(%rplaca (cdaar ,x) ,v))
987     (defsetf cdaaar (x) (v) `(%rplacd (caaar ,x) ,v))
988     (defsetf cddaar (x) (v) `(%rplacd (cdaar ,x) ,v))
989     (defsetf caadar (x) (v) `(%rplaca (cadar ,x) ,v))
990     (defsetf caddar (x) (v) `(%rplaca (cddar ,x) ,v))
991     (defsetf cdadar (x) (v) `(%rplacd (cadar ,x) ,v))
992     (defsetf cdddar (x) (v) `(%rplacd (cddar ,x) ,v))
993     (defsetf caaadr (x) (v) `(%rplaca (caadr ,x) ,v))
994     (defsetf cadadr (x) (v) `(%rplaca (cdadr ,x) ,v))
995     (defsetf cdaadr (x) (v) `(%rplacd (caadr ,x) ,v))
996     (defsetf cddadr (x) (v) `(%rplacd (cdadr ,x) ,v))
997     (defsetf caaddr (x) (v) `(%rplaca (caddr ,x) ,v))
998     (defsetf cadddr (x) (v) `(%rplaca (cdddr ,x) ,v))
999     (defsetf cdaddr (x) (v) `(%rplacd (caddr ,x) ,v))
1000     (defsetf cddddr (x) (v) `(%rplacd (cdddr ,x) ,v))
1001    
1002     (defsetf first %rplaca)
1003     (defsetf second (x) (v) `(%rplaca (cdr ,x) ,v))
1004     (defsetf third (x) (v) `(%rplaca (cddr ,x) ,v))
1005     (defsetf fourth (x) (v) `(%rplaca (cdddr ,x) ,v))
1006     (defsetf fifth (x) (v) `(%rplaca (cddddr ,x) ,v))
1007     (defsetf sixth (x) (v) `(%rplaca (cdr (cddddr ,x)) ,v))
1008     (defsetf seventh (x) (v) `(%rplaca (cddr (cddddr ,x)) ,v))
1009     (defsetf eighth (x) (v) `(%rplaca (cdddr (cddddr ,x)) ,v))
1010     (defsetf ninth (x) (v) `(%rplaca (cddddr (cddddr ,x)) ,v))
1011     (defsetf tenth (x) (v) `(%rplaca (cdr (cddddr (cddddr ,x))) ,v))
1012     (defsetf rest %rplacd)
1013    
1014     (defsetf elt %setelt)
1015     (defsetf aref %aset)
1016 wlott 1.10 (defsetf row-major-aref %set-row-major-aref)
1017 ram 1.1 (defsetf svref %svset)
1018     (defsetf char %charset)
1019     (defsetf bit %bitset)
1020     (defsetf schar %scharset)
1021     (defsetf sbit %sbitset)
1022 wlott 1.10 (defsetf %array-dimension %set-array-dimension)
1023     (defsetf %raw-bits %set-raw-bits)
1024 ram 1.1 (defsetf symbol-value set)
1025 wlott 1.28 (defsetf symbol-function fset)
1026     (defsetf symbol-plist %set-symbol-plist)
1027 ram 1.1 (defsetf nth %setnth)
1028     (defsetf fill-pointer %set-fill-pointer)
1029     (defsetf search-list %set-search-list)
1030    
1031 wlott 1.10 (defsetf sap-ref-8 %set-sap-ref-8)
1032 wlott 1.27 (defsetf signed-sap-ref-8 %set-signed-sap-ref-8)
1033 wlott 1.10 (defsetf sap-ref-16 %set-sap-ref-16)
1034 wlott 1.27 (defsetf signed-sap-ref-16 %set-signed-sap-ref-16)
1035 wlott 1.10 (defsetf sap-ref-32 %set-sap-ref-32)
1036 wlott 1.27 (defsetf signed-sap-ref-32 %set-signed-sap-ref-32)
1037 hallgren 1.44 (defsetf sap-ref-64 %set-sap-ref-64)
1038     (defsetf signed-sap-ref-64 %set-signed-sap-ref-64)
1039 wlott 1.10 (defsetf sap-ref-sap %set-sap-ref-sap)
1040     (defsetf sap-ref-single %set-sap-ref-single)
1041     (defsetf sap-ref-double %set-sap-ref-double)
1042 dtc 1.54 #+long-float
1043     (defsetf sap-ref-long %set-sap-ref-long)
1044 ram 1.1
1045 dtc 1.58 (define-setf-expander getf (place prop &optional default &environment env)
1046 ram 1.1 (multiple-value-bind (temps values stores set get)
1047 wlott 1.13 (get-setf-method place env)
1048 ram 1.1 (let ((newval (gensym))
1049     (ptemp (gensym))
1050 wlott 1.31 (def-temp (if default (gensym))))
1051     (values `(,@temps ,ptemp ,@(if default `(,def-temp)))
1052     `(,@values ,prop ,@(if default `(,default)))
1053 ram 1.1 `(,newval)
1054 wlott 1.31 `(let ((,(car stores) (%putf ,get ,ptemp ,newval)))
1055     ,set
1056     ,newval)
1057     `(getf ,get ,ptemp ,@(if default `(,def-temp)))))))
1058 ram 1.1
1059 dtc 1.58 (define-setf-expander get (symbol prop &optional default)
1060 ram 1.1 (let ((symbol-temp (gensym))
1061     (prop-temp (gensym))
1062     (def-temp (gensym))
1063     (newval (gensym)))
1064     (values `(,symbol-temp ,prop-temp ,@(if default `(,def-temp)))
1065     `(,symbol ,prop ,@(if default `(,default)))
1066     (list newval)
1067     `(%put ,symbol-temp ,prop-temp ,newval)
1068     `(get ,symbol-temp ,prop-temp ,@(if default `(,def-temp))))))
1069    
1070 dtc 1.58 (define-setf-expander gethash (key hashtable &optional default)
1071 ram 1.1 (let ((key-temp (gensym))
1072     (hashtable-temp (gensym))
1073     (default-temp (gensym))
1074     (new-value-temp (gensym)))
1075     (values
1076     `(,key-temp ,hashtable-temp ,@(if default `(,default-temp)))
1077     `(,key ,hashtable ,@(if default `(,default)))
1078     `(,new-value-temp)
1079     `(%puthash ,key-temp ,hashtable-temp ,new-value-temp)
1080     `(gethash ,key-temp ,hashtable-temp ,@(if default `(,default-temp))))))
1081    
1082     (defsetf subseq (sequence start &optional (end nil)) (v)
1083     `(progn (replace ,sequence ,v :start1 ,start :end1 ,end)
1084     ,v))
1085    
1086    
1087 ram 1.36 ;;; Evil hack invented by the gnomes of Vassar Street (though not as evil as
1088     ;;; it used to be.) The function arg must be constant, and is converted to an
1089     ;;; APPLY of ther SETF function, which ought to exist.
1090 ram 1.22 ;;;
1091 dtc 1.58 (define-setf-expander apply (function &rest args)
1092 ram 1.22 (unless (and (listp function)
1093     (= (list-length function) 2)
1094     (eq (first function) 'function)
1095     (symbolp (second function)))
1096     (error "Setf of Apply is only defined for function args like #'symbol."))
1097 ram 1.36 (let ((function (second function))
1098     (new-var (gensym))
1099     (vars nil))
1100     (dolist (x args)
1101     (declare (ignore x))
1102     (push (gensym) vars))
1103     (values vars args (list new-var)
1104     `(apply #'(setf ,function) ,new-var ,@vars)
1105     `(apply #',function ,@vars))))
1106 ram 1.1
1107    
1108 wlott 1.10 ;;; Special-case a BYTE bytespec so that the compiler can recognize it.
1109     ;;;
1110 dtc 1.58 (define-setf-expander ldb (bytespec place &environment env)
1111 ram 1.1 "The first argument is a byte specifier. The second is any place form
1112     acceptable to SETF. Replaces the specified byte of the number in this
1113     place with bits from the low-order end of the new value."
1114     (multiple-value-bind (dummies vals newval setter getter)
1115 wlott 1.13 (get-setf-method place env)
1116 wlott 1.10 (if (and (consp bytespec) (eq (car bytespec) 'byte))
1117     (let ((n-size (gensym))
1118     (n-pos (gensym))
1119     (n-new (gensym)))
1120     (values (list* n-size n-pos dummies)
1121     (list* (second bytespec) (third bytespec) vals)
1122     (list n-new)
1123     `(let ((,(car newval) (dpb ,n-new (byte ,n-size ,n-pos)
1124     ,getter)))
1125     ,setter
1126     ,n-new)
1127     `(ldb (byte ,n-size ,n-pos) ,getter)))
1128     (let ((btemp (gensym))
1129     (gnuval (gensym)))
1130     (values (cons btemp dummies)
1131     (cons bytespec vals)
1132     (list gnuval)
1133     `(let ((,(car newval) (dpb ,gnuval ,btemp ,getter)))
1134     ,setter
1135     ,gnuval)
1136     `(ldb ,btemp ,getter))))))
1137 ram 1.1
1138    
1139 dtc 1.58 (define-setf-expander mask-field (bytespec place &environment env)
1140 ram 1.1 "The first argument is a byte specifier. The second is any place form
1141     acceptable to SETF. Replaces the specified byte of the number in this place
1142     with bits from the corresponding position in the new value."
1143     (multiple-value-bind (dummies vals newval setter getter)
1144 wlott 1.13 (get-setf-method place env)
1145 ram 1.1 (let ((btemp (gensym))
1146     (gnuval (gensym)))
1147     (values (cons btemp dummies)
1148     (cons bytespec vals)
1149     (list gnuval)
1150     `(let ((,(car newval) (deposit-field ,gnuval ,btemp ,getter)))
1151     ,setter
1152     ,gnuval)
1153     `(mask-field ,btemp ,getter)))))
1154    
1155    
1156 dtc 1.58 (define-setf-expander the (type place &environment env)
1157 ram 1.1 (multiple-value-bind (dummies vals newval setter getter)
1158 wlott 1.13 (get-setf-method place env)
1159 ram 1.1 (values dummies
1160     vals
1161     newval
1162     (subst `(the ,type ,(car newval)) (car newval) setter)
1163     `(the ,type ,getter))))
1164 dtc 1.58
1165     (define-setf-expander values (&rest places &environment env)
1166     (collect ((setters) (getters))
1167     (let ((all-dummies '())
1168     (all-vals '())
1169     (newvals '()))
1170     (dolist (place places)
1171     (multiple-value-bind (dummies vals newval setter getter)
1172     (get-setf-expansion place env)
1173     (setf all-dummies (append all-dummies dummies))
1174     (setf all-vals (append all-vals vals))
1175     (setf newvals (append newvals newval))
1176     (setters setter)
1177     (getters getter)))
1178     (values all-dummies all-vals newvals
1179     `(values ,@(setters)) `(values ,@(getters))))))
1180 ram 1.1
1181    
1182     ;;;; CASE, TYPECASE, & Friends.
1183    
1184     (eval-when (compile load eval)
1185    
1186     ;;; CASE-BODY returns code for all the standard "case" macros. Name is the
1187     ;;; macro name, and keyform is the thing to case on. Multi-p indicates whether
1188     ;;; a branch may fire off a list of keys; otherwise, a key that is a list is
1189     ;;; interpreted in some way as a single key. When multi-p, test is applied to
1190     ;;; the value of keyform and each key for a given branch; otherwise, test is
1191     ;;; applied to the value of keyform and the entire first element, instead of
1192     ;;; each part, of the case branch. When errorp, no t or otherwise branch is
1193     ;;; permitted, and an ERROR form is generated. When proceedp, it is an error
1194     ;;; to omit errorp, and the ERROR form generated is executed within a
1195     ;;; RESTART-CASE allowing keyform to be set and retested.
1196     ;;;
1197 toy 1.74 ;;; If ALLOW-OTHERWISE, then we allow T and OTHERWISE clauses and also
1198     ;;; generate an ERROR form. (This is for CCASE and ECASE which allow
1199     ;;; using T and OTHERWISE as regular keys.)
1200     ;;;
1201     (defun case-body (name keyform cases multi-p test errorp proceedp &optional allow-otherwise)
1202 ram 1.1 (let ((keyform-value (gensym))
1203     (clauses ())
1204     (keys ()))
1205     (dolist (case cases)
1206     (cond ((atom case)
1207     (error "~S -- Bad clause in ~S." case name))
1208 toy 1.74 ((and (not allow-otherwise)
1209     (memq (car case) '(t otherwise)))
1210 ram 1.1 (if errorp
1211     (error "No default clause allowed in ~S: ~S" name case)
1212     (push `(t nil ,@(rest case)) clauses)))
1213     ((and multi-p (listp (first case)))
1214     (setf keys (append (first case) keys))
1215     (push `((or ,@(mapcar #'(lambda (key)
1216     `(,test ,keyform-value ',key))
1217     (first case)))
1218     nil ,@(rest case))
1219     clauses))
1220     (t
1221 toy 1.74 (when (and allow-otherwise
1222     (memq (car case) '(t otherwise)))
1223     (warn "Bad style to use T or OTHERWISE in ECASE or CCASE"))
1224 ram 1.1 (push (first case) keys)
1225     (push `((,test ,keyform-value
1226     ',(first case)) nil ,@(rest case)) clauses))))
1227     (case-body-aux name keyform keyform-value clauses keys errorp proceedp
1228 toy 1.74 allow-otherwise
1229 ram 1.1 `(,(if multi-p 'member 'or) ,@keys))))
1230    
1231     ;;; CASE-BODY-AUX provides the expansion once CASE-BODY has groveled all the
1232     ;;; cases. Note: it is not necessary that the resulting code signal
1233     ;;; case-failure conditions, but that's what KMP's prototype code did. We call
1234     ;;; CASE-BODY-ERROR, because of how closures are compiled. RESTART-CASE has
1235     ;;; forms with closures that the compiler causes to be generated at the top of
1236     ;;; any function using the case macros, regardless of whether they are needed.
1237     ;;;
1238     (defun case-body-aux (name keyform keyform-value clauses keys
1239 toy 1.74 errorp proceedp allow-otherwise expected-type)
1240 ram 1.1 (if proceedp
1241     (let ((block (gensym))
1242     (again (gensym)))
1243     `(let ((,keyform-value ,keyform))
1244     (block ,block
1245     (tagbody
1246     ,again
1247     (return-from
1248     ,block
1249     (cond ,@(nreverse clauses)
1250     (t
1251     (setf ,keyform-value
1252     (setf ,keyform
1253     (case-body-error
1254     ',name ',keyform ,keyform-value
1255     ',expected-type ',keys)))
1256     (go ,again))))))))
1257     `(let ((,keyform-value ,keyform))
1258 pw 1.49 ,keyform-value ; prevent warnings when key not used eg (case key (t))
1259 ram 1.1 (cond
1260     ,@(nreverse clauses)
1261 toy 1.74 ,@(if (or errorp allow-otherwise)
1262 ram 1.1 `((t (error 'conditions::case-failure
1263     :name ',name
1264     :datum ,keyform-value
1265     :expected-type ',expected-type
1266     :possibilities ',keys))))))))
1267    
1268     ); eval-when
1269    
1270     (defun case-body-error (name keyform keyform-value expected-type keys)
1271     (restart-case
1272     (error 'conditions::case-failure
1273     :name name
1274     :datum keyform-value
1275     :expected-type expected-type
1276     :possibilities keys)
1277     (store-value (value)
1278     :report (lambda (stream)
1279     (format stream "Supply a new value for ~S." keyform))
1280     :interactive read-evaluated-form
1281     value)))
1282    
1283    
1284     (defmacro case (keyform &body cases)
1285     "CASE Keyform {({(Key*) | Key} Form*)}*
1286     Evaluates the Forms in the first clause with a Key EQL to the value of
1287     Keyform. If a singleton key is T then the clause is a default clause."
1288     (case-body 'case keyform cases t 'eql nil nil))
1289    
1290     (defmacro ccase (keyform &body cases)
1291     "CCASE Keyform {({(Key*) | Key} Form*)}*
1292     Evaluates the Forms in the first clause with a Key EQL to the value of
1293     Keyform. If none of the keys matches then a correctable error is
1294     signalled."
1295 toy 1.74 (case-body 'ccase keyform cases t 'eql nil t t))
1296 ram 1.1
1297     (defmacro ecase (keyform &body cases)
1298     "ECASE Keyform {({(Key*) | Key} Form*)}*
1299     Evaluates the Forms in the first clause with a Key EQL to the value of
1300     Keyform. If none of the keys matches then an error is signalled."
1301 toy 1.74 (case-body 'ecase keyform cases t 'eql nil nil t))
1302 ram 1.1
1303     (defmacro typecase (keyform &body cases)
1304     "TYPECASE Keyform {(Type Form*)}*
1305     Evaluates the Forms in the first clause for which TYPEP of Keyform and Type
1306     is true."
1307     (case-body 'typecase keyform cases nil 'typep nil nil))
1308    
1309     (defmacro ctypecase (keyform &body cases)
1310     "CTYPECASE Keyform {(Type Form*)}*
1311     Evaluates the Forms in the first clause for which TYPEP of Keyform and Type
1312     is true. If no form is satisfied then a correctable error is signalled."
1313 toy 1.75 (case-body 'ctypecase keyform cases nil 'typep nil t t))
1314 ram 1.1
1315     (defmacro etypecase (keyform &body cases)
1316     "ETYPECASE Keyform {(Type Form*)}*
1317     Evaluates the Forms in the first clause for which TYPEP of Keyform and Type
1318     is true. If no form is satisfied then an error is signalled."
1319 toy 1.75 (case-body 'etypecase keyform cases nil 'typep nil nil t))
1320 ram 1.1
1321    
1322     ;;;; ASSERT and CHECK-TYPE.
1323    
1324     ;;; ASSERT is written this way, to call ASSERT-ERROR, because of how closures
1325     ;;; are compiled. RESTART-CASE has forms with closures that the compiler
1326     ;;; causes to be generated at the top of any function using ASSERT, regardless
1327     ;;; of whether they are needed.
1328     ;;;
1329     (defmacro assert (test-form &optional places datum &rest arguments)
1330     "Signals an error if the value of test-form is nil. Continuing from this
1331     error using the CONTINUE restart will allow the user to alter the value of
1332     some locations known to SETF, starting over with test-form. Returns nil."
1333     `(loop
1334     (when ,test-form (return nil))
1335     (assert-error ',test-form ',places ,datum ,@arguments)
1336     ,@(mapcar #'(lambda (place)
1337     `(setf ,place (assert-prompt ',place ,place)))
1338     places)))
1339    
1340 ram 1.42 (defun assert-error (assertion places datum &rest arguments)
1341 ram 1.41 (let ((cond (if datum
1342     (conditions::coerce-to-condition
1343     datum arguments
1344     'simple-error 'error)
1345     (make-condition 'simple-error
1346     :format-control "The assertion ~S failed."
1347     :format-arguments (list assertion)))))
1348     (restart-case (error cond)
1349 ram 1.1 (continue ()
1350     :report (lambda (stream) (assert-report places stream))
1351 ram 1.41 nil))))
1352 ram 1.1
1353    
1354     (defun assert-report (names stream)
1355     (format stream "Retry assertion")
1356     (if names
1357     (format stream " with new value~P for ~{~S~^, ~}."
1358     (length names) names)
1359     (format stream ".")))
1360    
1361     (defun assert-prompt (name value)
1362     (cond ((y-or-n-p "The old value of ~S is ~S.~
1363     ~%Do you want to supply a new value? "
1364     name value)
1365     (format *query-io* "~&Type a form to be evaluated:~%")
1366     (flet ((read-it () (eval (read *query-io*))))
1367     (if (symbolp name) ;help user debug lexical variables
1368     (progv (list name) (list value) (read-it))
1369     (read-it))))
1370     (t value)))
1371    
1372    
1373     ;;; CHECK-TYPE is written this way, to call CHECK-TYPE-ERROR, because of how
1374     ;;; closures are compiled. RESTART-CASE has forms with closures that the
1375     ;;; compiler causes to be generated at the top of any function using
1376     ;;; CHECK-TYPE, regardless of whether they are needed. Because it would be
1377     ;;; nice if this were cheap to use, and some things can't afford this excessive
1378     ;;; consing (e.g., READ-CHAR), we bend backwards a little.
1379     ;;;
1380    
1381     (defmacro check-type (place type &optional type-string)
1382     "Signals an error of type type-error if the contents of place are not of the
1383     specified type. If an error is signaled, this can only return if
1384     STORE-VALUE is invoked. It will store into place and start over."
1385     (let ((place-value (gensym)))
1386     `(loop
1387     (let ((,place-value ,place))
1388     (when (typep ,place-value ',type) (return nil))
1389     (setf ,place
1390     (check-type-error ',place ,place-value ',type ,type-string))))))
1391    
1392     (defun check-type-error (place place-value type type-string)
1393 ram 1.41 (let ((cond (if type-string
1394     (make-condition 'simple-type-error
1395     :datum place :expected-type type
1396     :format-control
1397     "The value of ~S is ~S, which is not ~A."
1398     :format-arguments
1399     (list place place-value type-string))
1400     (make-condition 'simple-type-error
1401     :datum place :expected-type type
1402     :format-control
1403     "The value of ~S is ~S, which is not of type ~S."
1404     :format-arguments
1405     (list place place-value type)))))
1406     (restart-case (error cond)
1407     (store-value (value)
1408     :report (lambda (stream)
1409     (format stream "Supply a new value of ~S."
1410     place))
1411     :interactive read-evaluated-form
1412     value))))
1413 ram 1.1
1414     ;;; READ-EVALUATED-FORM is used as the interactive method for restart cases
1415     ;;; setup by the Common Lisp "casing" (e.g., CCASE and CTYPECASE) macros
1416     ;;; and by CHECK-TYPE.
1417     ;;;
1418     (defun read-evaluated-form ()
1419     (format *query-io* "~&Type a form to be evaluated:~%")
1420     (list (eval (read *query-io*))))
1421    
1422    
1423     ;;;; With-XXX
1424     (defmacro with-open-file ((var &rest open-args) &body (forms decls))
1425 ram 1.5 "Bindspec is of the form (Stream File-Name . Options). The file whose
1426     name is File-Name is opened using the Options and bound to the variable
1427 pw 1.47 Stream. If the call to open is unsuccessful, the forms are not
1428     evaluated. The Forms are executed, and when they
1429     terminate, normally or otherwise, the file is closed."
1430 ram 1.1 (let ((abortp (gensym)))
1431     `(let ((,var (open ,@open-args))
1432     (,abortp t))
1433     ,@decls
1434 pw 1.47 (unwind-protect
1435     (multiple-value-prog1
1436     (progn ,@forms)
1437     (setq ,abortp nil))
1438     (when ,var
1439 ram 1.1 (close ,var :abort ,abortp))))))
1440    
1441 ram 1.5
1442 ram 1.1 (defmacro with-open-stream ((var stream) &body (forms decls))
1443     "The form stream should evaluate to a stream. VAR is bound
1444     to the stream and the forms are evaluated as an implicit
1445     progn. The stream is closed upon exit."
1446     (let ((abortp (gensym)))
1447     `(let ((,var ,stream)
1448     (,abortp t))
1449     ,@decls
1450     (unwind-protect
1451     (multiple-value-prog1
1452     (progn ,@forms)
1453     (setq ,abortp nil))
1454     (when ,var
1455     (close ,var :abort ,abortp))))))
1456    
1457    
1458     (defmacro with-input-from-string ((var string &key index start end) &body (forms decls))
1459     "Binds the Var to an input stream that returns characters from String and
1460     executes the body. See manual for details."
1461 pw 1.52 ;; The once-only inhibits compiler note for unreachable code when 'end' is true.
1462     (once-only ((string string))
1463     `(let ((,var
1464     ,(cond ((null end)
1465     `(make-string-input-stream ,string ,(or start 0)))
1466     ((symbolp end)
1467     `(if ,end
1468     (make-string-input-stream ,string ,(or start 0) ,end)
1469     (make-string-input-stream ,string ,(or start 0))))
1470     (t
1471     `(make-string-input-stream ,string ,(or start 0) ,end)))))
1472     ,@decls
1473     (unwind-protect
1474     (progn ,@forms)
1475     (close ,var)
1476     ,@(if index `((setf ,index (string-input-stream-current ,var))))))))
1477 ram 1.1
1478    
1479     (defmacro with-output-to-string ((var &optional string) &body (forms decls))
1480 ram 1.5 "If *string* is specified, it must be a string with a fill pointer;
1481     the output is incrementally appended to the string (as if by use of
1482     VECTOR-PUSH-EXTEND)."
1483 ram 1.1 (if string
1484     `(let ((,var (make-fill-pointer-output-stream ,string)))
1485     ,@decls
1486     (unwind-protect
1487     (progn ,@forms)
1488     (close ,var)))
1489     `(let ((,var (make-string-output-stream)))
1490     ,@decls
1491     (unwind-protect
1492     (progn ,@forms)
1493     (close ,var))
1494     (get-output-stream-string ,var))))
1495    
1496    
1497     ;;;; Iteration macros:
1498    
1499     (defmacro dotimes ((var count &optional (result nil)) &body body)
1500     (cond ((numberp count)
1501     `(do ((,var 0 (1+ ,var)))
1502     ((>= ,var ,count) ,result)
1503 toy 1.71 (declare (type (integer 0 ,count) ,var))
1504 ram 1.1 ,@body))
1505     (t (let ((v1 (gensym)))
1506     `(do ((,var 0 (1+ ,var)) (,v1 ,count))
1507     ((>= ,var ,v1) ,result)
1508 ram 1.8 (declare (type unsigned-byte ,var))
1509 ram 1.1 ,@body)))))
1510    
1511    
1512     ;;; We repeatedly bind the var instead of setting it so that we never give the
1513     ;;; var a random value such as NIL (which might conflict with a declaration).
1514 ram 1.35 ;;; If there is a result form, we introduce a gratitous binding of the variable
1515     ;;; to NIL w/o the declarations, then evaluate the result form in that
1516     ;;; environment. We spuriously reference the gratuitous variable, since we
1517     ;;; don't want to use IGNORABLE on what might be a special var.
1518 ram 1.1 ;;;
1519     (defmacro dolist ((var list &optional (result nil)) &body body)
1520     (let ((n-list (gensym)))
1521     `(do ((,n-list ,list (cdr ,n-list)))
1522     ((endp ,n-list)
1523 ram 1.35 ,@(if result
1524     `((let ((,var nil))
1525     ,var
1526     ,result))
1527     '(nil)))
1528 ram 1.1 (let ((,var (car ,n-list)))
1529     ,@body))))
1530    
1531    
1532     (defmacro do (varlist endlist &body (body decls))
1533     "DO ({(Var [Init] [Step])}*) (Test Exit-Form*) Declaration* Form*
1534     Iteration construct. Each Var is initialized in parallel to the value of the
1535     specified Init form. On subsequent iterations, the Vars are assigned the
1536     value of the Step form (if any) in paralell. The Test is evaluated before
1537 dtc 1.53 each evaluation of the body Forms. When the Test is true, the Exit-Forms
1538 ram 1.1 are evaluated as a PROGN, with the result being the value of the DO. A block
1539     named NIL is established around the entire expansion, allowing RETURN to be
1540     used as an laternate exit mechanism."
1541    
1542     (do-do-body varlist endlist body decls 'let 'psetq 'do nil))
1543    
1544    
1545     (defmacro do* (varlist endlist &body (body decls))
1546     "DO* ({(Var [Init] [Step])}*) (Test Exit-Form*) Declaration* Form*
1547     Iteration construct. Each Var is initialized sequentially (like LET*) to the
1548     value of the specified Init form. On subsequent iterations, the Vars are
1549     sequentially assigned the value of the Step form (if any). The Test is
1550     evaluated before each evaluation of the body Forms. When the Test is true,
1551 dtc 1.53 the Exit-Forms are evaluated as a PROGN, with the result being the value
1552 ram 1.1 of the DO. A block named NIL is established around the entire expansion,
1553     allowing RETURN to be used as an laternate exit mechanism."
1554     (do-do-body varlist endlist body decls 'let* 'setq 'do* nil))
1555    
1556    
1557     ;;;; Miscellaneous macros:
1558    
1559     (defmacro psetq (&rest pairs)
1560     (do ((lets nil)
1561     (setqs nil)
1562     (pairs pairs (cddr pairs)))
1563     ((atom (cdr pairs))
1564 dtc 1.59 `(let ,(nreverse lets) (setq ,@(nreverse setqs)) nil))
1565 ram 1.1 (let ((gen (gensym)))
1566     (push `(,gen ,(cadr pairs)) lets)
1567     (push (car pairs) setqs)
1568     (push gen setqs))))
1569 pw 1.48
1570     ;;; LAMBDA -- from the ANSI spec.
1571     ;;;
1572     (defmacro lambda (&whole form &rest bvl-decls-and-body)
1573     (declare (ignore bvl-decls-and-body))
1574     `#',form)
1575    
1576 ram 1.1
1577    
1578     ;;;; With-Compilation-Unit:
1579    
1580     ;;; True if we are within a With-Compilation-Unit form, which normally causes
1581     ;;; nested uses to be NOOPS.
1582     ;;;
1583     (defvar *in-compilation-unit* nil)
1584    
1585     ;;; Count of the number of compilation units dynamically enclosed by the
1586     ;;; current active WITH-COMPILATION-UNIT that were unwound out of.
1587     ;;;
1588     (defvar *aborted-compilation-units*)
1589    
1590 ram 1.21 (declaim (special c::*context-declarations*))
1591    
1592    
1593     ;;; EVALUATE-DECLARATION-CONTEXT -- Internal
1594     ;;;
1595     ;;; Recursively descend the context form, returning true if this subpart
1596     ;;; matches the specified context.
1597     ;;;
1598     (defun evaluate-declaration-context (context name parent)
1599 ram 1.24 (let* ((base (if (and (consp name) (consp (cdr name)))
1600     (cadr name)
1601     name))
1602     (package (and (symbolp base) (symbol-package base))))
1603 ram 1.21 (if (atom context)
1604 ram 1.24 (multiple-value-bind (ignore how)
1605     (if package
1606     (find-symbol (symbol-name base) package)
1607     (values nil nil))
1608     (declare (ignore ignore))
1609     (case context
1610     (:internal (eq how :internal))
1611     (:external (eq how :external))
1612     (:uninterned (and (symbolp base) (not package)))
1613     (:anonymous (not name))
1614     (:macro (eq parent 'defmacro))
1615     (:function (member parent '(defun labels flet function)))
1616     (:global (member parent '(defun defmacro function)))
1617     (:local (member parent '(labels flet)))
1618     (t
1619     (error "Unknown declaration context: ~S." context))))
1620 ram 1.21 (case (first context)
1621     (:or
1622     (loop for x in (rest context)
1623     thereis (evaluate-declaration-context x name parent)))
1624     (:and
1625     (loop for x in (rest context)
1626     always (evaluate-declaration-context x name parent)))
1627     (:not
1628     (evaluate-declaration-context (second context) name parent))
1629     (:member
1630     (member name (rest context) :test #'equal))
1631     (:match
1632     (let ((name (concatenate 'string "$" (string base) "$")))
1633     (loop for x in (rest context)
1634     thereis (search (string x) name))))
1635 ram 1.24 (:package
1636     (and package
1637     (loop for x in (rest context)
1638     thereis (eq (find-package (string x)) package))))
1639 ram 1.21 (t
1640     (error "Unknown declaration context: ~S." context))))))
1641    
1642    
1643     ;;; PROCESS-CONTEXT-DECLARATIONS -- Internal
1644     ;;;
1645     ;;; Given a list of context declaration specs, return a new value for
1646     ;;; C::*CONTEXT-DECLARATIONS*.
1647     ;;;
1648     (defun process-context-declarations (decls)
1649     (append
1650     (mapcar
1651     #'(lambda (decl)
1652     (unless (>= (length decl) 2)
1653     (error "Context declaration spec should have context and at ~
1654     least one DECLARE form:~% ~S" decl))
1655     #'(lambda (name parent)
1656     (when (evaluate-declaration-context (first decl) name parent)
1657     (rest decl))))
1658     decls)
1659     c::*context-declarations*))
1660    
1661    
1662 ram 1.1 ;;; With-Compilation-Unit -- Public
1663     ;;;
1664     (defmacro with-compilation-unit (options &body body)
1665 ram 1.21 "WITH-COMPILATION-UNIT ({Key Value}*) Form*
1666     This form affects compilations that take place within its dynamic extent. It
1667     is intended to be wrapped around the compilation of all files in the same
1668     system. These keywords are defined:
1669     :OVERRIDE Boolean-Form
1670     One of the effects of this form is to delay undefined warnings
1671     until the end of the form, instead of giving them at the end of each
1672     compilation. If OVERRIDE is NIL (the default), then the outermost
1673     WITH-COMPILATION-UNIT form grabs the undefined warnings. Specifying
1674     OVERRIDE true causes that form to grab any enclosed warnings, even if
1675     it is enclosed by another WITH-COMPILATION-UNIT.
1676     :OPTIMIZE Decl-Form
1677     Decl-Form should evaluate to an OPTIMIZE declaration specifier. This
1678     declaration changes the `global' policy for compilations within the
1679     body.
1680     :OPTIMIZE-INTERFACE Decl-Form
1681     Like OPTIMIZE, except that it specifies the value of the CMU extension
1682     OPTIMIZE-INTERFACE policy (which controls argument type and syntax
1683     checking.)
1684     :CONTEXT-DECLARATIONS List-of-Context-Decls-Form
1685     This is a CMU extension which allows compilation to be controlled
1686     by pattern matching on the context in which a definition appears. The
1687     argument should evaluate to a list of lists of the form:
1688     (Context-Spec Declare-Form+)
1689     In the indicated context, the specified declare forms are inserted at
1690     the head of each definition. The declare forms for all contexts that
1691     match are appended together, with earlier declarations getting
1692     predecence over later ones. A simple example:
1693     :context-declarations
1694     '((:external (declare (optimize (safety 2)))))
1695     This will cause all functions that are named by external symbols to be
1696     compiled with SAFETY 2. The full syntax of context specs is:
1697     :INTERNAL, :EXTERNAL
1698     True if the symbols is internal (external) in its home package.
1699     :UNINTERNED
1700     True if the symbol has no home package.
1701     :ANONYMOUS
1702     True if the function doesn't have any interesting name (not
1703     DEFMACRO, DEFUN, LABELS or FLET).
1704     :MACRO, :FUNCTION
1705     :MACRO is a global (DEFMACRO) macro. :FUNCTION is anything else.
1706     :LOCAL, :GLOBAL
1707     :LOCAL is a LABELS or FLET. :GLOBAL is anything else.
1708     (:OR Context-Spec*)
1709     True in any specified context.
1710     (:AND Context-Spec*)
1711     True only when all specs are true.
1712     (:NOT Context-Spec)
1713     True when the spec is false.
1714     (:MEMBER Name*)
1715     True when the name is one of these names (EQUAL test.)
1716     (:MATCH Pattern*)
1717     True when any of the patterns is a substring of the name. The name
1718     is wrapped with $'s, so $FOO matches names beginning with FOO,
1719     etc."
1720     (let ((override nil)
1721     (optimize nil)
1722     (optimize-interface nil)
1723     (context-declarations nil)
1724 ram 1.1 (n-fun (gensym))
1725     (n-abort-p (gensym)))
1726     (when (oddp (length options))
1727     (error "Odd number of key/value pairs: ~S." options))
1728     (do ((opt options (cddr opt)))
1729     ((null opt))
1730     (case (first opt)
1731 ram 1.21 (:override
1732     (setq override (second opt)))
1733     (:optimize
1734     (setq optimize (second opt)))
1735     (:optimize-interface
1736     (setq optimize-interface (second opt)))
1737     (:context-declarations
1738     (setq context-declarations (second opt)))
1739 ram 1.1 (t
1740     (warn "Ignoring unknown option: ~S." (first opt)))))
1741    
1742 ram 1.21 `(flet ((,n-fun ()
1743     (let (,@(when optimize
1744     `((c::*default-cookie*
1745     (c::process-optimize-declaration
1746     ,optimize c::*default-cookie*))))
1747     ,@(when optimize-interface
1748     `((c::*default-interface-cookie*
1749     (c::process-optimize-declaration
1750     ,optimize-interface
1751     c::*default-interface-cookie*))))
1752     ,@(when context-declarations
1753     `((c::*context-declarations*
1754     (process-context-declarations
1755     ,context-declarations)))))
1756     ,@body)))
1757     (if (or ,override (not *in-compilation-unit*))
1758 ram 1.6 (let ((c::*undefined-warnings* nil)
1759 ram 1.1 (c::*compiler-error-count* 0)
1760     (c::*compiler-warning-count* 0)
1761     (c::*compiler-note-count* 0)
1762     (*in-compilation-unit* t)
1763     (*aborted-compilation-units* 0)
1764     (,n-abort-p t))
1765 ram 1.6 (handler-bind ((c::parse-unknown-type
1766     #'(lambda (c)
1767     (c::note-undefined-reference
1768     (c::parse-unknown-type-specifier c)
1769     :type))))
1770     (unwind-protect
1771     (multiple-value-prog1
1772     (,n-fun)
1773     (setq ,n-abort-p nil))
1774     (c::print-summary ,n-abort-p *aborted-compilation-units*))))
1775 ram 1.1 (let ((,n-abort-p t))
1776     (unwind-protect
1777     (multiple-value-prog1
1778     (,n-fun)
1779     (setq ,n-abort-p nil))
1780     (when ,n-abort-p
1781     (incf *aborted-compilation-units*))))))))

  ViewVC Help
Powered by ViewVC 1.1.5