1 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; This software is derived from the CMU CL system, which was
5 ;;;; written at Carnegie Mellon University and released into the
6 ;;;; public domain. The software is in the public domain and is
7 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
8 ;;;; files for more information.
10 (in-package "SB!KERNEL")
12 (!begin-collecting-cold-init-forms)
14 ;;;; representations of types
16 ;;; A HAIRY-TYPE represents anything too weird to be described
17 ;;; reasonably or to be useful, such as NOT, SATISFIES, unknown types,
18 ;;; and unreasonably complicated types involving AND. We just remember
19 ;;; the original type spec.
20 (defstruct (hairy-type (:include ctype
21 (class-info (type-class-or-lose 'hairy))
23 (might-contain-other-types-p t))
26 ;; the Common Lisp type-specifier of the type we represent
27 (specifier nil :type t))
29 (!define-type-class hairy)
31 ;;; An UNKNOWN-TYPE is a type not known to the type system (not yet
32 ;;; defined). We make this distinction since we don't want to complain
33 ;;; about types that are hairy but defined.
34 (defstruct (unknown-type (:include hairy-type)
37 (defstruct (negation-type (:include ctype
38 (class-info (type-class-or-lose 'negation))
39 ;; FIXME: is this right? It's
40 ;; what they had before, anyway
42 (might-contain-other-types-p t))
45 (type (missing-arg) :type ctype))
47 (!define-type-class negation)
49 ;;; ARGS-TYPE objects are used both to represent VALUES types and
50 ;;; to represent FUNCTION types.
51 (defstruct (args-type (:include ctype)
54 ;; Lists of the type for each required and optional argument.
55 (required nil :type list)
56 (optional nil :type list)
57 ;; The type for the rest arg. NIL if there is no &REST arg.
58 (rest nil :type (or ctype null))
59 ;; true if &KEY arguments are specified
60 (keyp nil :type boolean)
61 ;; list of KEY-INFO structures describing the &KEY arguments
62 (keywords nil :type list)
63 ;; true if other &KEY arguments are allowed
64 (allowp nil :type boolean))
66 (defun canonicalize-args-type-args (required optional rest)
67 (when (eq rest *empty-type*)
70 (loop with last-not-rest = nil
73 do (cond ((eq opt *empty-type*)
74 (return (values required (subseq optional i) rest)))
76 (setq last-not-rest i)))
77 finally (return (values required
79 (subseq optional 0 (1+ last-not-rest))
83 (defun args-types (lambda-list-like-thing)
85 (required optional restp rest keyp keys allowp auxp aux
86 morep more-context more-count llk-p)
87 (parse-lambda-list-like-thing lambda-list-like-thing)
88 (declare (ignore aux morep more-context more-count))
90 (error "&AUX in a FUNCTION or VALUES type: ~S." lambda-list-like-thing))
91 (let ((required (mapcar #'single-value-specifier-type required))
92 (optional (mapcar #'single-value-specifier-type optional))
93 (rest (when restp (single-value-specifier-type rest)))
97 (unless (proper-list-of-length-p key 2)
98 (error "Keyword type description is not a two-list: ~S." key))
99 (let ((kwd (first key)))
100 (when (find kwd (key-info) :key #'key-info-name)
101 (error "~@<repeated keyword ~S in lambda list: ~2I~_~S~:>"
102 kwd lambda-list-like-thing))
106 :type (single-value-specifier-type (second key))))))
108 (multiple-value-bind (required optional rest)
109 (canonicalize-args-type-args required optional rest)
110 (values required optional rest keyp keywords allowp llk-p)))))
112 (defstruct (values-type
114 (class-info (type-class-or-lose 'values)))
115 (:constructor %make-values-type)
118 (defun-cached (make-values-type-cached
120 :hash-function (lambda (req opt rest allowp)
122 (type-list-cache-hash req)
123 (type-list-cache-hash opt)
125 (type-hash-value rest)
129 ((required equal-but-no-car-recursion)
130 (optional equal-but-no-car-recursion)
133 (%make-values-type :required required
138 (defun make-values-type (&key (args nil argsp)
139 required optional rest allowp)
143 (multiple-value-bind (required optional rest keyp keywords allowp
146 (declare (ignore keywords))
148 (error "&KEY appeared in a VALUES type specifier ~S."
151 (make-values-type :required required
155 (make-short-values-type required))))
156 (multiple-value-bind (required optional rest)
157 (canonicalize-args-type-args required optional rest)
158 (cond ((and (null required)
160 (eq rest *universal-type*))
162 ((memq *empty-type* required)
164 (t (make-values-type-cached required optional
167 (!define-type-class values)
169 ;;; (SPECIFIER-TYPE 'FUNCTION) and its subtypes
170 (defstruct (fun-type (:include args-type
171 (class-info (type-class-or-lose 'function)))
173 %make-fun-type (&key required optional rest
177 &aux (rest (if (eq rest *empty-type*)
180 ;; true if the arguments are unrestrictive, i.e. *
181 (wild-args nil :type boolean)
182 ;; type describing the return values. This is a values type
183 ;; when multiple values were specified for the return.
184 (returns (missing-arg) :type ctype))
185 (defun make-fun-type (&rest initargs
186 &key (args nil argsp) returns &allow-other-keys)
189 (if (eq returns *wild-type*)
190 (specifier-type 'function)
191 (%make-fun-type :wild-args t :returns returns))
192 (multiple-value-bind (required optional rest keyp keywords allowp)
194 (if (and (null required)
196 (eq rest *universal-type*)
198 (if (eq returns *wild-type*)
199 (specifier-type 'function)
200 (%make-fun-type :wild-args t :returns returns))
201 (%make-fun-type :required required
208 ;; FIXME: are we really sure that we won't make something that
209 ;; looks like a completely wild function here?
210 (apply #'%make-fun-type initargs)))
212 ;;; The CONSTANT-TYPE structure represents a use of the CONSTANT-ARG
213 ;;; "type specifier", which is only meaningful in function argument
214 ;;; type specifiers used within the compiler. (It represents something
215 ;;; that the compiler knows to be a constant.)
216 (defstruct (constant-type
218 (class-info (type-class-or-lose 'constant)))
220 ;; The type which the argument must be a constant instance of for this type
222 (type (missing-arg) :type ctype))
224 ;;; The NAMED-TYPE is used to represent *, T and NIL, the standard
225 ;;; special cases, as well as other special cases needed to
226 ;;; interpolate between regions of the type hierarchy, such as
227 ;;; INSTANCE (which corresponds to all those classes with slots which
228 ;;; are not funcallable), FUNCALLABLE-INSTANCE (those classes with
229 ;;; slots which are funcallable) and EXTENDED-SEQUUENCE (non-LIST
230 ;;; non-VECTOR classes which are also sequences). These special cases
231 ;;; are the ones that aren't really discussed by Baker in his
232 ;;; "Decision Procedure for SUBTYPEP" paper.
233 (defstruct (named-type (:include ctype
234 (class-info (type-class-or-lose 'named)))
236 (name nil :type symbol))
238 ;;; a list of all the float "formats" (i.e. internal representations;
239 ;;; nothing to do with #'FORMAT), in order of decreasing precision
240 (eval-when (:compile-toplevel :load-toplevel :execute)
241 (defparameter *float-formats*
242 '(long-float double-float single-float short-float)))
244 ;;; The type of a float format.
245 (deftype float-format () `(member ,@*float-formats*))
247 ;;; A NUMERIC-TYPE represents any numeric type, including things
249 (defstruct (numeric-type (:include ctype
250 (class-info (type-class-or-lose 'number)))
251 (:constructor %make-numeric-type)
253 ;; the kind of numeric type we have, or NIL if not specified (just
254 ;; NUMBER or COMPLEX)
256 ;; KLUDGE: A slot named CLASS for a non-CLASS value is bad.
257 ;; Especially when a CLASS value *is* stored in another slot (called
258 ;; CLASS-INFO:-). Perhaps this should be called CLASS-NAME? Also
259 ;; weird that comment above says "Numeric-Type is used to represent
260 ;; all numeric types" but this slot doesn't allow COMPLEX as an
261 ;; option.. how does this fall into "not specified" NIL case above?
262 ;; Perhaps someday we can switch to CLOS and make NUMERIC-TYPE
263 ;; be an abstract base class and INTEGER-TYPE, RATIONAL-TYPE, and
264 ;; whatnot be concrete subclasses..
265 (class nil :type (member integer rational float nil) :read-only t)
266 ;; "format" for a float type (i.e. type specifier for a CPU
267 ;; representation of floating point, e.g. 'SINGLE-FLOAT -- nothing
268 ;; to do with #'FORMAT), or NIL if not specified or not a float.
269 ;; Formats which don't exist in a given implementation don't appear
271 (format nil :type (or float-format null) :read-only t)
272 ;; Is this a complex numeric type? Null if unknown (only in NUMBER).
274 ;; FIXME: I'm bewildered by FOO-P names for things not intended to
275 ;; interpreted as truth values. Perhaps rename this COMPLEXNESS?
276 (complexp :real :type (member :real :complex nil) :read-only t)
277 ;; The upper and lower bounds on the value, or NIL if there is no
278 ;; bound. If a list of a number, the bound is exclusive. Integer
279 ;; types never have exclusive bounds, i.e. they may have them on
280 ;; input, but they're canonicalized to inclusive bounds before we
282 (low nil :type (or number cons null) :read-only t)
283 (high nil :type (or number cons null) :read-only t))
285 ;;; Impose canonicalization rules for NUMERIC-TYPE. Note that in some
286 ;;; cases, despite the name, we return *EMPTY-TYPE* instead of a
288 (defun make-numeric-type (&key class format (complexp :real) low high
290 ;; if interval is empty
293 (if (or (consp low) (consp high)) ; if either bound is exclusive
294 (>= (type-bound-number low) (type-bound-number high))
297 (multiple-value-bind (canonical-low canonical-high)
300 ;; INTEGER types always have their LOW and HIGH bounds
301 ;; represented as inclusive, not exclusive values.
302 (values (if (consp low)
303 (1+ (type-bound-number low))
306 (1- (type-bound-number high))
309 ;; no canonicalization necessary
311 (when (and (eq class 'rational)
312 (integerp canonical-low)
313 (integerp canonical-high)
314 (= canonical-low canonical-high))
315 (setf class 'integer))
316 (%make-numeric-type :class class
321 :enumerable enumerable))))
323 (defun modified-numeric-type (base
325 (class (numeric-type-class base))
326 (format (numeric-type-format base))
327 (complexp (numeric-type-complexp base))
328 (low (numeric-type-low base))
329 (high (numeric-type-high base))
330 (enumerable (numeric-type-enumerable base)))
331 (make-numeric-type :class class
336 :enumerable enumerable))
338 (defstruct (character-set-type
340 (class-info (type-class-or-lose 'character-set)))
341 (:constructor %make-character-set-type)
343 (pairs (missing-arg) :type list :read-only t))
344 (defun make-character-set-type (&key pairs)
345 ; (aver (equal (mapcar #'car pairs)
346 ; (sort (mapcar #'car pairs) #'<)))
347 ;; aver that the cars of the list elements are sorted into increasing order
348 (aver (or (null pairs)
349 (do ((p pairs (cdr p)))
351 (when (> (caar p) (caadr p)) (return nil)))))
352 (let ((pairs (let (result)
353 (do ((pairs pairs (cdr pairs)))
354 ((null pairs) (nreverse result))
355 (destructuring-bind (low . high) (car pairs)
356 (loop for (low1 . high1) in (cdr pairs)
357 if (<= low1 (1+ high))
358 do (progn (setf high (max high high1))
359 (setf pairs (cdr pairs)))
360 else do (return nil))
362 ((>= low sb!xc:char-code-limit))
364 (t (push (cons (max 0 low)
365 (min high (1- sb!xc:char-code-limit)))
369 (%make-character-set-type :pairs pairs))))
371 ;;; An ARRAY-TYPE is used to represent any array type, including
372 ;;; things such as SIMPLE-BASE-STRING.
373 (defstruct (array-type (:include ctype
374 (class-info (type-class-or-lose 'array)))
375 (:constructor %make-array-type)
377 ;; the dimensions of the array, or * if unspecified. If a dimension
378 ;; is unspecified, it is *.
379 (dimensions '* :type (or list (member *)))
380 ;; Is this not a simple array type? (:MAYBE means that we don't know.)
381 (complexp :maybe :type (member t nil :maybe))
382 ;; the element type as originally specified
383 (element-type (missing-arg) :type ctype)
384 ;; the element type as it is specialized in this implementation
385 (specialized-element-type *wild-type* :type ctype))
386 (define-cached-synonym make-array-type)
388 ;;; A MEMBER-TYPE represent a use of the MEMBER type specifier. We
389 ;;; bother with this at this level because MEMBER types are fairly
390 ;;; important and union and intersection are well defined.
391 (defstruct (member-type (:include ctype
392 (class-info (type-class-or-lose 'member))
395 (:constructor %make-member-type (members))
396 #-sb-xc-host (:pure nil))
397 ;; the things in the set, with no duplications
398 (members nil :type list))
399 (defun make-member-type (&key members)
400 (declare (type list members))
401 ;; make sure that we've removed duplicates
402 (aver (= (length members) (length (remove-duplicates members))))
403 ;; if we have a pair of zeros (e.g. 0.0d0 and -0.0d0), then we can
404 ;; canonicalize to (DOUBLE-FLOAT 0.0d0 0.0d0), because numeric
405 ;; ranges are compared by arithmetic operators (while MEMBERship is
406 ;; compared by EQL). -- CSR, 2003-04-23
407 (let ((singlep (subsetp `(,(load-time-value (make-unportable-float :single-float-negative-zero)) 0.0f0) members))
408 (doublep (subsetp `(,(load-time-value (make-unportable-float :double-float-negative-zero)) 0.0d0) members))
410 (longp (subsetp `(,(load-time-value (make-unportable-float :long-float-negative-zero)) 0.0l0) members)))
411 (if (or singlep doublep #!+long-float longp)
414 (push (ctype-of 0.0f0) union-types)
415 (setf members (set-difference members `(,(load-time-value (make-unportable-float :single-float-negative-zero)) 0.0f0))))
417 (push (ctype-of 0.0d0) union-types)
418 (setf members (set-difference members `(,(load-time-value (make-unportable-float :double-float-negative-zero)) 0.0d0))))
421 (push (ctype-of 0.0l0) union-types)
422 (setf members (set-difference members `(,(load-time-value (make-unportable-float :long-float-negative-zero)) 0.0l0))))
423 (aver (not (null union-types)))
427 (cons (%make-member-type members)
429 (%make-member-type members))))
431 ;;; A COMPOUND-TYPE is a type defined out of a set of types, the
432 ;;; common parent of UNION-TYPE and INTERSECTION-TYPE.
433 (defstruct (compound-type (:include ctype
434 (might-contain-other-types-p t))
437 (types nil :type list :read-only t))
439 ;;; A UNION-TYPE represents a use of the OR type specifier which we
440 ;;; couldn't canonicalize to something simpler. Canonical form:
441 ;;; 1. All possible pairwise simplifications (using the UNION2 type
442 ;;; methods) have been performed. Thus e.g. there is never more
443 ;;; than one MEMBER-TYPE component. FIXME: As of sbcl-0.6.11.13,
444 ;;; this hadn't been fully implemented yet.
445 ;;; 2. There are never any UNION-TYPE components.
446 (defstruct (union-type (:include compound-type
447 (class-info (type-class-or-lose 'union)))
448 (:constructor %make-union-type (enumerable types))
450 (define-cached-synonym make-union-type)
452 ;;; An INTERSECTION-TYPE represents a use of the AND type specifier
453 ;;; which we couldn't canonicalize to something simpler. Canonical form:
454 ;;; 1. All possible pairwise simplifications (using the INTERSECTION2
455 ;;; type methods) have been performed. Thus e.g. there is never more
456 ;;; than one MEMBER-TYPE component.
457 ;;; 2. There are never any INTERSECTION-TYPE components: we've
458 ;;; flattened everything into a single INTERSECTION-TYPE object.
459 ;;; 3. There are never any UNION-TYPE components. Either we should
460 ;;; use the distributive rule to rearrange things so that
461 ;;; unions contain intersections and not vice versa, or we
462 ;;; should just punt to using a HAIRY-TYPE.
463 (defstruct (intersection-type (:include compound-type
464 (class-info (type-class-or-lose
466 (:constructor %make-intersection-type
470 ;;; Return TYPE converted to canonical form for a situation where the
471 ;;; "type" '* (which SBCL still represents as a type even though ANSI
472 ;;; CL defines it as a related but different kind of placeholder) is
473 ;;; equivalent to type T.
474 (defun type-*-to-t (type)
475 (if (type= type *wild-type*)
479 ;;; A CONS-TYPE is used to represent a CONS type.
480 (defstruct (cons-type (:include ctype (class-info (type-class-or-lose 'cons)))
482 %make-cons-type (car-type
485 ;; the CAR and CDR element types (to support ANSI (CONS FOO BAR) types)
487 ;; FIXME: Most or all other type structure slots could also be :READ-ONLY.
488 (car-type (missing-arg) :type ctype :read-only t)
489 (cdr-type (missing-arg) :type ctype :read-only t))
490 (defun make-cons-type (car-type cdr-type)
491 (aver (not (or (eq car-type *wild-type*)
492 (eq cdr-type *wild-type*))))
493 (if (or (eq car-type *empty-type*)
494 (eq cdr-type *empty-type*))
496 (%make-cons-type car-type cdr-type)))
498 (defun cons-type-length-info (type)
499 (declare (type cons-type type))
500 (do ((min 1 (1+ min))
501 (cdr (cons-type-cdr-type type) (cons-type-cdr-type cdr)))
502 ((not (cons-type-p cdr))
504 ((csubtypep cdr (specifier-type 'null))
506 ((csubtypep *universal-type* cdr)
508 ((type/= (type-intersection (specifier-type 'cons) cdr) *empty-type*)
510 ((type/= (type-intersection (specifier-type 'null) cdr) *empty-type*)
512 (t (values min :maybe))))
518 ;;; Return the type structure corresponding to a type specifier. We
519 ;;; pick off structure types as a special case.
521 ;;; Note: VALUES-SPECIFIER-TYPE-CACHE-CLEAR must be called whenever a
522 ;;; type is defined (or redefined).
523 (defun-cached (values-specifier-type
524 :hash-function (lambda (x)
525 (logand (sxhash x) #x3FF))
527 :init-wrapper !cold-init-forms)
528 ((orig equal-but-no-car-recursion))
529 (let ((u (uncross orig)))
530 (or (info :type :builtin u)
531 (let ((spec (type-expand u)))
533 ((and (not (eq spec u))
534 (info :type :builtin spec)))
535 ((eq (info :type :kind spec) :instance)
536 (find-classoid spec))
537 ((typep spec 'classoid)
538 (if (typep spec 'built-in-classoid)
539 (or (built-in-classoid-translation spec) spec)
542 (when (and (atom spec)
543 (member spec '(and or not member eql satisfies values)))
544 (error "The symbol ~S is not valid as a type specifier." spec))
545 (let* ((lspec (if (atom spec) (list spec) spec))
546 (fun (info :type :translator (car lspec))))
549 ((or (and (consp spec) (symbolp (car spec))
550 (not (info :type :builtin (car spec))))
551 (and (symbolp spec) (not (info :type :builtin spec))))
552 (when (and *type-system-initialized*
553 (not (eq (info :type :kind spec)
554 :forthcoming-defclass-type)))
555 (signal 'parse-unknown-type :specifier spec))
556 ;; (The RETURN-FROM here inhibits caching.)
557 (return-from values-specifier-type
558 (make-unknown-type :specifier spec)))
560 (error "bad thing to be a type specifier: ~S"
563 ;;; This is like VALUES-SPECIFIER-TYPE, except that we guarantee to
564 ;;; never return a VALUES type.
565 (defun specifier-type (x)
566 (let ((res (values-specifier-type x)))
567 (when (or (values-type-p res)
568 ;; bootstrap magic :-(
569 (and (named-type-p res)
570 (eq (named-type-name res) '*)))
571 (error "VALUES type illegal in this context:~% ~S" x))
574 (defun single-value-specifier-type (x)
579 ;;; Similar to MACROEXPAND, but expands DEFTYPEs. We don't bother
580 ;;; returning a second value.
581 (defun type-expand (form)
582 (let ((def (cond ((symbolp form)
583 (info :type :expander form))
584 ((and (consp form) (symbolp (car form)))
585 (info :type :expander (car form)))
588 (type-expand (funcall def (if (consp form) form (list form))))
591 ;;; Note that the type NAME has been (re)defined, updating the
592 ;;; undefined warnings and VALUES-SPECIFIER-TYPE cache.
593 (defun %note-type-defined (name)
594 (declare (symbol name))
595 (note-name-defined name :type)
596 (when (boundp 'sb!kernel::*values-specifier-type-cache-vector*)
597 (values-specifier-type-cache-clear))
601 (!defun-from-collected-cold-init-forms !early-type-cold-init)