1.0.11.1: Handle set-but-empty environment variables
[sbcl.git] / src / code / early-extensions.lisp
1 ;;;; various extensions (including SB-INT "internal extensions")
2 ;;;; available both in the cross-compilation host Lisp and in the
3 ;;;; target SBCL
4
5 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; more information.
7 ;;;;
8 ;;;; This software is derived from the CMU CL system, which was
9 ;;;; written at Carnegie Mellon University and released into the
10 ;;;; public domain. The software is in the public domain and is
11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
12 ;;;; files for more information.
13
14 (in-package "SB!IMPL")
15
16 ;;; something not EQ to anything we might legitimately READ
17 (defparameter *eof-object* (make-symbol "EOF-OBJECT"))
18
19 ;;; a type used for indexing into arrays, and for related quantities
20 ;;; like lengths of lists
21 ;;;
22 ;;; It's intentionally limited to one less than the
23 ;;; ARRAY-DIMENSION-LIMIT for efficiency reasons, because in SBCL
24 ;;; ARRAY-DIMENSION-LIMIT is MOST-POSITIVE-FIXNUM, and staying below
25 ;;; that lets the system know it can increment a value of this type
26 ;;; without having to worry about using a bignum to represent the
27 ;;; result.
28 ;;;
29 ;;; (It should be safe to use ARRAY-DIMENSION-LIMIT as an exclusive
30 ;;; bound because ANSI specifies it as an exclusive bound.)
31 (def!type index () `(integer 0 (,sb!xc:array-dimension-limit)))
32
33 ;;; like INDEX, but only up to half the maximum. Used by hash-table
34 ;;; code that does plenty to (aref v (* 2 i)) and (aref v (1+ (* 2 i))).
35 (def!type index/2 () `(integer 0 (,(floor sb!xc:array-dimension-limit 2))))
36
37 ;;; like INDEX, but augmented with -1 (useful when using the index
38 ;;; to count downwards to 0, e.g. LOOP FOR I FROM N DOWNTO 0, with
39 ;;; an implementation which terminates the loop by testing for the
40 ;;; index leaving the loop range)
41 (def!type index-or-minus-1 () `(integer -1 (,sb!xc:array-dimension-limit)))
42
43 ;;; A couple of VM-related types that are currently used only on the
44 ;;; alpha platform. -- CSR, 2002-06-24
45 (def!type unsigned-byte-with-a-bite-out (s bite)
46   (cond ((eq s '*) 'integer)
47         ((and (integerp s) (> s 0))
48          (let ((bound (ash 1 s)))
49            `(integer 0 ,(- bound bite 1))))
50         (t
51          (error "Bad size specified for UNSIGNED-BYTE type specifier: ~S." s))))
52
53 ;;; Motivated by the mips port. -- CSR, 2002-08-22
54 (def!type signed-byte-with-a-bite-out (s bite)
55   (cond ((eq s '*) 'integer)
56         ((and (integerp s) (> s 1))
57          (let ((bound (ash 1 (1- s))))
58            `(integer ,(- bound) ,(- bound bite 1))))
59         (t
60          (error "Bad size specified for SIGNED-BYTE type specifier: ~S." s))))
61
62 (def!type load/store-index (scale lowtag min-offset
63                                  &optional (max-offset min-offset))
64   `(integer ,(- (truncate (+ (ash 1 16)
65                              (* min-offset sb!vm:n-word-bytes)
66                              (- lowtag))
67                           scale))
68             ,(truncate (- (+ (1- (ash 1 16)) lowtag)
69                           (* max-offset sb!vm:n-word-bytes))
70                        scale)))
71
72 #!+(or x86 x86-64)
73 (defun displacement-bounds (lowtag element-size data-offset)
74   (let* ((adjustment (- (* data-offset sb!vm:n-word-bytes) lowtag))
75          (bytes-per-element (ceiling element-size sb!vm:n-byte-bits))
76          (min (truncate (+ sb!vm::minimum-immediate-offset adjustment)
77                         bytes-per-element))
78          (max (truncate (+ sb!vm::maximum-immediate-offset adjustment)
79                         bytes-per-element)))
80     (values min max)))
81
82 #!+(or x86 x86-64)
83 (def!type constant-displacement (lowtag element-size data-offset)
84   (flet ((integerify (x)
85            (etypecase x
86              (integer x)
87              (symbol (symbol-value x)))))
88     (let ((lowtag (integerify lowtag))
89           (element-size (integerify element-size))
90           (data-offset (integerify data-offset)))
91       (multiple-value-bind (min max) (displacement-bounds lowtag
92                                                           element-size
93                                                           data-offset)
94         `(integer ,min ,max)))))
95
96 ;;; Similar to FUNCTION, but the result type is "exactly" specified:
97 ;;; if it is an object type, then the function returns exactly one
98 ;;; value, if it is a short form of VALUES, then this short form
99 ;;; specifies the exact number of values.
100 (def!type sfunction (args &optional result)
101   (let ((result (cond ((eq result '*) '*)
102                       ((or (atom result)
103                            (not (eq (car result) 'values)))
104                        `(values ,result &optional))
105                       ((intersection (cdr result) lambda-list-keywords)
106                        result)
107                       (t `(values ,@(cdr result) &optional)))))
108     `(function ,args ,result)))
109
110 ;;; a type specifier
111 ;;;
112 ;;; FIXME: The SB!KERNEL:INSTANCE here really means CL:CLASS.
113 ;;; However, the CL:CLASS type is only defined once PCL is loaded,
114 ;;; which is before this is evaluated.  Once PCL is moved into cold
115 ;;; init, this might be fixable.
116 (def!type type-specifier () '(or list symbol sb!kernel:instance))
117
118 ;;; the default value used for initializing character data. The ANSI
119 ;;; spec says this is arbitrary, so we use the value that falls
120 ;;; through when we just let the low-level consing code initialize
121 ;;; all newly-allocated memory to zero.
122 ;;;
123 ;;; KLUDGE: It might be nice to use something which is a
124 ;;; STANDARD-CHAR, both to reduce user surprise a little and, probably
125 ;;; more significantly, to help SBCL's cross-compiler (which knows how
126 ;;; to dump STANDARD-CHARs). Unfortunately, the old CMU CL code is
127 ;;; shot through with implicit assumptions that it's #\NULL, and code
128 ;;; in several places (notably both DEFUN MAKE-ARRAY and DEFTRANSFORM
129 ;;; MAKE-ARRAY) would have to be rewritten. -- WHN 2001-10-04
130 (eval-when (:compile-toplevel :load-toplevel :execute)
131   ;; an expression we can use to construct a DEFAULT-INIT-CHAR value
132   ;; at load time (so that we don't need to teach the cross-compiler
133   ;; how to represent and dump non-STANDARD-CHARs like #\NULL)
134   (defparameter *default-init-char-form* '(code-char 0)))
135
136 ;;; CHAR-CODE values for ASCII characters which we care about but
137 ;;; which aren't defined in section "2.1.3 Standard Characters" of the
138 ;;; ANSI specification for Lisp
139 ;;;
140 ;;; KLUDGE: These are typically used in the idiom (CODE-CHAR
141 ;;; FOO-CHAR-CODE). I suspect that the current implementation is
142 ;;; expanding this idiom into a full call to CODE-CHAR, which is an
143 ;;; annoying overhead. I should check whether this is happening, and
144 ;;; if so, perhaps implement a DEFTRANSFORM or something to stop it.
145 ;;; (or just find a nicer way of expressing characters portably?) --
146 ;;; WHN 19990713
147 (def!constant bell-char-code 7)
148 (def!constant backspace-char-code 8)
149 (def!constant tab-char-code 9)
150 (def!constant line-feed-char-code 10)
151 (def!constant form-feed-char-code 12)
152 (def!constant return-char-code 13)
153 (def!constant escape-char-code 27)
154 (def!constant rubout-char-code 127)
155 \f
156 ;;;; type-ish predicates
157
158 ;;; X may contain cycles -- a conservative approximation. This
159 ;;; occupies a somewhat uncomfortable niche between being fast for
160 ;;; common cases (we don't want to allocate a hash-table), and not
161 ;;; falling down to exponential behaviour for large trees (so we set
162 ;;; an arbitrady depth limit beyond which we punt).
163 (defun maybe-cyclic-p (x &optional (depth-limit 12))
164   (and (listp x)
165        (labels ((safe-cddr (cons)
166                   (let ((cdr (cdr cons)))
167                     (when (consp cdr)
168                       (cdr cdr))))
169                 (check-cycle (object seen depth)
170                   (when (and (consp object)
171                              (or (> depth depth-limit)
172                                  (member object seen)
173                                  (circularp object seen depth)))
174                     (return-from maybe-cyclic-p t)))
175                 (circularp (list seen depth)
176                   ;; Almost regular circular list detection, with a twist:
177                   ;; we also check each element of the list for upward
178                   ;; references using CHECK-CYCLE.
179                   (do ((fast (cons (car list) (cdr list)) (safe-cddr fast))
180                        (slow list (cdr slow)))
181                       ((not (consp fast))
182                        ;; Not CDR-circular, need to check remaining CARs yet
183                        (do ((tail slow (and (cdr tail))))
184                            ((not (consp tail))
185                             nil)
186                          (check-cycle (car tail) (cons tail seen) (1+ depth))))
187                     (check-cycle (car slow) (cons slow seen) (1+ depth))
188                     (when (eq fast slow)
189                       (return t)))))
190          (circularp x (list x) 0))))
191
192 ;;; Is X a (possibly-improper) list of at least N elements?
193 (declaim (ftype (function (t index)) list-of-length-at-least-p))
194 (defun list-of-length-at-least-p (x n)
195   (or (zerop n) ; since anything can be considered an improper list of length 0
196       (and (consp x)
197            (list-of-length-at-least-p (cdr x) (1- n)))))
198
199 (declaim (inline singleton-p))
200 (defun singleton-p (list)
201   (and (consp list)
202        (null (rest list))))
203
204 ;;; Is X is a positive prime integer?
205 (defun positive-primep (x)
206   ;; This happens to be called only from one place in sbcl-0.7.0, and
207   ;; only for fixnums, we can limit it to fixnums for efficiency. (And
208   ;; if we didn't limit it to fixnums, we should use a cleverer
209   ;; algorithm, since this one scales pretty badly for huge X.)
210   (declare (fixnum x))
211   (if (<= x 5)
212       (and (>= x 2) (/= x 4))
213       (and (not (evenp x))
214            (not (zerop (rem x 3)))
215            (do ((q 6)
216                 (r 1)
217                 (inc 2 (logxor inc 6)) ;; 2,4,2,4...
218                 (d 5 (+ d inc)))
219                ((or (= r 0) (> d q)) (/= r 0))
220              (declare (fixnum inc))
221              (multiple-value-setq (q r) (truncate x d))))))
222
223 ;;; Could this object contain other objects? (This is important to
224 ;;; the implementation of things like *PRINT-CIRCLE* and the dumper.)
225 (defun compound-object-p (x)
226   (or (consp x)
227       (%instancep x)
228       (typep x '(array t *))))
229 \f
230 ;;;; the COLLECT macro
231 ;;;;
232 ;;;; comment from CMU CL: "the ultimate collection macro..."
233
234 ;;; helper functions for COLLECT, which become the expanders of the
235 ;;; MACROLET definitions created by COLLECT
236 ;;;
237 ;;; COLLECT-NORMAL-EXPANDER handles normal collection macros.
238 ;;;
239 ;;; COLLECT-LIST-EXPANDER handles the list collection case. N-TAIL
240 ;;; is the pointer to the current tail of the list, or NIL if the list
241 ;;; is empty.
242 (eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
243   (defun collect-normal-expander (n-value fun forms)
244     `(progn
245        ,@(mapcar (lambda (form) `(setq ,n-value (,fun ,form ,n-value))) forms)
246        ,n-value))
247   (defun collect-list-expander (n-value n-tail forms)
248     (let ((n-res (gensym)))
249       `(progn
250          ,@(mapcar (lambda (form)
251                      `(let ((,n-res (cons ,form nil)))
252                         (cond (,n-tail
253                                (setf (cdr ,n-tail) ,n-res)
254                                (setq ,n-tail ,n-res))
255                               (t
256                                (setq ,n-tail ,n-res  ,n-value ,n-res)))))
257                    forms)
258          ,n-value))))
259
260 ;;; Collect some values somehow. Each of the collections specifies a
261 ;;; bunch of things which collected during the evaluation of the body
262 ;;; of the form. The name of the collection is used to define a local
263 ;;; macro, a la MACROLET. Within the body, this macro will evaluate
264 ;;; each of its arguments and collect the result, returning the
265 ;;; current value after the collection is done. The body is evaluated
266 ;;; as a PROGN; to get the final values when you are done, just call
267 ;;; the collection macro with no arguments.
268 ;;;
269 ;;; INITIAL-VALUE is the value that the collection starts out with,
270 ;;; which defaults to NIL. FUNCTION is the function which does the
271 ;;; collection. It is a function which will accept two arguments: the
272 ;;; value to be collected and the current collection. The result of
273 ;;; the function is made the new value for the collection. As a
274 ;;; totally magical special-case, FUNCTION may be COLLECT, which tells
275 ;;; us to build a list in forward order; this is the default. If an
276 ;;; INITIAL-VALUE is supplied for COLLECT, the stuff will be RPLACD'd
277 ;;; onto the end. Note that FUNCTION may be anything that can appear
278 ;;; in the functional position, including macros and lambdas.
279 (defmacro collect (collections &body body)
280   (let ((macros ())
281         (binds ()))
282     (dolist (spec collections)
283       (unless (proper-list-of-length-p spec 1 3)
284         (error "malformed collection specifier: ~S" spec))
285       (let* ((name (first spec))
286              (default (second spec))
287              (kind (or (third spec) 'collect))
288              (n-value (gensym (concatenate 'string
289                                            (symbol-name name)
290                                            "-N-VALUE-"))))
291         (push `(,n-value ,default) binds)
292         (if (eq kind 'collect)
293           (let ((n-tail (gensym (concatenate 'string
294                                              (symbol-name name)
295                                              "-N-TAIL-"))))
296             (if default
297               (push `(,n-tail (last ,n-value)) binds)
298               (push n-tail binds))
299             (push `(,name (&rest args)
300                      (collect-list-expander ',n-value ',n-tail args))
301                   macros))
302           (push `(,name (&rest args)
303                    (collect-normal-expander ',n-value ',kind args))
304                 macros))))
305     `(macrolet ,macros (let* ,(nreverse binds) ,@body))))
306 \f
307 ;;;; some old-fashioned functions. (They're not just for old-fashioned
308 ;;;; code, they're also used as optimized forms of the corresponding
309 ;;;; general functions when the compiler can prove that they're
310 ;;;; equivalent.)
311
312 ;;; like (MEMBER ITEM LIST :TEST #'EQ)
313 (defun memq (item list)
314   #!+sb-doc
315   "Return tail of LIST beginning with first element EQ to ITEM."
316   ;; KLUDGE: These could be and probably should be defined as
317   ;;   (MEMBER ITEM LIST :TEST #'EQ)),
318   ;; but when I try to cross-compile that, I get an error from
319   ;; LTN-ANALYZE-KNOWN-CALL, "Recursive known function definition". The
320   ;; comments for that error say it "is probably a botched interpreter stub".
321   ;; Rather than try to figure that out, I just rewrote this function from
322   ;; scratch. -- WHN 19990512
323   (do ((i list (cdr i)))
324       ((null i))
325     (when (eq (car i) item)
326       (return i))))
327
328 ;;; like (ASSOC ITEM ALIST :TEST #'EQ):
329 ;;;   Return the first pair of ALIST where ITEM is EQ to the key of
330 ;;;   the pair.
331 (defun assq (item alist)
332   ;; KLUDGE: CMU CL defined this with
333   ;;   (DECLARE (INLINE ASSOC))
334   ;;   (ASSOC ITEM ALIST :TEST #'EQ))
335   ;; which is pretty, but which would have required adding awkward
336   ;; build order constraints on SBCL (or figuring out some way to make
337   ;; inline definitions installable at build-the-cross-compiler time,
338   ;; which was too ambitious for now). Rather than mess with that, we
339   ;; just define ASSQ explicitly in terms of more primitive
340   ;; operations:
341   (dolist (pair alist)
342     ;; though it may look more natural to write this as
343     ;;   (AND PAIR (EQ (CAR PAIR) ITEM))
344     ;; the temptation to do so should be resisted, as pointed out by PFD
345     ;; sbcl-devel 2003-08-16, as NIL elements are rare in association
346     ;; lists.  -- CSR, 2003-08-16
347     (when (and (eq (car pair) item) (not (null pair)))
348       (return pair))))
349
350 ;;; like (DELETE .. :TEST #'EQ):
351 ;;;   Delete all LIST entries EQ to ITEM (destructively modifying
352 ;;;   LIST), and return the modified LIST.
353 (defun delq (item list)
354   (let ((list list))
355     (do ((x list (cdr x))
356          (splice '()))
357         ((endp x) list)
358       (cond ((eq item (car x))
359              (if (null splice)
360                (setq list (cdr x))
361                (rplacd splice (cdr x))))
362             (t (setq splice x)))))) ; Move splice along to include element.
363
364
365 ;;; like (POSITION .. :TEST #'EQ):
366 ;;;   Return the position of the first element EQ to ITEM.
367 (defun posq (item list)
368   (do ((i list (cdr i))
369        (j 0 (1+ j)))
370       ((null i))
371     (when (eq (car i) item)
372       (return j))))
373
374 (declaim (inline neq))
375 (defun neq (x y)
376   (not (eq x y)))
377
378 ;;; not really an old-fashioned function, but what the calling
379 ;;; convention should've been: like NTH, but with the same argument
380 ;;; order as in all the other dereferencing functions, with the
381 ;;; collection first and the index second
382 (declaim (inline nth-but-with-sane-arg-order))
383 (declaim (ftype (function (list index) t) nth-but-with-sane-arg-order))
384 (defun nth-but-with-sane-arg-order (list index)
385   (nth index list))
386
387 (defun adjust-list (list length initial-element)
388   (let ((old-length (length list)))
389     (cond ((< old-length length)
390            (append list (make-list (- length old-length)
391                                    :initial-element initial-element)))
392           ((> old-length length)
393            (subseq list 0 length))
394           (t list))))
395 \f
396 ;;;; miscellaneous iteration extensions
397
398 ;;; "the ultimate iteration macro"
399 ;;;
400 ;;; note for Schemers: This seems to be identical to Scheme's "named LET".
401 (defmacro named-let (name binds &body body)
402   #!+sb-doc
403   (dolist (x binds)
404     (unless (proper-list-of-length-p x 2)
405       (error "malformed NAMED-LET variable spec: ~S" x)))
406   `(labels ((,name ,(mapcar #'first binds) ,@body))
407      (,name ,@(mapcar #'second binds))))
408
409 (defun filter-dolist-declarations (decls)
410   (mapcar (lambda (decl)
411             `(declare ,@(remove-if
412                          (lambda (clause)
413                            (and (consp clause)
414                                 (or (eq (car clause) 'type)
415                                     (eq (car clause) 'ignore))))
416                          (cdr decl))))
417           decls))
418
419 ;;; just like DOLIST, but with one-dimensional arrays
420 (defmacro dovector ((elt vector &optional result) &body body)
421   (multiple-value-bind (forms decls) (parse-body body :doc-string-allowed nil)
422     (with-unique-names (index length vec)
423       `(let ((,vec ,vector))
424         (declare (type vector ,vec))
425         (do ((,index 0 (1+ ,index))
426              (,length (length ,vec)))
427             ((>= ,index ,length) (let ((,elt nil))
428                                    ,@(filter-dolist-declarations decls)
429                                    ,elt
430                                    ,result))
431           (let ((,elt (aref ,vec ,index)))
432             ,@decls
433             (tagbody
434                ,@forms)))))))
435
436 ;;; Iterate over the entries in a HASH-TABLE.
437 (defmacro dohash ((key-var value-var table &optional result) &body body)
438   (multiple-value-bind (forms decls) (parse-body body :doc-string-allowed nil)
439     (let ((gen (gensym))
440           (n-more (gensym)))
441       `(with-hash-table-iterator (,gen ,table)
442          (loop
443           (multiple-value-bind (,n-more ,key-var ,value-var) (,gen)
444             ,@decls
445             (unless ,n-more (return ,result))
446             ,@forms))))))
447 \f
448 ;;;; hash cache utility
449
450 (eval-when (:compile-toplevel :load-toplevel :execute)
451   (defvar *profile-hash-cache* nil))
452
453 ;;; a flag for whether it's too early in cold init to use caches so
454 ;;; that we have a better chance of recovering so that we have a
455 ;;; better chance of getting the system running so that we have a
456 ;;; better chance of diagnosing the problem which caused us to use the
457 ;;; caches too early
458 #!+sb-show
459 (defvar *hash-caches-initialized-p*)
460
461 ;;; Define a hash cache that associates some number of argument values
462 ;;; with a result value. The TEST-FUNCTION paired with each ARG-NAME
463 ;;; is used to compare the value for that arg in a cache entry with a
464 ;;; supplied arg. The TEST-FUNCTION must not error when passed NIL as
465 ;;; its first arg, but need not return any particular value.
466 ;;; TEST-FUNCTION may be any thing that can be placed in CAR position.
467 ;;;
468 ;;; This code used to store all the arguments / return values directly
469 ;;; in the cache vector. This was both interrupt- and thread-unsafe, since
470 ;;; it was possible that *-CACHE-ENTER would scribble over a region of the
471 ;;; cache vector which *-CACHE-LOOKUP had only partially processed. Instead
472 ;;; we now store the contents of each cache bucket as a separate array, which
473 ;;; is stored in the appropriate cell in the cache vector. A new bucket array
474 ;;; is created every time *-CACHE-ENTER is called, and the old ones are never
475 ;;; modified. This means that *-CACHE-LOOKUP will always work with a set
476 ;;; of consistent data. The overhead caused by consing new buckets seems to
477 ;;; be insignificant on the grand scale of things. -- JES, 2006-11-02
478 ;;;
479 ;;; NAME is used to define these functions:
480 ;;; <name>-CACHE-LOOKUP Arg*
481 ;;;   See whether there is an entry for the specified ARGs in the
482 ;;;   cache. If not present, the :DEFAULT keyword (default NIL)
483 ;;;   determines the result(s).
484 ;;; <name>-CACHE-ENTER Arg* Value*
485 ;;;   Encache the association of the specified args with VALUE.
486 ;;; <name>-CACHE-CLEAR
487 ;;;   Reinitialize the cache, invalidating all entries and allowing
488 ;;;   the arguments and result values to be GC'd.
489 ;;;
490 ;;; These other keywords are defined:
491 ;;; :HASH-BITS <n>
492 ;;;   The size of the cache as a power of 2.
493 ;;; :HASH-FUNCTION function
494 ;;;   Some thing that can be placed in CAR position which will compute
495 ;;;   a value between 0 and (1- (expt 2 <hash-bits>)).
496 ;;; :VALUES <n>
497 ;;;   the number of return values cached for each function call
498 ;;; :INIT-WRAPPER <name>
499 ;;;   The code for initializing the cache is wrapped in a form with
500 ;;;   the specified name. (:INIT-WRAPPER is set to COLD-INIT-FORMS
501 ;;;   in type system definitions so that caches will be created
502 ;;;   before top level forms run.)
503 (defmacro define-hash-cache (name args &key hash-function hash-bits default
504                                   (init-wrapper 'progn)
505                                   (values 1))
506   (let* ((var-name (symbolicate "*" name "-CACHE-VECTOR*"))
507          (nargs (length args))
508          (size (ash 1 hash-bits))
509          (default-values (if (and (consp default) (eq (car default) 'values))
510                              (cdr default)
511                              (list default)))
512          (args-and-values (gensym))
513          (args-and-values-size (+ nargs values))
514          (n-index (gensym))
515          (n-cache (gensym)))
516
517     (unless (= (length default-values) values)
518       (error "The number of default values ~S differs from :VALUES ~W."
519              default values))
520
521     (collect ((inlines)
522               (forms)
523               (inits)
524               (sets)
525               (tests)
526               (arg-vars)
527               (values-refs)
528               (values-names))
529       (dotimes (i values)
530         (let ((name (gensym)))
531           (values-names name)
532           (values-refs `(svref ,args-and-values (+ ,nargs ,i)))
533           (sets `(setf (svref ,args-and-values (+ ,nargs ,i)) ,name))))
534       (let ((n 0))
535         (dolist (arg args)
536           (unless (= (length arg) 2)
537             (error "bad argument spec: ~S" arg))
538           (let ((arg-name (first arg))
539                 (test (second arg)))
540             (arg-vars arg-name)
541             (tests `(,test (svref ,args-and-values ,n) ,arg-name))
542             (sets `(setf (svref ,args-and-values ,n) ,arg-name)))
543           (incf n)))
544
545       (when *profile-hash-cache*
546         (let ((n-probe (symbolicate "*" name "-CACHE-PROBES*"))
547               (n-miss (symbolicate "*" name "-CACHE-MISSES*")))
548           (inits `(setq ,n-probe 0))
549           (inits `(setq ,n-miss 0))
550           (forms `(defvar ,n-probe))
551           (forms `(defvar ,n-miss))
552           (forms `(declaim (fixnum ,n-miss ,n-probe)))))
553
554       (let ((fun-name (symbolicate name "-CACHE-LOOKUP")))
555         (inlines fun-name)
556         (forms
557          `(defun ,fun-name ,(arg-vars)
558             ,@(when *profile-hash-cache*
559                 `((incf ,(symbolicate  "*" name "-CACHE-PROBES*"))))
560             (let* ((,n-index (,hash-function ,@(arg-vars)))
561                    (,n-cache ,var-name)
562                    (,args-and-values (svref ,n-cache ,n-index)))
563               (cond ((and ,args-and-values
564                           ,@(tests))
565                      (values ,@(values-refs)))
566                     (t
567                      ,@(when *profile-hash-cache*
568                          `((incf ,(symbolicate  "*" name "-CACHE-MISSES*"))))
569                      ,default))))))
570
571       (let ((fun-name (symbolicate name "-CACHE-ENTER")))
572         (inlines fun-name)
573         (forms
574          `(defun ,fun-name (,@(arg-vars) ,@(values-names))
575             (let ((,n-index (,hash-function ,@(arg-vars)))
576                   (,n-cache ,var-name)
577                   (,args-and-values (make-array ,args-and-values-size)))
578               ,@(sets)
579               (setf (svref ,n-cache ,n-index) ,args-and-values))
580             (values))))
581
582       (let ((fun-name (symbolicate name "-CACHE-CLEAR")))
583         (forms
584          `(defun ,fun-name ()
585             (fill ,var-name nil)))
586         (forms `(,fun-name)))
587
588       (inits `(unless (boundp ',var-name)
589                 (setq ,var-name (make-array ,size :initial-element nil))))
590       #!+sb-show (inits `(setq *hash-caches-initialized-p* t))
591
592       `(progn
593          (defvar ,var-name)
594          (declaim (type (simple-vector ,size) ,var-name))
595          #!-sb-fluid (declaim (inline ,@(inlines)))
596          (,init-wrapper ,@(inits))
597          ,@(forms)
598          ',name))))
599
600 ;;; some syntactic sugar for defining a function whose values are
601 ;;; cached by DEFINE-HASH-CACHE
602 (defmacro defun-cached ((name &rest options &key (values 1) default
603                               &allow-other-keys)
604                         args &body body-decls-doc)
605   (let ((default-values (if (and (consp default) (eq (car default) 'values))
606                             (cdr default)
607                             (list default)))
608         (arg-names (mapcar #'car args)))
609     (collect ((values-names))
610       (dotimes (i values)
611         (values-names (gensym)))
612       (multiple-value-bind (body decls doc) (parse-body body-decls-doc)
613         `(progn
614            (define-hash-cache ,name ,args ,@options)
615            (defun ,name ,arg-names
616              ,@decls
617              ,doc
618              (cond #!+sb-show
619                    ((not (boundp '*hash-caches-initialized-p*))
620                     ;; This shouldn't happen, but it did happen to me
621                     ;; when revising the type system, and it's a lot
622                     ;; easier to figure out what what's going on with
623                     ;; that kind of problem if the system can be kept
624                     ;; alive until cold boot is complete. The recovery
625                     ;; mechanism should definitely be conditional on
626                     ;; some debugging feature (e.g. SB-SHOW) because
627                     ;; it's big, duplicating all the BODY code. -- WHN
628                     (/show0 ,name " too early in cold init, uncached")
629                     (/show0 ,(first arg-names) "=..")
630                     (/hexstr ,(first arg-names))
631                     ,@body)
632                    (t
633                     (multiple-value-bind ,(values-names)
634                         (,(symbolicate name "-CACHE-LOOKUP") ,@arg-names)
635                       (if (and ,@(mapcar (lambda (val def)
636                                            `(eq ,val ,def))
637                                          (values-names) default-values))
638                           (multiple-value-bind ,(values-names)
639                               (progn ,@body)
640                             (,(symbolicate name "-CACHE-ENTER") ,@arg-names
641                              ,@(values-names))
642                             (values ,@(values-names)))
643                           (values ,@(values-names))))))))))))
644
645 (defmacro define-cached-synonym
646     (name &optional (original (symbolicate "%" name)))
647   (let ((cached-name (symbolicate "%%" name "-CACHED")))
648     `(progn
649        (defun-cached (,cached-name :hash-bits 8
650                                    :hash-function (lambda (x)
651                                                     (logand (sxhash x) #xff)))
652            ((args equal))
653          (apply #',original args))
654        (defun ,name (&rest args)
655          (,cached-name args)))))
656
657 ;;; FIXME: maybe not the best place
658 ;;;
659 ;;; FIXME: think of a better name -- not only does this not have the
660 ;;; CAR recursion of EQUAL, it also doesn't have the special treatment
661 ;;; of pathnames, bit-vectors and strings.
662 ;;;
663 ;;; KLUDGE: This means that we will no longer cache specifiers of the
664 ;;; form '(INTEGER (0) 4).  This is probably not a disaster.
665 ;;;
666 ;;; A helper function for the type system, which is the main user of
667 ;;; these caches: we must be more conservative than EQUAL for some of
668 ;;; our equality tests, because MEMBER and friends refer to EQLity.
669 ;;; So:
670 (defun equal-but-no-car-recursion (x y)
671   (cond
672     ((eql x y) t)
673     ((consp x)
674      (and (consp y)
675           (eql (car x) (car y))
676           (equal-but-no-car-recursion (cdr x) (cdr y))))
677     (t nil)))
678 \f
679 ;;;; package idioms
680
681 ;;; Note: Almost always you want to use FIND-UNDELETED-PACKAGE-OR-LOSE
682 ;;; instead of this function. (The distinction only actually matters when
683 ;;; PACKAGE-DESIGNATOR is actually a deleted package, and in that case
684 ;;; you generally do want to signal an error instead of proceeding.)
685 (defun %find-package-or-lose (package-designator)
686   (or (find-package package-designator)
687       (error 'sb!kernel:simple-package-error
688              :package package-designator
689              :format-control "The name ~S does not designate any package."
690              :format-arguments (list package-designator))))
691
692 ;;; ANSI specifies (in the section for FIND-PACKAGE) that the
693 ;;; consequences of most operations on deleted packages are
694 ;;; unspecified. We try to signal errors in such cases.
695 (defun find-undeleted-package-or-lose (package-designator)
696   (let ((maybe-result (%find-package-or-lose package-designator)))
697     (if (package-name maybe-result)     ; if not deleted
698         maybe-result
699         (error 'sb!kernel:simple-package-error
700                :package maybe-result
701                :format-control "The package ~S has been deleted."
702                :format-arguments (list maybe-result)))))
703 \f
704 ;;;; various operations on names
705
706 ;;; Is NAME a legal function name?
707 (declaim (inline legal-fun-name-p))
708 (defun legal-fun-name-p (name)
709   (values (valid-function-name-p name)))
710
711 (deftype function-name () '(satisfies legal-fun-name-p))
712
713 ;;; Signal an error unless NAME is a legal function name.
714 (defun legal-fun-name-or-type-error (name)
715   (unless (legal-fun-name-p name)
716     (error 'simple-type-error
717            :datum name
718            :expected-type 'function-name
719            :format-control "invalid function name: ~S"
720            :format-arguments (list name))))
721
722 ;;; Given a function name, return the symbol embedded in it.
723 ;;;
724 ;;; The ordinary use for this operator (and the motivation for the
725 ;;; name of this operator) is to convert from a function name to the
726 ;;; name of the BLOCK which encloses its body.
727 ;;;
728 ;;; Occasionally the operator is useful elsewhere, where the operator
729 ;;; name is less mnemonic. (Maybe it should be changed?)
730 (declaim (ftype (function ((or symbol cons)) symbol) fun-name-block-name))
731 (defun fun-name-block-name (fun-name)
732   (cond ((symbolp fun-name)
733          fun-name)
734         ((consp fun-name)
735          (multiple-value-bind (legalp block-name)
736              (valid-function-name-p fun-name)
737            (if legalp
738                block-name
739                (error "not legal as a function name: ~S" fun-name))))
740         (t
741          (error "not legal as a function name: ~S" fun-name))))
742
743 (defun looks-like-name-of-special-var-p (x)
744   (and (symbolp x)
745        (let ((name (symbol-name x)))
746          (and (> (length name) 2) ; to exclude '* and '**
747               (char= #\* (aref name 0))
748               (char= #\* (aref name (1- (length name))))))))
749
750 ;;; Some symbols are defined by ANSI to be self-evaluating. Return
751 ;;; non-NIL for such symbols (and make the non-NIL value a traditional
752 ;;; message, for use in contexts where the user asks us to change such
753 ;;; a symbol).
754 (defun symbol-self-evaluating-p (symbol)
755   (declare (type symbol symbol))
756   (cond ((eq symbol t)
757          "Veritas aeterna. (can't change T)")
758         ((eq symbol nil)
759          "Nihil ex nihil. (can't change NIL)")
760         ((keywordp symbol)
761          "Keyword values can't be changed.")
762         (t
763          nil)))
764
765 ;;; This function is to be called just before a change which would
766 ;;; affect the symbol value. (We don't absolutely have to call this
767 ;;; function before such changes, since such changes are given as
768 ;;; undefined behavior. In particular, we don't if the runtime cost
769 ;;; would be annoying. But otherwise it's nice to do so.)
770 (defun about-to-modify-symbol-value (symbol)
771   (declare (type symbol symbol))
772   (let ((reason (symbol-self-evaluating-p symbol)))
773     (when reason
774       (error reason)))
775   ;; (Note: Just because a value is CONSTANTP is not a good enough
776   ;; reason to complain here, because we want DEFCONSTANT to be able
777   ;; to use this function, and it's legal to DEFCONSTANT a constant as
778   ;; long as the new value is EQL to the old value.)
779   (values))
780
781
782 ;;; If COLD-FSET occurs not at top level, just treat it as an ordinary
783 ;;; assignment instead of doing cold static linking. That way things like
784 ;;;   (FLET ((FROB (X) ..))
785 ;;;     (DEFUN FOO (X Y) (FROB X) ..)
786 ;;;     (DEFUN BAR (Z) (AND (FROB X) ..)))
787 ;;; can still "work" for cold init: they don't do magical static
788 ;;; linking the way that true toplevel DEFUNs do, but at least they do
789 ;;; the linking eventually, so as long as #'FOO and #'BAR aren't
790 ;;; needed until "cold toplevel forms" have executed, it's OK.
791 (defmacro cold-fset (name lambda)
792   (style-warn
793    "~@<COLD-FSET ~S not cross-compiled at top level: demoting to ~
794 (SETF FDEFINITION)~:@>"
795    name)
796   ;; We convert the LAMBDA expression to the corresponding NAMED-LAMBDA
797   ;; expression so that the compiler can use NAME in debug names etc.
798   (destructuring-bind (lambda-symbol &rest lambda-rest) lambda
799     (assert (eql lambda-symbol 'lambda)) ; else dunno how to do conversion
800     `(setf (fdefinition ',name)
801            (named-lambda ,name ,@lambda-rest))))
802 \f
803 ;;;; ONCE-ONLY
804 ;;;;
805 ;;;; "The macro ONCE-ONLY has been around for a long time on various
806 ;;;; systems [..] if you can understand how to write and when to use
807 ;;;; ONCE-ONLY, then you truly understand macro." -- Peter Norvig,
808 ;;;; _Paradigms of Artificial Intelligence Programming: Case Studies
809 ;;;; in Common Lisp_, p. 853
810
811 ;;; ONCE-ONLY is a utility useful in writing source transforms and
812 ;;; macros. It provides a concise way to wrap a LET around some code
813 ;;; to ensure that some forms are only evaluated once.
814 ;;;
815 ;;; Create a LET* which evaluates each value expression, binding a
816 ;;; temporary variable to the result, and wrapping the LET* around the
817 ;;; result of the evaluation of BODY. Within the body, each VAR is
818 ;;; bound to the corresponding temporary variable.
819 (defmacro once-only (specs &body body)
820   (named-let frob ((specs specs)
821                    (body body))
822     (if (null specs)
823         `(progn ,@body)
824         (let ((spec (first specs)))
825           ;; FIXME: should just be DESTRUCTURING-BIND of SPEC
826           (unless (proper-list-of-length-p spec 2)
827             (error "malformed ONCE-ONLY binding spec: ~S" spec))
828           (let* ((name (first spec))
829                  (exp-temp (gensym (symbol-name name))))
830             `(let ((,exp-temp ,(second spec))
831                    (,name (gensym "ONCE-ONLY-")))
832                `(let ((,,name ,,exp-temp))
833                   ,,(frob (rest specs) body))))))))
834 \f
835 ;;;; various error-checking utilities
836
837 ;;; This function can be used as the default value for keyword
838 ;;; arguments that must be always be supplied. Since it is known by
839 ;;; the compiler to never return, it will avoid any compile-time type
840 ;;; warnings that would result from a default value inconsistent with
841 ;;; the declared type. When this function is called, it signals an
842 ;;; error indicating that a required &KEY argument was not supplied.
843 ;;; This function is also useful for DEFSTRUCT slot defaults
844 ;;; corresponding to required arguments.
845 (declaim (ftype (function () nil) missing-arg))
846 (defun missing-arg ()
847   #!+sb-doc
848   (/show0 "entering MISSING-ARG")
849   (error "A required &KEY or &OPTIONAL argument was not supplied."))
850
851 ;;; like CL:ASSERT and CL:CHECK-TYPE, but lighter-weight
852 ;;;
853 ;;; (As of sbcl-0.6.11.20, we were using some 400 calls to CL:ASSERT.
854 ;;; The CL:ASSERT restarts and whatnot expand into a significant
855 ;;; amount of code when you multiply them by 400, so replacing them
856 ;;; with this should reduce the size of the system by enough to be
857 ;;; worthwhile. ENFORCE-TYPE is much less common, but might still be
858 ;;; worthwhile, and since I don't really like CERROR stuff deep in the
859 ;;; guts of complex systems anyway, I replaced it too.)
860 (defmacro aver (expr)
861   `(unless ,expr
862      (%failed-aver ,(format nil "~A" expr))))
863
864 (defun %failed-aver (expr-as-string)
865   ;; hackish way to tell we're in a cold sbcl and output the
866   ;; message before signallign error, as it may be this is too
867   ;; early in the cold init.
868   (when (find-package "SB!C")
869     (fresh-line)
870     (write-line "failed AVER:")
871     (write-line expr-as-string)
872     (terpri))
873   (bug "~@<failed AVER: ~2I~_~S~:>" expr-as-string))
874
875 (defun bug (format-control &rest format-arguments)
876   (error 'bug
877          :format-control format-control
878          :format-arguments format-arguments))
879
880 (defmacro enforce-type (value type)
881   (once-only ((value value))
882     `(unless (typep ,value ',type)
883        (%failed-enforce-type ,value ',type))))
884
885 (defun %failed-enforce-type (value type)
886   ;; maybe should be TYPE-BUG, subclass of BUG?  If it is changed,
887   ;; check uses of it in user-facing code (e.g. WARN)
888   (error 'simple-type-error
889          :datum value
890          :expected-type type
891          :format-control "~@<~S ~_is not a ~_~S~:>"
892          :format-arguments (list value type)))
893 \f
894 ;;; Return a function like FUN, but expecting its (two) arguments in
895 ;;; the opposite order that FUN does.
896 (declaim (inline swapped-args-fun))
897 (defun swapped-args-fun (fun)
898   (declare (type function fun))
899   (lambda (x y)
900     (funcall fun y x)))
901
902 ;;; Return the numeric value of a type bound, i.e. an interval bound
903 ;;; more or less in the format of bounds in ANSI's type specifiers,
904 ;;; where a bare numeric value is a closed bound and a list of a
905 ;;; single numeric value is an open bound.
906 ;;;
907 ;;; The "more or less" bit is that the no-bound-at-all case is
908 ;;; represented by NIL (not by * as in ANSI type specifiers); and in
909 ;;; this case we return NIL.
910 (defun type-bound-number (x)
911   (if (consp x)
912       (destructuring-bind (result) x result)
913       x))
914
915 ;;; some commonly-occuring CONSTANTLY forms
916 (macrolet ((def-constantly-fun (name constant-expr)
917              `(setf (symbol-function ',name)
918                     (constantly ,constant-expr))))
919   (def-constantly-fun constantly-t t)
920   (def-constantly-fun constantly-nil nil)
921   (def-constantly-fun constantly-0 0))
922
923 ;;; If X is a symbol, see whether it is present in *FEATURES*. Also
924 ;;; handle arbitrary combinations of atoms using NOT, AND, OR.
925 (defun featurep (x)
926   (etypecase x
927     (cons
928      (case (car x)
929        ((:not not)
930         (cond
931           ((cddr x)
932            (error "too many subexpressions in feature expression: ~S" x))
933           ((null (cdr x))
934            (error "too few subexpressions in feature expression: ~S" x))
935           (t (not (featurep (cadr x))))))
936        ((:and and) (every #'featurep (cdr x)))
937        ((:or or) (some #'featurep (cdr x)))
938        (t
939         (error "unknown operator in feature expression: ~S." x))))
940     (symbol (not (null (memq x *features*))))))
941 \f
942 ;;;; utilities for two-VALUES predicates
943
944 (defmacro not/type (x)
945   (let ((val (gensym "VAL"))
946         (win (gensym "WIN")))
947     `(multiple-value-bind (,val ,win)
948          ,x
949        (if ,win
950            (values (not ,val) t)
951            (values nil nil)))))
952
953 (defmacro and/type (x y)
954   `(multiple-value-bind (val1 win1) ,x
955      (if (and (not val1) win1)
956          (values nil t)
957          (multiple-value-bind (val2 win2) ,y
958            (if (and val1 val2)
959                (values t t)
960                (values nil (and win2 (not val2))))))))
961
962 ;;; sort of like ANY and EVERY, except:
963 ;;;   * We handle two-VALUES predicate functions, as SUBTYPEP does.
964 ;;;     (And if the result is uncertain, then we return (VALUES NIL NIL),
965 ;;;     as SUBTYPEP does.)
966 ;;;   * THING is just an atom, and we apply OP (an arity-2 function)
967 ;;;     successively to THING and each element of LIST.
968 (defun any/type (op thing list)
969   (declare (type function op))
970   (let ((certain? t))
971     (dolist (i list (values nil certain?))
972       (multiple-value-bind (sub-value sub-certain?) (funcall op thing i)
973         (if sub-certain?
974             (when sub-value (return (values t t)))
975             (setf certain? nil))))))
976 (defun every/type (op thing list)
977   (declare (type function op))
978   (let ((certain? t))
979     (dolist (i list (if certain? (values t t) (values nil nil)))
980       (multiple-value-bind (sub-value sub-certain?) (funcall op thing i)
981         (if sub-certain?
982             (unless sub-value (return (values nil t)))
983             (setf certain? nil))))))
984 \f
985 ;;;; DEFPRINTER
986
987 ;;; These functions are called by the expansion of the DEFPRINTER
988 ;;; macro to do the actual printing.
989 (declaim (ftype (function (symbol t stream) (values))
990                 defprinter-prin1 defprinter-princ))
991 (defun defprinter-prin1 (name value stream)
992   (defprinter-prinx #'prin1 name value stream))
993 (defun defprinter-princ (name value stream)
994   (defprinter-prinx #'princ name value stream))
995 (defun defprinter-prinx (prinx name value stream)
996   (declare (type function prinx))
997   (when *print-pretty*
998     (pprint-newline :linear stream))
999   (format stream ":~A " name)
1000   (funcall prinx value stream)
1001   (values))
1002 (defun defprinter-print-space (stream)
1003   (write-char #\space stream))
1004
1005 ;;; Define some kind of reasonable PRINT-OBJECT method for a
1006 ;;; STRUCTURE-OBJECT class.
1007 ;;;
1008 ;;; NAME is the name of the structure class, and CONC-NAME is the same
1009 ;;; as in DEFSTRUCT.
1010 ;;;
1011 ;;; The SLOT-DESCS describe how each slot should be printed. Each
1012 ;;; SLOT-DESC can be a slot name, indicating that the slot should
1013 ;;; simply be printed. A SLOT-DESC may also be a list of a slot name
1014 ;;; and other stuff. The other stuff is composed of keywords followed
1015 ;;; by expressions. The expressions are evaluated with the variable
1016 ;;; which is the slot name bound to the value of the slot. These
1017 ;;; keywords are defined:
1018 ;;;
1019 ;;; :PRIN1    Print the value of the expression instead of the slot value.
1020 ;;; :PRINC    Like :PRIN1, only PRINC the value
1021 ;;; :TEST     Only print something if the test is true.
1022 ;;;
1023 ;;; If no printing thing is specified then the slot value is printed
1024 ;;; as if by PRIN1.
1025 ;;;
1026 ;;; The structure being printed is bound to STRUCTURE and the stream
1027 ;;; is bound to STREAM.
1028 (defmacro defprinter ((name
1029                        &key
1030                        (conc-name (concatenate 'simple-string
1031                                                (symbol-name name)
1032                                                "-"))
1033                        identity)
1034                       &rest slot-descs)
1035   (let ((first? t)
1036         maybe-print-space
1037         (reversed-prints nil)
1038         (stream (gensym "STREAM")))
1039     (flet ((sref (slot-name)
1040              `(,(symbolicate conc-name slot-name) structure)))
1041       (dolist (slot-desc slot-descs)
1042         (if first?
1043             (setf maybe-print-space nil
1044                   first? nil)
1045             (setf maybe-print-space `(defprinter-print-space ,stream)))
1046         (cond ((atom slot-desc)
1047                (push maybe-print-space reversed-prints)
1048                (push `(defprinter-prin1 ',slot-desc ,(sref slot-desc) ,stream)
1049                      reversed-prints))
1050               (t
1051                (let ((sname (first slot-desc))
1052                      (test t))
1053                  (collect ((stuff))
1054                    (do ((option (rest slot-desc) (cddr option)))
1055                        ((null option)
1056                         (push `(let ((,sname ,(sref sname)))
1057                                  (when ,test
1058                                    ,maybe-print-space
1059                                    ,@(or (stuff)
1060                                          `((defprinter-prin1
1061                                              ',sname ,sname ,stream)))))
1062                               reversed-prints))
1063                      (case (first option)
1064                        (:prin1
1065                         (stuff `(defprinter-prin1
1066                                   ',sname ,(second option) ,stream)))
1067                        (:princ
1068                         (stuff `(defprinter-princ
1069                                   ',sname ,(second option) ,stream)))
1070                        (:test (setq test (second option)))
1071                        (t
1072                         (error "bad option: ~S" (first option)))))))))))
1073     `(def!method print-object ((structure ,name) ,stream)
1074        (pprint-logical-block (,stream nil)
1075          (print-unreadable-object (structure
1076                                    ,stream
1077                                    :type t
1078                                    :identity ,identity)
1079            ,@(nreverse reversed-prints))))))
1080 \f
1081 ;;;; etc.
1082
1083 ;;; Given a pathname, return a corresponding physical pathname.
1084 (defun physicalize-pathname (possibly-logical-pathname)
1085   (if (typep possibly-logical-pathname 'logical-pathname)
1086       (translate-logical-pathname possibly-logical-pathname)
1087       possibly-logical-pathname))
1088
1089 (defun deprecation-warning (bad-name &optional good-name)
1090   (warn "using deprecated ~S~@[, should use ~S instead~]"
1091         bad-name
1092         good-name))
1093
1094 ;;; Anaphoric macros
1095 (defmacro awhen (test &body body)
1096   `(let ((it ,test))
1097      (when it ,@body)))
1098
1099 (defmacro acond (&rest clauses)
1100   (if (null clauses)
1101       `()
1102       (destructuring-bind ((test &body body) &rest rest) clauses
1103         (once-only ((test test))
1104           `(if ,test
1105                (let ((it ,test)) (declare (ignorable it)),@body)
1106                (acond ,@rest))))))
1107
1108 ;;; (binding* ({(names initial-value [flag])}*) body)
1109 ;;; FLAG may be NIL or :EXIT-IF-NULL
1110 ;;;
1111 ;;; This form unites LET*, MULTIPLE-VALUE-BIND and AWHEN.
1112 (defmacro binding* ((&rest bindings) &body body)
1113   (let ((bindings (reverse bindings)))
1114     (loop with form = `(progn ,@body)
1115           for binding in bindings
1116           do (destructuring-bind (names initial-value &optional flag)
1117                  binding
1118                (multiple-value-bind (names declarations)
1119                    (etypecase names
1120                      (null
1121                       (let ((name (gensym)))
1122                         (values (list name) `((declare (ignorable ,name))))))
1123                      (symbol
1124                       (values (list names) nil))
1125                      (list
1126                       (collect ((new-names) (ignorable))
1127                         (dolist (name names)
1128                           (when (eq name nil)
1129                             (setq name (gensym))
1130                             (ignorable name))
1131                           (new-names name))
1132                         (values (new-names)
1133                                 (when (ignorable)
1134                                   `((declare (ignorable ,@(ignorable)))))))))
1135                  (setq form `(multiple-value-bind ,names
1136                                  ,initial-value
1137                                ,@declarations
1138                                ,(ecase flag
1139                                        ((nil) form)
1140                                        ((:exit-if-null)
1141                                         `(when ,(first names) ,form)))))))
1142           finally (return form))))
1143 \f
1144 ;;; Delayed evaluation
1145 (defmacro delay (form)
1146   `(cons nil (lambda () ,form)))
1147
1148 (defun force (promise)
1149   (cond ((not (consp promise)) promise)
1150         ((car promise) (cdr promise))
1151         (t (setf (car promise) t
1152                  (cdr promise) (funcall (cdr promise))))))
1153
1154 (defun promise-ready-p (promise)
1155   (or (not (consp promise))
1156       (car promise)))
1157 \f
1158 ;;; toplevel helper
1159 (defmacro with-rebound-io-syntax (&body body)
1160   `(%with-rebound-io-syntax (lambda () ,@body)))
1161
1162 (defun %with-rebound-io-syntax (function)
1163   (declare (type function function))
1164   (let ((*package* *package*)
1165         (*print-array* *print-array*)
1166         (*print-base* *print-base*)
1167         (*print-case* *print-case*)
1168         (*print-circle* *print-circle*)
1169         (*print-escape* *print-escape*)
1170         (*print-gensym* *print-gensym*)
1171         (*print-length* *print-length*)
1172         (*print-level* *print-level*)
1173         (*print-lines* *print-lines*)
1174         (*print-miser-width* *print-miser-width*)
1175         (*print-pretty* *print-pretty*)
1176         (*print-radix* *print-radix*)
1177         (*print-readably* *print-readably*)
1178         (*print-right-margin* *print-right-margin*)
1179         (*read-base* *read-base*)
1180         (*read-default-float-format* *read-default-float-format*)
1181         (*read-eval* *read-eval*)
1182         (*read-suppress* *read-suppress*)
1183         (*readtable* *readtable*))
1184     (funcall function)))
1185
1186 ;;; Bind a few "potentially dangerous" printer control variables to
1187 ;;; safe values, respecting current values if possible.
1188 (defmacro with-sane-io-syntax (&body forms)
1189   `(call-with-sane-io-syntax (lambda () ,@forms)))
1190
1191 (defun call-with-sane-io-syntax (function)
1192   (declare (type function function))
1193   (macrolet ((true (sym)
1194                `(and (boundp ',sym) ,sym)))
1195     (let ((*print-readably* nil)
1196           (*print-level* (or (true *print-level*) 6))
1197           (*print-length* (or (true *print-length*) 12)))
1198       (funcall function))))
1199
1200 ;;; Default evaluator mode (interpeter / compiler)
1201
1202 (declaim (type (member :compile #!+sb-eval :interpret) *evaluator-mode*))
1203 (defparameter *evaluator-mode* :compile
1204   #!+sb-doc
1205   "Toggle between different evaluator implementations. If set to :COMPILE,
1206 an implementation of EVAL that calls the compiler will be used. If set
1207 to :INTERPRET, an interpreter will be used.")
1208
1209 ;;; Helper for making the DX closure allocation in macros expanding
1210 ;;; to CALL-WITH-FOO less ugly.
1211 ;;;
1212 ;;; This expands to something like
1213 ;;;
1214 ;;;  (flet ((foo (...) <body-of-foo>))
1215 ;;;     (declare (optimize stack-allocate-dynamic-extent))
1216 ;;;     (flet ((foo (...)
1217 ;;;              (foo ...))
1218 ;;;        (declare (dynamic-extent #'foo))
1219 ;;;        <body-of-dx-flet>)))
1220 ;;;
1221 ;;; The outer FLETs are inlined into the inner ones, and the inner ones
1222 ;;; are DX-allocated. The double-fletting is done to keep the bodies of
1223 ;;; the functions in an environment with correct policy: we don't want
1224 ;;; to force DX allocation in their bodies, which would be bad eg.
1225 ;;; in safe code.
1226 (defmacro dx-flet (functions &body forms)
1227   (let ((names (mapcar #'car functions)))
1228     `(flet ,functions
1229        #-sb-xc-host
1230        (declare (optimize sb!c::stack-allocate-dynamic-extent))
1231        (flet ,(mapcar
1232                (lambda (f)
1233                  (let ((args (cadr f))
1234                        (name (car f)))
1235                    (when (intersection args lambda-list-keywords)
1236                      ;; No fundamental reason not to support them, but we
1237                      ;; don't currently need them here.
1238                      (error "Non-required arguments not implemented for DX-FLET."))
1239                    `(,name ,args
1240                       (,name ,@args))))
1241                functions)
1242          (declare (dynamic-extent ,@(mapcar (lambda (x) `(function ,x)) names)))
1243          ,@forms))))
1244
1245 ;;; Another similar one -- but actually touches the policy of the body,
1246 ;;; so take care with this one...
1247 (defmacro dx-let (bindings &body forms)
1248   `(locally
1249        #-sb-xc-host
1250        (declare (optimize sb!c::stack-allocate-dynamic-extent))
1251      (let ,bindings
1252        (declare (dynamic-extent ,@(mapcar (lambda (bind)
1253                                             (if (consp bind)
1254                                                 (car bind)
1255                                                 bind))
1256                                           bindings)))
1257        ,@forms)))
1258