Newer
Older
;;; -*- Log: code.log; Package: Lisp -*-
;;;
;;; **********************************************************************
;;; This code was written as part of the CMU Common Lisp project at
;;; Carnegie Mellon University, and has been placed in the public domain.
;;;
(ext:file-comment
"$Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/code/macros.lisp,v 1.50 1997/06/05 13:02:45 pw Exp $")
;;; **********************************************************************
;;;
;;; This file contains the macros that are part of the standard
;;; Spice Lisp environment.
;;;
;;; Written by Scott Fahlman and Rob MacLachlan.
;;; Modified by Bill Chiles to adhere to the wall.
(export '(defvar defparameter defconstant when unless setf
defsetf psetf shiftf rotatef push pushnew pop
incf decf remf case typecase with-open-file
with-open-stream with-input-from-string with-output-to-string
locally etypecase ctypecase ecase ccase
get-setf-expansion define-setf-expander
define-compiler-macro
;; CLtL1 versions:
define-setf-method get-setf-method get-setf-method-multiple-value))
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
(in-package "EXTENSIONS")
(export '(do-anonymous collect iterate))
(in-package "LISP")
;;; Parse-Body -- Public
;;;
;;; Parse out declarations and doc strings, *not* expanding macros.
;;; Eventually the environment arg should be flushed, since macros can't expand
;;; into declarations anymore.
;;;
(defun parse-body (body environment &optional (doc-string-allowed t))
"This function is to parse the declarations and doc-string out of the body of
a defun-like form. Body is the list of stuff which is to be parsed.
Environment is ignored. If Doc-String-Allowed is true, then a doc string
will be parsed out of the body and returned. If it is false then a string
will terminate the search for declarations. Three values are returned: the
tail of Body after the declarations and doc strings, a list of declare forms,
and the doc-string, or NIL if none."
(declare (ignore environment))
(let ((decls ())
(doc nil))
(do ((tail body (cdr tail)))
((endp tail)
(values tail (nreverse decls) doc))
(let ((form (car tail)))
(cond ((and (stringp form) (cdr tail))
(if doc-string-allowed
(setq doc form)
(return (values tail (nreverse decls) doc))))
((not (and (consp form) (symbolp (car form))))
(return (values tail (nreverse decls) doc)))
((eq (car form) 'declare)
(push form decls))
(t
(return (values tail (nreverse decls) doc))))))))
;;;; DEFMACRO:
;;; Defmacro -- Public
;;;
;;; Parse the definition and make an expander function. The actual
;;; definition is done by %defmacro which we expand into.
;;;
(defmacro defmacro (name lambda-list &body body)
(let ((whole (gensym "WHOLE-"))
(environment (gensym "ENV-")))
(parse-defmacro lambda-list whole body name 'defmacro
:environment environment)
(let ((def `(lambda (,whole ,environment)
,@local-decs
(block ,name
,body))))
`(c::%defmacro ',name #',def ',lambda-list ,doc)))))
;;; %Defmacro, %%Defmacro -- Internal
;;;
;;; Defmacro expands into %Defmacro which is a function that is treated
;;; magically the compiler. After the compiler has gotten the information it
;;; wants out of macro definition, it compiles a call to %%Defmacro which
;;; happens at load time. We have a %Defmacro function which just calls
;;; %%Defmacro in order to keep the interpreter happy.
;;;
;;; Eventually %%Defmacro should deal with clearing old compiler information
;;; for the functional value.
;;;
(defun c::%defmacro (name definition lambda-list doc)
(assert (eval:interpreted-function-p definition))
(setf (eval:interpreted-function-name definition)
(format nil "DEFMACRO ~S" name))
(setf (eval:interpreted-function-arglist definition) lambda-list)
(c::%%defmacro name definition doc))
;;;
(defun c::%%defmacro (name definition doc)
(clear-info function where-from name)
(setf (macro-function name) definition)
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
;;;; DEFINE-COMPILER-MACRO
(defmacro define-compiler-macro (name lambda-list &body body)
"Define a compiler-macro for NAME."
(let ((whole (gensym "WHOLE-"))
(environment (gensym "ENV-")))
(multiple-value-bind
(body local-decs doc)
(parse-defmacro lambda-list whole body name 'define-compiler-macro
:environment environment)
(let ((def `(lambda (,whole ,environment)
,@local-decs
(block ,name
,body))))
`(c::%define-compiler-macro ',name #',def ',lambda-list ,doc)))))
(defun c::%define-compiler-macro (name definition lambda-list doc)
(assert (eval:interpreted-function-p definition))
(setf (eval:interpreted-function-name definition)
(let ((*print-case* :upcase))
(format nil "DEFINE-COMPILER-MACRO ~S" name)))
(setf (eval:interpreted-function-arglist definition) lambda-list)
(c::%%define-compiler-macro name definition doc))
;;;
(defun c::%%define-compiler-macro (name definition doc)
(setf (compiler-macro-function name) definition)
(setf (documentation name 'compiler-macro) doc)
name)
;;; DEFTYPE is a lot like DEFMACRO.
(defmacro deftype (name arglist &body body)
"Syntax like DEFMACRO, but defines a new type."
(unless (symbolp name)
(error "~S -- Type name not a symbol." name))
(let ((whole (gensym "WHOLE-")))
(parse-defmacro arglist whole body name 'deftype
:default-default ''*)
`(eval-when (compile load eval)
(%deftype ',name
#'(lambda (,whole)
,@local-decs
(block ,name ,body))
,@(when doc `(,doc)))))))
;;;
(defun %deftype (name expander &optional doc)
(ecase (info type kind name)
(:primitive
(when *type-system-initialized*
(error "Illegal to redefine standard type: ~S." name)))
(:instance
(warn "Redefining class ~S to be a DEFTYPE." name)
(undefine-structure (layout-info (class-layout (find-class name))))
(setf (class-cell-class (find-class-cell name)) nil)
(setf (info type compiler-layout name) nil)
(setf (info type kind name) :defined))
(:defined)
((nil)
(setf (info type kind name) :defined)))
(setf (info type expander name) expander)
(when doc
(setf (documentation name 'type) doc))
;; ### Bootstrap hack -- we need to define types before %note-type-defined
;; is defined.
(when (fboundp 'c::%note-type-defined)
;;; And so is DEFINE-SETF-EXPANDER.
(defparameter defsetf-error-string "Setf expander for ~S cannot be called with ~S args.")
(defmacro define-setf-expander (access-fn lambda-list &body body)
"Syntax like DEFMACRO, but creates a Setf-Method generator. The body
must be a form that returns the five magical values."
(unless (symbolp access-fn)
(error "~S -- Access-function name not a symbol in DEFINE-SETF-METHOD."
access-fn))
(let ((whole (gensym "WHOLE-"))
(environment (gensym "ENV-")))
(multiple-value-bind (body local-decs doc)
(parse-defmacro lambda-list whole body access-fn
'define-setf-method
:environment environment)
(%define-setf-macro
',access-fn
#'(lambda (,whole ,environment)
,@local-decs
(block ,access-fn ,body))
nil
',doc)))))
(defmacro define-setf-method (&rest stuff)
"Obsolete, use define-setf-expander."
`(define-setf-expander ,@stuff))
;;; %DEFINE-SETF-MACRO -- Internal
;;;
;;; Do stuff for defining a setf macro.
;;;
(defun %define-setf-macro (name expander inverse doc)
(cond ((not (fboundp `(setf ,name))))
((info function accessor-for name)
(warn "Defining setf macro for destruct slot accessor; redefining as ~
a normal function:~% ~S"
name)
(c::define-function-name name))
((not (eq (symbol-package name) (symbol-package 'aref)))
(warn "Defining setf macro for ~S, but ~S is fbound."
name `(setf ,name))))
(when (or inverse (info setf inverse name))
(setf (info setf inverse name) inverse))
(when (or expander (info setf expander name))
(setf (info setf expander name) expander))
(when doc
(setf (documentation name 'setf) doc))
name)
;;;; Destructuring-bind
(defmacro destructuring-bind (lambda-list arg-list &rest body)
"Bind the variables in LAMBDA-LIST to the contents of ARG-LIST."
(let* ((arg-list-name (gensym "ARG-LIST-")))
(multiple-value-bind
(parse-defmacro lambda-list arg-list-name body nil 'destructuring-bind
:annonymousp t :doc-string-allowed nil)
`(let ((,arg-list-name ,arg-list))
,body))))
;;;; Defun, Defvar, Defparameter, Defconstant:
;;; Defun -- Public
;;;
;;; Very similar to Defmacro, but simpler. We don't have to parse the
;;; lambda-list.
;;;
(defmacro defun (&whole source name lambda-list &body (body decls doc))
(let ((def `(lambda ,lambda-list
,@decls
(block ,(if (and (consp name) (eq (car name) 'setf))
(cadr name)
name)
,@body))))
`(c::%defun ',name #',def ,doc ',source)))
;;; %Defun, %%Defun -- Internal
;;;
;;; Similar to %Defmacro, ...
;;;
(defun c::%%defun (name def doc &optional inline-expansion)
(setf (fdefinition name) def)
(when doc
(if (and (consp name) (eq (first name) 'setf))
(setf (documentation (second name) 'setf) doc)
(setf (documentation name 'function) doc)))
(c::define-function-name name)
(when (eq (info function where-from name) :assumed)
(setf (info function where-from name) :defined)
(when (info function assumed-type name)
(setf (info function assumed-type name) nil)))
(when (or inline-expansion
(info function inline-expansion name))
(setf (info function inline-expansion name) inline-expansion))
name)
;;;
(defun c::%defun (name def doc source)
(declare (ignore source))
(assert (eval:interpreted-function-p def))
(setf (eval:interpreted-function-name def) name)
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
(c::%%defun name def doc))
;;; DEFCONSTANT -- Public
;;;
(defmacro defconstant (var val &optional doc)
"For defining global constants at top level. The DEFCONSTANT says that the
value is constant and may be compiled into code. If the variable already has
a value, and this is not equal to the init, an error is signalled. The third
argument is an optional documentation string for the variable."
`(c::%defconstant ',var ,val ',doc))
;;; %Defconstant, %%Defconstant -- Internal
;;;
;;; Like the other %mumbles except that we currently actually do something
;;; interesting at load time, namely checking if the constant is being
;;; redefined.
;;;
(defun c::%defconstant (name value doc)
(c::%%defconstant name value doc))
;;;
(defun c::%%defconstant (name value doc)
(when doc
(setf (documentation name 'variable) doc))
(when (boundp name)
(unless (equalp (symbol-value name) value)
(cerror "Go ahead and change the value."
"Constant ~S being redefined." name)))
(setf (symbol-value name) value)
(setf (info variable kind name) :constant)
(clear-info variable constant-value name)
name)
(defmacro defvar (var &optional (val nil valp) (doc nil docp))
"For defining global variables at top level. Declares the variable
SPECIAL and, optionally, initializes it. If the variable already has a
value, the old value is not clobbered. The third argument is an optional
documentation string for the variable."
`(progn
(proclaim '(special ,var))
,@(when valp
`((unless (boundp ',var)
(setq ,var ,val))))
,@(when docp
`((setf (documentation ',var 'variable) ',doc)))
',var))
(defmacro defparameter (var val &optional (doc nil docp))
"Defines a parameter that is not normally changed by the program,
but that may be changed without causing an error. Declares the
variable special and sets its value to VAL. The third argument is
an optional documentation string for the parameter."
`(progn
(proclaim '(special ,var))
(setq ,var ,val)
,@(when docp
`((setf (documentation ',var 'variable) ',doc)))
',var))
;;;; ASSORTED CONTROL STRUCTURES
(defmacro when (test &body forms)
"First arg is a predicate. If it is non-null, the rest of the forms are
evaluated as a PROGN."
`(cond (,test nil ,@forms)))
(defmacro unless (test &rest forms)
"First arg is a predicate. If it is null, the rest of the forms are
evaluated as a PROGN."
`(cond ((not ,test) nil ,@forms)))
(defmacro return (&optional (value nil))
`(return-from nil ,value))
(defmacro prog (varlist &body (body decls))
`(block nil
(let ,varlist
,@decls
(tagbody ,@body))))
(defmacro prog* (varlist &body (body decls))
`(block nil
(let* ,varlist
,@decls
(tagbody ,@body))))
;;; Prog1, Prog2 -- Public
;;;
;;; These just turn into a Let.
;;;
(defmacro prog1 (result &rest body)
(let ((n-result (gensym)))
`(let ((,n-result ,result))
,@body
,n-result)))
;;;
(defmacro prog2 (form1 result &rest body)
`(prog1 (progn ,form1 ,result) ,@body))
;;; And, Or -- Public
;;;
;;; AND and OR are defined in terms of IF.
;;;
(defmacro and (&rest forms)
(cond ((endp forms) t)
((endp (rest forms)) (first forms))
(t
`(if ,(first forms)
(and ,@(rest forms))
nil))))
;;;
(defmacro or (&rest forms)
(cond ((endp forms) nil)
((endp (rest forms)) (first forms))
(t
(let ((n-result (gensym)))
`(let ((,n-result ,(first forms)))
(if ,n-result
,n-result
(or ,@(rest forms))))))))
;;; Cond -- Public
;;;
;;; COND also turns into IF.
;;;
(defmacro cond (&rest clauses)
(if (endp clauses)
nil
(let ((clause (first clauses)))
(when (atom clause)
(error "Cond clause is not a list: ~S." clause))
(let ((test (first clause))
(forms (rest clause)))
(if (endp forms)
(let ((n-result (gensym)))
`(let ((,n-result ,test))
(if ,n-result
,n-result
(cond ,@(rest clauses)))))
`(if ,test
(progn ,@forms)
(cond ,@(rest clauses))))))))
;;;; Multiple value macros:
;;; Multiple-Value-XXX -- Public
;;;
;;; All the multiple-value receiving forms are defined in terms of
;;; Multiple-Value-Call.
;;;
(defmacro multiple-value-setq (varlist value-form)
(unless (and (listp varlist) (every #'symbolp varlist))
(error "Varlist is not a list of symbols: ~S." varlist))
(let ((temps (mapcar #'(lambda (x) (declare (ignore x)) (gensym)) varlist)))
`(multiple-value-bind ,temps ,value-form
,@(mapcar #'(lambda (var temp)
`(setq ,var ,temp))
varlist temps)
,(car temps))))
;;;
(defmacro multiple-value-bind (varlist value-form &body body)
(unless (and (listp varlist) (every #'symbolp varlist))
(error "Varlist is not a list of symbols: ~S." varlist))
(if (= (length varlist) 1)
`(let ((,(car varlist) ,value-form))
,@body)
(let ((ignore (gensym)))
`(multiple-value-call #'(lambda (&optional ,@varlist &rest ,ignore)
(declare (ignore ,ignore))
,@body)
,value-form))))
;;;
(defmacro multiple-value-list (value-form)
`(multiple-value-call #'list ,value-form))
(defmacro nth-value (n form)
"Evaluates FORM and returns the Nth value (zero based). This involves no
consing when N is a trivial constant integer."
(if (integerp n)
(let ((dummy-list nil)
(keeper (gensym "KEEPER-")))
;; We build DUMMY-LIST, a list of variables to bind to useless
;; values, then we explicitly IGNORE those bindings and return
;; KEEPER, the only thing we're really interested in right now.
(dotimes (i n)
(push (gensym "IGNORE-") dummy-list))
`(multiple-value-bind (,@dummy-list ,keeper)
,form
(declare (ignore ,@dummy-list))
,keeper))
(once-only ((n n))
`(case (the fixnum ,n)
(0 (nth-value 0 ,form))
(1 (nth-value 1 ,form))
(2 (nth-value 2 ,form))
(T (nth (the fixnum ,n) (multiple-value-list ,form)))))))
;;;; SETF and friends.
;;; Note: The expansions for SETF and friends sometimes create needless
;;; LET-bindings of argument values. The compiler will remove most of
;;; these spurious bindings, so SETF doesn't worry too much about creating
;;; them.
;;; The inverse for a generalized-variable reference function is stored in
;;; one of two ways:
;;;
;;; A SETF inverse property corresponds to the short form of DEFSETF. It is
;;; the name of a function takes the same args as the reference form, plus a
;;; new-value arg at the end.
;;;
;;; A SETF method expander is created by the long form of DEFSETF or
;;; by DEFINE-SETF-METHOD. It is a function that is called on the reference
;;; form and that produces five values: a list of temporary variables, a list
;;; of value forms, a list of the single store-value form, a storing function,
;;; and an accessing function.
(defun get-setf-expansion (form &optional environment)
"Returns five values needed by the SETF machinery: a list of temporary
variables, a list of values with which to fill them, a list of temporaries
for the new values, the setting function, and the accessing function."
(multiple-value-bind
(expansion expanded)
(macroexpand-1 form environment)
(if expanded
(get-setf-expansion expansion environment)
(let ((new-var (gensym)))
(values nil nil (list new-var)
`(setq ,form ,new-var) form)))))
;; Local functions inhibit global setf methods...
((and environment
(let ((name (car form)))
(dolist (x (c::lexenv-functions environment) nil)
(when (and (eq (car x) name)
(not (c::defined-function-p (cdr x))))
(return t)))))
(expand-or-get-setf-inverse form environment))
(get-setf-method-inverse form `(,temp) nil))
((setq temp (info setf expander (car form)))
(funcall temp form environment))
(t
(expand-or-get-setf-inverse form environment)))))
(defun get-setf-method-multiple-value (form &optional env)
"Obsolete: use GET-SETF-EXPANSION."
(get-setf-expansion form env))
;;;
;;; If a macro, expand one level and try again. If not, go for the
;;; SETF function.
(defun expand-or-get-setf-inverse (form environment)
(multiple-value-bind
(expansion expanded)
(macroexpand-1 form environment)
(if expanded
(get-setf-expansion expansion environment)
(get-setf-method-inverse form `(funcall #'(setf ,(car form)))
t))))
(defun get-setf-method-inverse (form inverse setf-function)
(let ((new-var (gensym))
(vars nil)
(vals nil))
(dolist (x (cdr form))
(push (gensym) vars)
(push x vals))
(setq vals (nreverse vals))
(values vars vals (list new-var)
(if setf-function
`(,@inverse ,new-var ,@vars)
`(,@inverse ,@vars ,new-var))
(defun get-setf-method (form &optional environment)
"Obsolete: use GET-SETF-EXPANSION and handle multiple store values."
(multiple-value-bind
(temps value-forms store-vars store-form access-form)
(get-setf-expansion form environment)
(when (cdr store-vars)
(error "GET-SETF-METHOD used for a form with multiple store ~
variables:~% ~S" form))
(values temps value-forms store-vars store-form access-form)))
(let ((arglist (car rest))
(arglist-var (gensym "ARGS-"))
(new-var (car (cadr rest))))
(multiple-value-bind
(body local-decs doc)
(parse-defmacro arglist arglist-var (cddr rest) fn 'defsetf)
`(lambda (,arglist-var ,new-var)
,@local-decs
(defmacro defsetf (access-fn &rest rest)
"Associates a SETF update function or macro with the specified access
function or macro. The format is complex. See the manual for
details."
(cond ((not (listp (car rest)))
`(eval-when (load compile eval)
(%define-setf-macro ',access-fn nil ',(car rest)
,(when (and (car rest) (stringp (cadr rest)))
`',(cadr rest)))))
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
((and (cdr rest) (listp (cadr rest)))
(destructuring-bind
(lambda-list (&rest store-variables) &body body)
rest
(let ((arglist-var (gensym "ARGS-"))
(access-form-var (gensym "ACCESS-FORM-"))
(env-var (gensym "ENVIRONMENT-")))
(multiple-value-bind
(body local-decs doc)
(parse-defmacro `(,lambda-list ,@store-variables)
arglist-var body access-fn 'defsetf
:annonymousp t)
`(eval-when (load compile eval)
(%define-setf-macro
',access-fn
#'(lambda (,access-form-var ,env-var)
(declare (ignore ,env-var))
(%defsetf ,access-form-var ,(length store-variables)
#'(lambda (,arglist-var)
,@local-decs
(block ,access-fn
,body))))
nil
',doc))))))
(t
(error "Ill-formed DEFSETF for ~S." access-fn))))
(defun %defsetf (orig-access-form num-store-vars expander)
(collect ((subforms) (subform-vars) (subform-exprs) (store-vars))
(dolist (subform (cdr orig-access-form))
(if (constantp subform)
(subforms subform)
(let ((var (gensym)))
(subforms var)
(subform-vars var)
(subform-exprs subform))))
(dotimes (i num-store-vars)
(store-vars (gensym)))
(values (subform-vars)
(subform-exprs)
(store-vars)
(funcall expander (cons (subforms) (store-vars)))
`(,(car orig-access-form) ,@(subforms)))))
;;; SETF -- Public
;;;
;;; Except for atoms, we always call GET-SETF-METHOD, since it has some
;;; non-trivial semantics. But when there is a setf inverse, and G-S-M uses
;;; it, then we return a call to the inverse, rather than returning a hairy let
;;; form. This is probably important mainly as a convenince in allowing the
;;; use of setf inverses without the full interpreter.
;;;
(defmacro setf (&rest args &environment env)
"Takes pairs of arguments like SETQ. The first is a place and the second
is the value that is supposed to go into that place. Returns the last
value. The place argument may be any of the access forms for which SETF
knows a corresponding setting form."
(let ((nargs (length args)))
(cond
((= nargs 2)
(let ((place (first args))
(value-form (second args)))
(if (atom place)
`(setq ,place ,value-form)
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-expansion place env)
(declare (ignore getter))
(let ((inverse (info setf inverse (car place))))
(if (and inverse (eq inverse (car setter)))
`(,inverse ,@(cdr place) ,value-form)
`(let* (,@(mapcar #'list dummies vals))
(multiple-value-bind ,newval ,value-form
,setter))))))))
((oddp nargs)
(error "Odd number of args to SETF."))
(t
(do ((a args (cddr a)) (l nil))
((null a) `(progn ,@(nreverse l)))
(setq l (cons (list 'setf (car a) (cadr a)) l)))))))
(defmacro psetf (&rest args &environment env)
"This is to SETF as PSETQ is to SETQ. Args are alternating place
expressions and values to go into those places. All of the subforms and
values are determined, left to right, and only then are the locations
updated. Returns NIL."
(collect ((let*-bindings) (mv-bindings) (setters))
(do ((a args (cddr a)))
((endp a))
(if (endp (cdr a))
(error "Odd number of args to PSETF."))
(multiple-value-bind
(dummies vals newval setter getter)
(get-setf-expansion (car a) env)
(declare (ignore getter))
(let*-bindings (mapcar #'list dummies vals))
(mv-bindings (list newval (cadr a)))
(setters setter)))
(labels ((thunk (let*-bindings mv-bindings)
(if let*-bindings
`(let* ,(car let*-bindings)
(multiple-value-bind ,@(car mv-bindings)
,(thunk (cdr let*-bindings) (cdr mv-bindings))))
`(progn ,@(setters) nil))))
(thunk (let*-bindings) (mv-bindings)))))
(defmacro shiftf (&whole form &rest args &environment env)
value expression. Evaluates all of the expressions in turn, then
assigns the value of each expression to the place on its left,
returning the value of the leftmost."
(when (< (length args) 2)
(error "~S called with too few arguments: ~S" 'shiftf form))
(let ((resultvar (gensym)))
(do ((arglist args (cdr arglist))
(bindlist nil)
(storelist nil)
(lastvar resultvar))
((atom (cdr arglist))
(push `(,lastvar ,(first arglist)) bindlist)
`(LET* ,(nreverse bindlist) ,@(nreverse storelist) ,resultvar))
(multiple-value-bind (SM1 SM2 SM3 SM4 SM5)
(get-setf-method (first arglist) env)
(mapc #'(lambda (var val) (push `(,var ,val) bindlist)) SM1 SM2)
(push `(,lastvar ,SM5) bindlist)
(push SM4 storelist)
(setq lastvar (first SM3))))))
(defmacro rotatef (&rest args &environment env)
"Takes any number of SETF-style place expressions. Evaluates all of the
expressions in turn, then assigns to each place the value of the form to
its right. The rightmost form gets the value of the leftmost.
Returns NIL."
(when args
(collect ((let*-bindings) (mv-bindings) (setters) (getters))
(dolist (arg args)
(multiple-value-bind
(temps subforms store-vars setter getter)
(get-setf-expansion arg env)
(loop
for temp in temps
for subform in subforms
do (let*-bindings `(,temp ,subform)))
(mv-bindings store-vars)
(setters setter)
(getters getter)))
(setters nil)
(getters (car (getters)))
(labels ((thunk (mv-bindings getters)
(if mv-bindings
`((multiple-value-bind
,(car mv-bindings)
,(car getters)
,@(thunk (cdr mv-bindings) (cdr getters))))
(setters))))
`(let* ,(let*-bindings)
,@(thunk (mv-bindings) (cdr (getters))))))))
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
(defmacro define-modify-macro (name lambda-list function &optional doc-string)
"Creates a new read-modify-write macro like PUSH or INCF."
(let ((other-args nil)
(rest-arg nil)
(env (gensym))
(reference (gensym)))
;; Parse out the variable names and rest arg from the lambda list.
(do ((ll lambda-list (cdr ll))
(arg nil))
((null ll))
(setq arg (car ll))
(cond ((eq arg '&optional))
((eq arg '&rest)
(if (symbolp (cadr ll))
(setq rest-arg (cadr ll))
(error "Non-symbol &rest arg in definition of ~S." name))
(if (null (cddr ll))
(return nil)
(error "Illegal stuff after &rest arg in Define-Modify-Macro.")))
((memq arg '(&key &allow-other-keys &aux))
(error "~S not allowed in Define-Modify-Macro lambda list." arg))
((symbolp arg)
(push arg other-args))
((and (listp arg) (symbolp (car arg)))
(push (car arg) other-args))
(t (error "Illegal stuff in lambda list of Define-Modify-Macro."))))
(setq other-args (nreverse other-args))
`(defmacro ,name (,reference ,@lambda-list &environment ,env)
,doc-string
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method ,reference ,env)
(do ((d dummies (cdr d))
(v vals (cdr v))
(let-list nil (cons (list (car d) (car v)) let-list)))
((null d)
(push
(list (car newval)
,(if rest-arg
`(list* ',function getter ,@other-args ,rest-arg)
`(list ',function getter ,@other-args)))
let-list)
`(let* ,(nreverse let-list)
,setter)))))))
(defmacro push (obj place &environment env)
"Takes an object and a location holding a list. Conses the object onto
the list, returning the modified list."
(if (symbolp place)
`(setq ,place (cons ,obj ,place))
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method place env)
(do* ((d dummies (cdr d))
(v vals (cdr v))
(let-list nil))
((null d)
(push (list (car newval) `(cons ,obj ,getter))
let-list)
`(let* ,(nreverse let-list)
,setter))
(push (list (car d) (car v)) let-list)))))
(defmacro pushnew (obj place &rest keys &environment env)
"Takes an object and a location holding a list. If the object is already
in the list, does nothing. Else, conses the object onto the list. Returns
NIL. If there is a :TEST keyword, this is used for the comparison."
(if (symbolp place)
`(setq ,place (adjoin ,obj ,place ,@keys))
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method place env)
(do* ((d dummies (cdr d))
(v vals (cdr v))
(let-list nil))
((null d)
(push (list (car newval) `(adjoin ,obj ,getter ,@keys))
let-list)
`(let* ,(nreverse let-list)
,setter))
(push (list (car d) (car v)) let-list)))))
(defmacro pop (place &environment env)
"The argument is a location holding a list. Pops one item off the front
of the list and returns it."
(if (symbolp place)
`(prog1 (car ,place) (setq ,place (cdr ,place)))
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method place env)
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
(do* ((d dummies (cdr d))
(v vals (cdr v))
(let-list nil))
((null d)
(push (list (car newval) getter) let-list)
`(let* ,(nreverse let-list)
(prog1 (car ,(car newval))
(setq ,(car newval) (cdr ,(car newval)))
,setter)))
(push (list (car d) (car v)) let-list)))))
(define-modify-macro incf (&optional (delta 1)) +
"The first argument is some location holding a number. This number is
incremented by the second argument, DELTA, which defaults to 1.")
(define-modify-macro decf (&optional (delta 1)) -
"The first argument is some location holding a number. This number is
decremented by the second argument, DELTA, which defaults to 1.")
(defmacro remf (place indicator &environment env)
"Place may be any place expression acceptable to SETF, and is expected
to hold a property list or (). This list is destructively altered to
remove the property specified by the indicator. Returns T if such a
property was present, NIL if not."
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method place env)
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
(do* ((d dummies (cdr d))
(v vals (cdr v))
(let-list nil)
(ind-temp (gensym))
(local1 (gensym))
(local2 (gensym)))
((null d)
(push (list (car newval) getter) let-list)
(push (list ind-temp indicator) let-list)
`(let* ,(nreverse let-list)
(do ((,local1 ,(car newval) (cddr ,local1))
(,local2 nil ,local1))
((atom ,local1) nil)
(cond ((atom (cdr ,local1))
(error "Odd-length property list in REMF."))
((eq (car ,local1) ,ind-temp)
(cond (,local2
(rplacd (cdr ,local2) (cddr ,local1))
(return t))
(t (setq ,(car newval) (cddr ,(car newval)))
,setter
(return t))))))))
(push (list (car d) (car v)) let-list))))
;;; The built-in DEFSETFs.
(defsetf car %rplaca)
(defsetf cdr %rplacd)
(defsetf caar (x) (v) `(%rplaca (car ,x) ,v))
(defsetf cadr (x) (v) `(%rplaca (cdr ,x) ,v))
(defsetf cdar (x) (v) `(%rplacd (car ,x) ,v))
(defsetf cddr (x) (v) `(%rplacd (cdr ,x) ,v))
(defsetf caaar (x) (v) `(%rplaca (caar ,x) ,v))
(defsetf cadar (x) (v) `(%rplaca (cdar ,x) ,v))
(defsetf cdaar (x) (v) `(%rplacd (caar ,x) ,v))
(defsetf cddar (x) (v) `(%rplacd (cdar ,x) ,v))
(defsetf caadr (x) (v) `(%rplaca (cadr ,x) ,v))
(defsetf caddr (x) (v) `(%rplaca (cddr ,x) ,v))
(defsetf cdadr (x) (v) `(%rplacd (cadr ,x) ,v))
(defsetf cdddr (x) (v) `(%rplacd (cddr ,x) ,v))
(defsetf caaaar (x) (v) `(%rplaca (caaar ,x) ,v))
(defsetf cadaar (x) (v) `(%rplaca (cdaar ,x) ,v))
(defsetf cdaaar (x) (v) `(%rplacd (caaar ,x) ,v))
(defsetf cddaar (x) (v) `(%rplacd (cdaar ,x) ,v))
(defsetf caadar (x) (v) `(%rplaca (cadar ,x) ,v))
(defsetf caddar (x) (v) `(%rplaca (cddar ,x) ,v))
(defsetf cdadar (x) (v) `(%rplacd (cadar ,x) ,v))
(defsetf cdddar (x) (v) `(%rplacd (cddar ,x) ,v))
(defsetf caaadr (x) (v) `(%rplaca (caadr ,x) ,v))
(defsetf cadadr (x) (v) `(%rplaca (cdadr ,x) ,v))
(defsetf cdaadr (x) (v) `(%rplacd (caadr ,x) ,v))
(defsetf cddadr (x) (v) `(%rplacd (cdadr ,x) ,v))
(defsetf caaddr (x) (v) `(%rplaca (caddr ,x) ,v))
(defsetf cadddr (x) (v) `(%rplaca (cdddr ,x) ,v))
(defsetf cdaddr (x) (v) `(%rplacd (caddr ,x) ,v))
(defsetf cddddr (x) (v) `(%rplacd (cdddr ,x) ,v))
(defsetf first %rplaca)
(defsetf second (x) (v) `(%rplaca (cdr ,x) ,v))
(defsetf third (x) (v) `(%rplaca (cddr ,x) ,v))
(defsetf fourth (x) (v) `(%rplaca (cdddr ,x) ,v))
(defsetf fifth (x) (v) `(%rplaca (cddddr ,x) ,v))
(defsetf sixth (x) (v) `(%rplaca (cdr (cddddr ,x)) ,v))
(defsetf seventh (x) (v) `(%rplaca (cddr (cddddr ,x)) ,v))
(defsetf eighth (x) (v) `(%rplaca (cdddr (cddddr ,x)) ,v))
(defsetf ninth (x) (v) `(%rplaca (cddddr (cddddr ,x)) ,v))
(defsetf tenth (x) (v) `(%rplaca (cdr (cddddr (cddddr ,x))) ,v))
(defsetf rest %rplacd)
(defsetf elt %setelt)
(defsetf aref %aset)
(defsetf row-major-aref %set-row-major-aref)
(defsetf svref %svset)
(defsetf char %charset)
(defsetf bit %bitset)
(defsetf schar %scharset)
(defsetf sbit %sbitset)
(defsetf %array-dimension %set-array-dimension)
(defsetf %raw-bits %set-raw-bits)
(defsetf symbol-function fset)
(defsetf symbol-plist %set-symbol-plist)
(defsetf documentation %set-documentation)
(defsetf nth %setnth)
(defsetf fill-pointer %set-fill-pointer)
(defsetf search-list %set-search-list)
(defsetf sap-ref-8 %set-sap-ref-8)
(defsetf signed-sap-ref-8 %set-signed-sap-ref-8)
(defsetf sap-ref-16 %set-sap-ref-16)
(defsetf signed-sap-ref-16 %set-signed-sap-ref-16)
(defsetf sap-ref-32 %set-sap-ref-32)
(defsetf signed-sap-ref-32 %set-signed-sap-ref-32)
#+alpha
(defsetf sap-ref-64 %set-sap-ref-64)
#+alpha
(defsetf signed-sap-ref-64 %set-signed-sap-ref-64)
(defsetf sap-ref-sap %set-sap-ref-sap)