Newer
Older
;;; -*- Log: code.log; Package: Lisp -*-
;;;
;;; **********************************************************************
;;; This code was written as part of the Spice Lisp project at
;;; Carnegie-Mellon University, and has been placed in the public domain.
;;; If you want to use this code or any part of Spice Lisp, please contact
;;; Scott Fahlman (FAHLMAN@CMUC).
;;; **********************************************************************
;;;
;;; $Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/code/macros.lisp,v 1.17 1990/12/11 12:45:13 wlott 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
;;;
(export '(defvar defparameter defconstant when unless setf
defsetf define-setf-method 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-method get-setf-method-multiple-value
define-modify-macro destructuring-bind
26
27
28
29
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
otherwise)) ; Sacred to CASE and related macros.
(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)
(setf (documentation name 'function) 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
(error "Illegal to redefine standard type: ~S." name))
(:structure
(warn "Redefining structure type ~S with DEFTYPE." name)
(c::undefine-structure (info type structure-info name)))
((nil :defined)))
(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-METHOD.
(defparameter defsetf-error-string "Setf expander for ~S cannot be called with ~S args.")
(defmacro define-setf-method (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)
`(eval-when (load compile eval)
(setf (info setf inverse ',access-fn) nil)
(setf (info setf expander ',access-fn)
#'(lambda (,whole ,environment)
,@local-decs
(block ,access-fn ,body)))
,@(when doc
`((setf (documentation ',access-fn 'setf) ,doc)))
',access-fn))))
;;;; 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)
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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
(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))
;;;; 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 property 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.
;;; Left over in case someone is still trying to call this.
(defun foo-get-setf-method (form &optional environment)
(get-setf-method form environment))
(eval-when (compile load eval)
(defun get-setf-method (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, the temporary for the
new value in a list, the setting function, and the accessing function."
(let (temp)
(cond ((symbolp form)
(let ((new-var (gensym)))
(values nil nil (list new-var) `(setq ,form ,new-var) form)))
((atom form)
(error "~S illegal atomic form for GET-SETF-METHOD." form))
;;
;; ### Bootstrap hack...
;; Ignore any DEFSETF info for structure accessors.
((info function accessor-for (car form))
(get-setf-method-inverse form `(funcall #'(setf ,(car form))) t))
(get-setf-method-inverse form `(,temp) nil))
((setq temp (info setf expander (car form)))
(funcall temp form environment))
(t
(multiple-value-bind (res win)
(macroexpand-1 form environment)
(if win
(get-setf-method res 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))
`(,(car form) ,@vars))))
(defun get-setf-method-multiple-value (form &optional environment)
"Like Get-Setf-Method, but may return multiple new-value variables."
(get-setf-method form environment))
(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)
(setf (info setf inverse ',access-fn) ',(car rest))
(setf (info setf expander ',access-fn) nil)
,@(if (and (car rest) (stringp (cadr rest)))
`((eval-when (load eval)
(%put ',access-fn '%setf-documentation ,(cadr rest)))))
',access-fn))
((and (listp (car rest)) (cdr rest) (listp (cadr rest)))
(if (not (= (length (cadr rest)) 1))
(cerror "Ignore the extra items in the list."
"Only one new-value variable allowed in DEFSETF."))
(multiple-value-bind (setting-form-generator doc)
`(eval-when (load compile eval)
(setf (info setf inverse ',access-fn) nil)
(setf (info setf expander ',access-fn)
#'(lambda (access-form environment)
(declare (ignore environment))
(do* ((args (cdr access-form) (cdr args))
(dummies nil (cons (gensym) dummies))
(newval-var (gensym))
(new-access-form nil))
((atom args)
(setq new-access-form
(cons (car access-form) dummies))
(values
dummies
(cdr access-form)
(list newval-var)
(funcall (function ,setting-form-generator)
new-access-form newval-var)
new-access-form)))))
,@(if doc
`((eval-when (load eval)
(setf (info setf documentation ',access-fn) ',doc)))
`((eval-when (load eval)
(or (clear-info setf documentation ',access-fn)
(setf (info setf documentation ',access-fn)
nil)))))
',access-fn)))
(t (error "Ill-formed DEFSETF for ~S." access-fn))))
(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 ((temp (length args)))
(cond ((= temp 2)
(cond ((atom (car args))
`(setq ,(car args) ,(cadr args)))
((info function accessor-for (caar args))
`(funcall #'(setf ,(caar args)) ,(cadr args) ,@(cdar args)))
((setq temp (info setf inverse (caar args)))
`(,temp ,@(cdar args) ,(cadr args)))
(t (multiple-value-bind (dummies vals newval setter getter)
(get-setf-method (car args) env)
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
(declare (ignore getter))
(do* ((d dummies (cdr d))
(v vals (cdr v))
(let-list nil))
((null d)
(setq let-list
(nreverse (cons (list (car newval)
(cadr args))
let-list)))
`(let* ,let-list ,setter))
(setq let-list
(cons (list (car d) (car v)) let-list)))))))
((oddp temp)
(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."
(do ((a args (cddr a))
(let-list nil)
(setf-list nil))
((atom a)
`(let* ,(nreverse let-list) ,@(nreverse setf-list) nil))
(if (atom (cdr a))
(error "Odd number of args to PSETF."))
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method (car a) env)
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
(declare (ignore getter))
(do* ((d dummies (cdr d))
(v vals (cdr v)))
((null d))
(push (list (car d) (car v)) let-list))
(push (list (car newval) (cadr a)) let-list)
(push setter setf-list))))
(defmacro shiftf (&rest args &environment env)
"One or more SETF-style place expressions, followed by a single
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."
(if (< (length args) 2)
(error "Too few argument forms to a SHIFTF."))
(let ((leftmost (gensym)))
(do ((a args (cdr a))
(let-list nil)
(setf-list nil)
(next-var leftmost))
((atom (cdr a))
(push (list next-var (car a)) let-list)
`(let* ,(nreverse let-list) ,@(nreverse setf-list) ,leftmost))
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method (car a) env)
(do* ((d dummies (cdr d))
(v vals (cdr v)))
((null d))
(push (list (car d) (car v)) let-list))
(push (list next-var getter) let-list)
(push setter setf-list)
(setq next-var (car newval))))))
(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."
(cond ((null args) nil)
((null (cdr args)) `(progn ,(car args) nil))
(t (do ((a args (cdr a))
(let-list nil)
(setf-list nil)
(next-var nil)
(fix-me nil))
((atom a)
(rplaca fix-me next-var)
`(let* ,(nreverse let-list) ,@(nreverse setf-list) nil))
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method (car a) env)
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
(do ((d dummies (cdr d))
(v vals (cdr v)))
((null d))
(push (list (car d) (car v)) let-list))
(push (list next-var getter) let-list)
;; We don't know the newval variable for the last form yet,
;; so fake it for the first getter and fix it at the end.
(unless fix-me (setq fix-me (car let-list)))
(push setter setf-list)
(setq next-var (car newval)))))))
(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)
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
(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)
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
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
(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-value set)
(defsetf symbol-function %sp-set-definition)
(defsetf symbol-plist %sp-set-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-sap-ref-8)
(defsetf sap-ref-16 %set-sap-ref-16)
(defsetf signed-sap-ref-16 %set-sap-ref-16)
(defsetf sap-ref-32 %set-sap-ref-32)
(defsetf signed-sap-ref-32 %set-sap-ref-32)
(defsetf sap-ref-sap %set-sap-ref-sap)
(defsetf sap-ref-single %set-sap-ref-single)
(defsetf sap-ref-double %set-sap-ref-double)
(define-setf-method getf (place prop &optional default &environment env)
(multiple-value-bind (temps values stores set get)
(get-setf-method place env)
(let ((newval (gensym))
(ptemp (gensym))
(def-temp (gensym)))
(values `(,@temps ,(car stores) ,ptemp ,@(if default `(,def-temp)))
`(,@values ,get ,prop ,@(if default `(,default)))
`(,newval)
`(progn (setq ,(car stores)
894
895
896
897
898
899
900
901
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
,set
,newval)
`(getf ,(car stores) ,ptemp ,@(if default `(,def-temp)))))))
(define-setf-method get (symbol prop &optional default)
"Get turns into %put. Don't put in the default unless it really is supplied and
non-nil, so that we can transform into the get instruction whenever possible."
(let ((symbol-temp (gensym))
(prop-temp (gensym))
(def-temp (gensym))
(newval (gensym)))
(values `(,symbol-temp ,prop-temp ,@(if default `(,def-temp)))
`(,symbol ,prop ,@(if default `(,default)))
(list newval)
`(%put ,symbol-temp ,prop-temp ,newval)
`(get ,symbol-temp ,prop-temp ,@(if default `(,def-temp))))))
(define-setf-method gethash (key hashtable &optional default)
(let ((key-temp (gensym))
(hashtable-temp (gensym))
(default-temp (gensym))
(new-value-temp (gensym)))
(values
`(,key-temp ,hashtable-temp ,@(if default `(,default-temp)))
`(,key ,hashtable ,@(if default `(,default)))
`(,new-value-temp)
`(%puthash ,key-temp ,hashtable-temp ,new-value-temp)
`(gethash ,key-temp ,hashtable-temp ,@(if default `(,default-temp))))))
(defsetf subseq (sequence start &optional (end nil)) (v)
`(progn (replace ,sequence ,v :start1 ,start :end1 ,end)
,v))
;;; Evil hack invented by the gnomes of Vassar Street. The function
;;; arg must be constant. Get a setf method for this function, pretending
;;; that the final (list) arg to apply is just a normal arg. If the
;;; setting and access forms produced in this way reference this arg at
;;; the end, then just splice the APPLY back onto the front and the right
;;; thing happens.
(define-setf-method apply (function &rest args &environment env)
(if (and (listp function)
(= (list-length function) 2)
(eq (first function) 'function)
(symbolp (second function)))
(setq function (second function))
(error
"Setf of Apply is only defined for function args of form #'symbol."))
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method (cons function args) env)
;; Special case aref and svref.
(cond ((or (eq function 'aref) (eq function 'svref))
(let ((nargs (subseq setter 0 (1- (length setter))))
(fcn (if (eq function 'aref) 'lisp::%apply-aset 'lisp::%apply-svset)))
(values dummies vals newval
`(apply (function ,fcn) ,(car newval) ,@(cdr nargs))
`(apply (function ,function) ,@(cdr getter)))))
;; Make sure the place is one that we can handle.
(T (unless (and (eq (car (last args)) (car (last vals)))
(eq (car (last getter)) (car (last dummies)))
(eq (car (last setter)) (car (last dummies))))
(error "Apply of ~S not understood as a location for Setf."
function))
(values dummies vals newval
`(apply (function ,(car setter)) ,@(cdr setter))
`(apply (function ,(car getter)) ,@(cdr getter)))))))
;;; Special-case a BYTE bytespec so that the compiler can recognize it.
;;;
(define-setf-method ldb (bytespec place &environment env)
"The first argument is a byte specifier. The second is any place form
acceptable to SETF. Replaces the specified byte of the number in this
place with bits from the low-order end of the new value."
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method place env)
(if (and (consp bytespec) (eq (car bytespec) 'byte))
(let ((n-size (gensym))
(n-pos (gensym))
(n-new (gensym)))
(values (list* n-size n-pos dummies)
(list* (second bytespec) (third bytespec) vals)
(list n-new)
`(let ((,(car newval) (dpb ,n-new (byte ,n-size ,n-pos)
,getter)))
,setter
,n-new)
`(ldb (byte ,n-size ,n-pos) ,getter)))
(let ((btemp (gensym))
(gnuval (gensym)))
(values (cons btemp dummies)
(cons bytespec vals)
(list gnuval)
`(let ((,(car newval) (dpb ,gnuval ,btemp ,getter)))
,setter
,gnuval)
`(ldb ,btemp ,getter))))))
(define-setf-method mask-field (bytespec place &environment env)
"The first argument is a byte specifier. The second is any place form
acceptable to SETF. Replaces the specified byte of the number in this place
with bits from the corresponding position in the new value."
(multiple-value-bind (dummies vals newval setter getter)
(get-setf-method place env)