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