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))
,@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
Loading
Loading full blame...