[cfe7f9]: src / code / macros.lisp Maximize Restore History

Download this file

macros.lisp    543 lines (504 with data), 24.6 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 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
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
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
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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
;;;; lots of basic macros for the target SBCL
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
(in-package "SB!IMPL")
;;;; ASSERT and CHECK-TYPE
;;; ASSERT is written this way, to call ASSERT-ERROR, because of how
;;; closures are compiled. RESTART-CASE has forms with closures that
;;; the compiler causes to be generated at the top of any function
;;; using RESTART-CASE, regardless of whether they are needed. Thus if
;;; we just wrapped a RESTART-CASE around the call to ERROR, we'd have
;;; to do a significant amount of work at runtime allocating and
;;; deallocating the closures regardless of whether they were ever
;;; needed.
;;;
;;; ASSERT-ERROR isn't defined until a later file because it uses the
;;; macro RESTART-CASE, which isn't defined until a later file.
(defmacro-mundanely assert (test-form &optional places datum &rest arguments
&environment env)
#!+sb-doc
"Signals an error if the value of TEST-FORM is NIL. Returns NIL.
Optional DATUM and ARGUMENTS can be used to change the signaled
error condition and are interpreted as in (APPLY #'ERROR DATUM
ARGUMENTS).
Continuing from the signaled error using the CONTINUE restart will
allow the user to alter the values of the SETFable locations
specified in PLACES and then start over with TEST-FORM.
If TEST-FORM is of the form
(FUNCTION ARG*)
where FUNCTION is a function (but not a special operator like
CL:OR, CL:AND, etc.) the results of evaluating the ARGs will be
included in the error report if the assertion fails."
(collect ((bindings) (infos))
(let ((new-test
(flet ((process-place (place)
(if (sb!xc:constantp place env)
place
(with-unique-names (temp)
(bindings `(,temp ,place))
(infos `(list ',place ,temp))
temp))))
(cond
;; TEST-FORM looks like a function call. We do not
;; attempt this if TEST-FORM is the application of a
;; special operator because of argument evaluation
;; order issues.
((and (typep test-form '(cons symbol list))
(eq (info :function :kind (first test-form)) :function))
(let ((name (first test-form))
(args (mapcar #'process-place (rest test-form))))
`(,name ,@args)))
;; For all other cases, just evaluate TEST-FORM and do
;; not report any details if the assertion fails.
(t
test-form)))))
;; If TEST-FORM, potentially using values from BINDINGS, does not
;; hold, enter a loop which reports the assertion error,
;; potentially changes PLACES, and retries TEST-FORM.
`(tagbody
:try
(let ,(bindings)
(when ,new-test
(go :done))
(assert-error ',test-form (list ,@(infos))
',places ,datum ,@arguments))
,@(mapcar (lambda (place)
`(setf ,place (assert-prompt ',place ,place)))
places)
(go :try)
:done))))
(defun assert-prompt (name value)
(cond ((y-or-n-p "The old value of ~S is ~S.~
~%Do you want to supply a new value? "
name value)
(format *query-io* "~&Type a form to be evaluated:~%")
(flet ((read-it () (eval (read *query-io*))))
(if (symbolp name) ;help user debug lexical variables
(progv (list name) (list value) (read-it))
(read-it))))
(t value)))
;;; CHECK-TYPE is written this way, to call CHECK-TYPE-ERROR, because
;;; of how closures are compiled. RESTART-CASE has forms with closures
;;; that the compiler causes to be generated at the top of any
;;; function using RESTART-CASE, regardless of whether they are
;;; needed. Because it would be nice if CHECK-TYPE were cheap to use,
;;; and some things (e.g., READ-CHAR) can't afford this excessive
;;; consing, we bend backwards a little.
;;;
;;; CHECK-TYPE-ERROR isn't defined until a later file because it uses
;;; the macro RESTART-CASE, which isn't defined until a later file.
(defmacro-mundanely check-type (place type &optional type-string
&environment env)
#!+sb-doc
"Signal a restartable error of type TYPE-ERROR if the value of PLACE
is not of the specified type. If an error is signalled and the restart
is used to return, this can only return if the STORE-VALUE restart is
invoked. In that case it will store into PLACE and start over."
;; Detect a common user-error.
(when (and (consp type) (eq 'quote (car type)))
(error 'simple-reference-error
:format-control "Quoted type specifier in ~S: ~S"
:format-arguments (list 'check-type type)
:references (list '(:ansi-cl :macro check-type))))
;; KLUDGE: We use a simpler form of expansion if PLACE is just a
;; variable to work around Python's blind spot in type derivation.
;; For more complex places getting the type derived should not
;; matter so much anyhow.
(let ((expanded (%macroexpand place env)))
(if (symbolp expanded)
`(do ()
((typep ,place ',type))
(setf ,place (check-type-error ',place ,place ',type ,type-string)))
(let ((value (gensym)))
`(do ((,value ,place ,place))
((typep ,value ',type))
(setf ,place
(check-type-error ',place ,value ',type ,type-string)))))))
;;;; DEFINE-SYMBOL-MACRO
(defmacro-mundanely define-symbol-macro (name expansion)
`(eval-when (:compile-toplevel :load-toplevel :execute)
(sb!c::%define-symbol-macro ',name ',expansion (sb!c:source-location))))
(defun sb!c::%define-symbol-macro (name expansion source-location)
(unless (symbolp name)
(error 'simple-type-error :datum name :expected-type 'symbol
:format-control "Symbol macro name is not a symbol: ~S."
:format-arguments (list name)))
(with-single-package-locked-error
(:symbol name "defining ~A as a symbol-macro"))
(let ((kind (info :variable :kind name)))
(case kind
((:macro :unknown)
(sb!c:with-source-location (source-location)
(setf (info :source-location :symbol-macro name) source-location))
(setf (info :variable :kind name) :macro)
(setf (info :variable :macro-expansion name) expansion))
(t
(error 'simple-program-error
:format-control "Symbol ~S is already defined as ~A."
:format-arguments (list name
(case kind
(:alien "an alien variable")
(:constant "a constant")
(:special "a special variable")
(:global "a global variable")
(t kind)))))))
name)
;;;; DEFINE-COMPILER-MACRO
(defmacro-mundanely define-compiler-macro (name lambda-list &body body)
#!+sb-doc
"Define a compiler-macro for NAME."
(legal-fun-name-or-type-error name)
(when (and (symbolp name) (special-operator-p name))
(error 'simple-program-error
:format-control "cannot define a compiler-macro for a special operator: ~S"
:format-arguments (list name)))
(with-unique-names (whole environment)
(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
,body))
(debug-name (sb!c::debug-name 'compiler-macro-function name)))
`(eval-when (:compile-toplevel :load-toplevel :execute)
(sb!c::%define-compiler-macro ',name
#',def
',lambda-list
,doc
',debug-name))))))
;;; FIXME: This will look remarkably similar to those who have already
;;; seen the code for %DEFMACRO in src/code/defmacro.lisp. Various
;;; bits of logic should be shared (notably arglist setting).
(macrolet
((def (times set-p)
`(eval-when (,@times)
(defun sb!c::%define-compiler-macro
(name definition lambda-list doc debug-name)
,@(unless set-p
'((declare (ignore lambda-list debug-name))))
;; FIXME: warn about incompatible lambda list with
;; respect to parent function?
(setf (sb!xc:compiler-macro-function name) definition)
,(when set-p
`(setf (%fun-doc definition) doc
(%fun-lambda-list definition) lambda-list
(%fun-name definition) debug-name))
name))))
(progn
(def (:load-toplevel :execute) #-sb-xc-host t #+sb-xc-host nil)
#-sb-xc (def (:compile-toplevel) nil)))
;;;; CASE, TYPECASE, and friends
(eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
;;; Make this a full warning during SBCL build.
(define-condition duplicate-case-key-warning (#-sb-xc-host style-warning #+sb-xc-host warning)
((key :initarg :key
:reader case-warning-key)
(case-kind :initarg :case-kind
:reader case-warning-case-kind)
(occurrences :initarg :occurrences
:type list
:reader duplicate-case-key-warning-occurrences))
(:report
(lambda (condition stream)
(format stream
"Duplicate key ~S in ~S form, ~
occurring in~{~#[~; and~]~{ the ~:R clause:~%~< ~S~:>~}~^,~}."
(case-warning-key condition)
(case-warning-case-kind condition)
(duplicate-case-key-warning-occurrences condition)))))
;;; CASE-BODY returns code for all the standard "case" macros. NAME is
;;; the macro name, and KEYFORM is the thing to case on. MULTI-P
;;; indicates whether a branch may fire off a list of keys; otherwise,
;;; a key that is a list is interpreted in some way as a single key.
;;; When MULTI-P, TEST is applied to the value of KEYFORM and each key
;;; for a given branch; otherwise, TEST is applied to the value of
;;; KEYFORM and the entire first element, instead of each part, of the
;;; case branch. When ERRORP, no OTHERWISE-CLAUSEs are recognized,
;;; and an ERROR form is generated where control falls off the end
;;; of the ordinary clauses. When PROCEEDP, it is an error to
;;; omit ERRORP, and the ERROR form generated is executed within a
;;; RESTART-CASE allowing KEYFORM to be set and retested.
(defun case-body (name keyform cases multi-p test errorp proceedp needcasesp)
(unless (or cases (not needcasesp))
(warn "no clauses in ~S" name))
(let ((keyform-value (gensym))
(clauses ())
(keys ())
(keys-seen (make-hash-table :test #'eql)))
(do* ((cases cases (cdr cases))
(case (car cases) (car cases))
(case-position 1 (1+ case-position)))
((null cases) nil)
(flet ((check-clause (case-keys)
(loop for k in case-keys
for existing = (gethash k keys-seen)
do (when existing
(let ((sb!c::*current-path*
(when (boundp 'sb!c::*source-paths*)
(or (sb!c::get-source-path case)
sb!c::*current-path*))))
(warn 'duplicate-case-key-warning
:key k
:case-kind name
:occurrences `(,existing (,case-position (,case)))))))
(let ((record (list case-position (list case))))
(dolist (k case-keys)
(setf (gethash k keys-seen) record)))))
(unless (list-of-length-at-least-p case 1)
(error "~S -- bad clause in ~S" case name))
(destructuring-bind (keyoid &rest forms) case
(cond (;; an OTHERWISE-CLAUSE
;;
;; By the way... The old code here tried gave
;; STYLE-WARNINGs for normal-clauses which looked as
;; though they might've been intended to be
;; otherwise-clauses. As Tony Martinez reported on
;; sbcl-devel 2004-11-09 there are sometimes good
;; reasons to write clauses like that; and as I noticed
;; when trying to understand the old code so I could
;; understand his patch, trying to guess which clauses
;; don't have good reasons is fundamentally kind of a
;; mess. SBCL does issue style warnings rather
;; enthusiastically, and I have often justified that by
;; arguing that we're doing that to detect issues which
;; are tedious for programmers to detect for by
;; proofreading (like small typoes in long symbol
;; names, or duplicate function definitions in large
;; files). This doesn't seem to be an issue like that,
;; and I can't think of a comparably good justification
;; for giving STYLE-WARNINGs for legal code here, so
;; now we just hope the programmer knows what he's
;; doing. -- WHN 2004-11-20
(and (not errorp) ; possible only in CASE or TYPECASE,
; not in [EC]CASE or [EC]TYPECASE
(memq keyoid '(t otherwise))
(null (cdr cases)))
(push `(t nil ,@forms) clauses))
((and multi-p (listp keyoid))
(setf keys (append keyoid keys))
(check-clause keyoid)
(push `((or ,@(mapcar (lambda (key)
`(,test ,keyform-value ',key))
keyoid))
nil
,@forms)
clauses))
(t
(when (and (eq name 'case)
(cdr cases)
(memq keyoid '(t otherwise)))
(error 'simple-reference-error
:format-control
"~@<~IBad ~S clause:~:@_ ~S~:@_~S allowed as the key ~
designator only in the final otherwise-clause, not in a ~
normal-clause. Use (~S) instead, or move the clause the ~
correct position.~:@>"
:format-arguments (list 'case case keyoid keyoid)
:references `((:ansi-cl :macro case))))
(push keyoid keys)
(check-clause (list keyoid))
(push `((,test ,keyform-value ',keyoid)
nil
,@forms)
clauses))))))
(case-body-aux name keyform keyform-value clauses keys errorp proceedp
`(,(if multi-p 'member 'or) ,@keys))))
;;; CASE-BODY-AUX provides the expansion once CASE-BODY has groveled
;;; all the cases. Note: it is not necessary that the resulting code
;;; signal case-failure conditions, but that's what KMP's prototype
;;; code did. We call CASE-BODY-ERROR, because of how closures are
;;; compiled. RESTART-CASE has forms with closures that the compiler
;;; causes to be generated at the top of any function using the case
;;; macros, regardless of whether they are needed.
;;;
;;; The CASE-BODY-ERROR function is defined later, when the
;;; RESTART-CASE macro has been defined.
(defun case-body-aux (name keyform keyform-value clauses keys
errorp proceedp expected-type)
(if proceedp
(let ((block (gensym))
(again (gensym)))
`(let ((,keyform-value ,keyform))
(block ,block
(tagbody
,again
(return-from
,block
(cond ,@(nreverse clauses)
(t
(setf ,keyform-value
(setf ,keyform
(case-body-error
',name ',keyform ,keyform-value
',expected-type ',keys)))
(go ,again))))))))
`(let ((,keyform-value ,keyform))
(declare (ignorable ,keyform-value)) ; e.g. (CASE KEY (T))
(cond
,@(nreverse clauses)
,@(if errorp
`((t (case-failure ',name ,keyform-value ',keys))))))))
) ; EVAL-WHEN
(defmacro-mundanely case (keyform &body cases)
#!+sb-doc
"CASE Keyform {({(Key*) | Key} Form*)}*
Evaluates the Forms in the first clause with a Key EQL to the value of
Keyform. If a singleton key is T then the clause is a default clause."
(case-body 'case keyform cases t 'eql nil nil nil))
(defmacro-mundanely ccase (keyform &body cases)
#!+sb-doc
"CCASE Keyform {({(Key*) | Key} Form*)}*
Evaluates the Forms in the first clause with a Key EQL to the value of
Keyform. If none of the keys matches then a correctable error is
signalled."
(case-body 'ccase keyform cases t 'eql t t t))
(defmacro-mundanely ecase (keyform &body cases)
#!+sb-doc
"ECASE Keyform {({(Key*) | Key} Form*)}*
Evaluates the Forms in the first clause with a Key EQL to the value of
Keyform. If none of the keys matches then an error is signalled."
(case-body 'ecase keyform cases t 'eql t nil t))
(defmacro-mundanely typecase (keyform &body cases)
#!+sb-doc
"TYPECASE Keyform {(Type Form*)}*
Evaluates the Forms in the first clause for which TYPEP of Keyform and Type
is true."
(case-body 'typecase keyform cases nil 'typep nil nil nil))
(defmacro-mundanely ctypecase (keyform &body cases)
#!+sb-doc
"CTYPECASE Keyform {(Type Form*)}*
Evaluates the Forms in the first clause for which TYPEP of Keyform and Type
is true. If no form is satisfied then a correctable error is signalled."
(case-body 'ctypecase keyform cases nil 'typep t t t))
(defmacro-mundanely etypecase (keyform &body cases)
#!+sb-doc
"ETYPECASE Keyform {(Type Form*)}*
Evaluates the Forms in the first clause for which TYPEP of Keyform and Type
is true. If no form is satisfied then an error is signalled."
(case-body 'etypecase keyform cases nil 'typep t nil t))
;;;; WITH-FOO i/o-related macros
(defmacro-mundanely with-open-stream ((var stream) &body forms-decls)
(multiple-value-bind (forms decls)
(parse-body forms-decls :doc-string-allowed nil)
(let ((abortp (gensym)))
`(let ((,var ,stream)
(,abortp t))
,@decls
(unwind-protect
(multiple-value-prog1
(progn ,@forms)
(setq ,abortp nil))
(when ,var
(close ,var :abort ,abortp)))))))
(defmacro-mundanely with-open-file ((stream filespec &rest options)
&body body)
`(with-open-stream (,stream (open ,filespec ,@options))
,@body))
(defmacro-mundanely with-input-from-string ((var string &key index start end)
&body forms-decls)
(multiple-value-bind (forms decls)
(parse-body forms-decls :doc-string-allowed nil)
;; The ONCE-ONLY inhibits compiler note for unreachable code when
;; END is true.
(once-only ((string string))
`(let ((,var
,(cond ((null end)
`(make-string-input-stream ,string ,(or start 0)))
((symbolp end)
`(if ,end
(make-string-input-stream ,string
,(or start 0)
,end)
(make-string-input-stream ,string
,(or start 0))))
(t
`(make-string-input-stream ,string
,(or start 0)
,end)))))
,@decls
(multiple-value-prog1
(unwind-protect
(progn ,@forms)
(close ,var))
,@(when index
`((setf ,index (string-input-stream-current ,var)))))))))
(defmacro-mundanely with-output-to-string
((var &optional string &key (element-type ''character))
&body forms-decls)
(multiple-value-bind (forms decls)
(parse-body forms-decls :doc-string-allowed nil)
(if string
(let ((element-type-var (gensym)))
`(let ((,var (make-fill-pointer-output-stream ,string))
;; ELEMENT-TYPE isn't currently used for anything
;; (see FILL-POINTER-OUTPUT-STREAM FIXME in stream.lisp),
;; but it still has to be evaluated for side-effects.
(,element-type-var ,element-type))
(declare (ignore ,element-type-var))
,@decls
(unwind-protect
(progn ,@forms)
(close ,var))))
`(let ((,var (make-string-output-stream
;; CHARACTER is the default element-type of
;; string-ouput-stream, save a few bytes when passing it
,@(and (not (equal element-type ''character))
`(:element-type ,element-type)))))
,@decls
(unwind-protect
(progn ,@forms)
(close ,var))
(get-output-stream-string ,var)))))
;;;; miscellaneous macros
(defmacro-mundanely nth-value (n form)
#!+sb-doc
"Evaluate FORM and return the Nth value (zero based). This involves no
consing when N is a trivial constant integer."
;; FIXME: The above is true, if slightly misleading. The
;; MULTIPLE-VALUE-BIND idiom [ as opposed to MULTIPLE-VALUE-CALL
;; (LAMBDA (&REST VALUES) (NTH N VALUES)) ] does indeed not cons at
;; runtime. However, for large N (say N = 200), COMPILE on such a
;; form will take longer than can be described as adequate, as the
;; optional dispatch mechanism for the M-V-B gets increasingly
;; hairy.
(if (integerp n)
(let ((dummy-list (make-gensym-list n))
(keeper (sb!xc:gensym "KEEPER")))
`(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)))))))
(defmacro-mundanely declaim (&rest specs)
#!+sb-doc
"DECLAIM Declaration*
Do a declaration or declarations for the global environment."
`(eval-when (:compile-toplevel :load-toplevel :execute)
,@(mapcar (lambda (spec) `(sb!xc:proclaim ',spec))
specs)))
(defmacro-mundanely print-unreadable-object ((object stream &key type identity)
&body body)
#!+sb-doc
"Output OBJECT to STREAM with \"#<\" prefix, \">\" suffix, optionally
with object-type prefix and object-identity suffix, and executing the
code in BODY to provide possible further output."
`(%print-unreadable-object ,object ,stream ,type ,identity
,(if body
`(lambda () ,@body)
nil)))
(defmacro-mundanely ignore-errors (&rest forms)
#!+sb-doc
"Execute FORMS handling ERROR conditions, returning the result of the last
form, or (VALUES NIL the-ERROR-that-was-caught) if an ERROR was handled."
`(handler-case (progn ,@forms)
(error (condition) (values nil condition))))