source: trunk/source/level-1/l1-typesys.lisp @ 15237

Last change on this file since 15237 was 15093, checked in by gb, 8 years ago

New Linux ARM binaries.

The image and FASL versions changed on the ARM, but (if I did it right)
not on other platforms.

(The image and FASL versions are now architecture-specific. This may
make it somewhat easier and less disruptive to change them, since the
motivation for such a change is often also architecture-specific.)
The FASL and current image version are defined (in the "TARGET" package)
in the architecture-specific *-arch.lisp files; the min, max, and current
image versions are defined in the *constants*.h file for the architecture.

Most of the changes are ARM-specific.

Each TCR now contains a 256-word table at byte offset 256. (We've
been using about 168 bytes in the TCR, so there are still 88 bytes/22
words left for expansion.) The table is initialized at TCR-creation
time to contain the absolute addresses of the subprims (there are
currently around 130 defined); we try otherwise not to reference
subprims by absolute address. Jumping to a subprim is:

(ldr pc (:@ rcontext (:$ offset-of-subprim-in-tcr-table)))

and calling one involves loading its address from that table into a
register and doing (blx reg). We canonically use LR as the register,
since it's going to be clobbered by the blx anyway and there doesn't
seem to be a performance hazard there. The old scheme (which involved
using BA and BLA pseudoinstructions to jump to/call a hidden jump table
at the end of the function) is no longer supported.

ARM Subprims no longer need to be aligned (on anything more than an
instruction boundary.) Some remnants of the consequences of an old
scheme (where subprims had to "fit" in small regions and sometimes
had to jump out of line if they would overflow that region's bounds)
still remain, but we can repair that (and it'll be a bit more straightforward
to add new ARM subprims.) We no longer care (much) about where subprims
are mapped in memory, and don't have to bias suprimitive addresses by
a platform-specific constant (and have to figure out whether or not we've
already done so) on (e.g.) Android.

Rather than setting the first element (fn.entrypoint) of a
newly-created function to the (absolute) address of a subprim that updates
that entrypoint on the first call, we use a little LAP function to correct
the address before the function can be called.

Non-function objects that can be stored in symbols' function cells
(the UNDEFINED-FUNCTION object, the things that encapsulate
special-operator names and global macro-functions) need to be
structured like FUNCTIONS: the need to have a word-aligned entrypoint
in element 0 that tracks the CODE-VECTOR object in element 1. We
don't want these things to be of type FUNCTION, but do want the GC to
adjust the entrypoint if the codevector moves. We've been essentially
out of GVECTOR subtags on 32-bit platforms, largely because of the
constraints that vector/array subtags must be greater than other
subtags and numeric types be less. The first constraint is probably
reasonable, but the second isn't: other typecodes (tag-list, etc) may
be less than the maximum numeric typecode, so tests like NUMBERP can't
reliably involve a simple comparison. (As long as a mask of all
numeric typecodes will fit in a machine word/FIXNUM, a simple LOGBITP
test can be used instead.) Removed all portable and ARM-specific code
that made assumptions about numeric typecode ordering, made a few more
gvector typecodes available, and used one of them to define a new
"pseudofunction" type. Made the GC update the entrypoints of
pseudofunctions and used them for the undefined-function object and
for the function cells of macros/special-operators.

Since we don't need the subprim jump table at the end of each function
anymore, we can more easily revive the idea of embedded pc-relative
constant data ("constant pools") and initialize FPRs from constant
data, avoiding most remaining traffic between FPRs and GPRs.

I've had a fairly-reproducible cache-coherency problem: on the first
GC in the cold load, the thread misbehaves mysteriously when it
resumes. The GC tries to synchronize the I and D caches on the entire
range of addresses that may contain newly-moved code-vectors. I'm not
at all sure why, but walking that range and flushing the cache for
each code-vector individually seems to avoid the problem (and may actually
be faster.)

Fix ticket:894

Fixed a few typos in error messages/comments/etc.

I -think- that the non-ARM-specific changes (how FASL/image versions are
defined) should bootstrap cleanly, but won't know for sure until this is
committed. (I imagine that the buildbot will complain if not.)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 153.5 KB
Line 
1;;;-*- Mode: Lisp; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2009 Clozure Associates
4;;;   Copyright (C) 1994-2001 Digitool, Inc
5;;;   This file is part of Clozure CL. 
6;;;
7;;;   Clozure CL is licensed under the terms of the Lisp Lesser GNU Public
8;;;   License , known as the LLGPL and distributed with Clozure CL as the
9;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
10;;;   which is distributed with Clozure CL as the file "LGPL".  Where these
11;;;   conflict, the preamble takes precedence. 
12;;;
13;;;   Clozure CL is referenced in the preamble as the "LIBRARY."
14;;;
15;;;   The LLGPL is also available online at
16;;;   http://opensource.franz.com/preamble.html
17
18;; This is a hacked-up version of the CMU CL type system.
19
20(in-package "CCL")
21
22
23
24;;; This condition is signalled whenever we make a UNKNOWN-TYPE so that
25;;; compiler warnings can be emitted as appropriate.
26;;;
27(define-condition parse-unknown-type (condition)
28  ((specifier :reader parse-unknown-type-specifier :initarg :specifier))
29  (:report (lambda (c s) (print-unreadable-object (c s :type t)
30                           (format s "unknown type ~A" (parse-unknown-type-specifier c))))))
31
32(defun parse-lambda-list (list)
33  (let* ((required)
34         (optional)
35         (keys)
36         (aux))
37    (let ((restp nil)
38          (rest nil)
39          (keyp nil)
40          (allowp nil)
41          (state :required))
42      (dolist (arg list)
43        (if (and (symbolp arg)
44                 (let ((name (symbol-name arg)))
45                   (and (/= (length name) 0)
46                        (char= (char name 0) #\&))))
47          (case arg
48            (&optional
49             (unless (eq state :required)
50               (error "Misplaced &optional in lambda-list: ~S." list))
51             (setq state '&optional))
52            (&rest
53             (unless (member state '(:required &optional))
54               (error "Misplaced &rest in lambda-list: ~S." list))
55             (setq state '&rest))
56            (&key
57             (unless (member state '(:required &optional :post-rest
58                                     ))
59               (error "Misplaced &key in lambda-list: ~S." list))
60             (setq keyp t)
61             (setq state '&key))
62            (&allow-other-keys
63             (unless (eq state '&key)
64               (error "Misplaced &allow-other-keys in lambda-list: ~S." list))
65             (setq allowp t  state '&allow-other-keys))
66            (&aux
67             (when (member state '(&rest))
68               (error "Misplaced &aux in lambda-list: ~S." list))
69             (setq state '&aux))
70            (t
71             (error "Unknown &keyword in lambda-list: ~S." arg)))
72          (case state
73            (:required (push arg required))
74            (&optional (push arg optional))
75            (&rest
76             (setq restp t  rest arg  state :post-rest))
77            (&key (push arg keys))
78            (&aux (push arg aux))
79            (t
80             (error "Found garbage in lambda-list when expecting a keyword: ~S." arg)))))
81     
82      (values (nreverse required) (nreverse optional) restp rest keyp (nreverse keys) allowp (nreverse aux)))))
83
84(defvar %deftype-expanders% (make-hash-table :test #'eq))
85(defvar *type-translators* (make-hash-table :test #'eq))
86(defvar *builtin-type-info* (make-hash-table :test #'equal))
87(defvar %builtin-type-cells% (make-hash-table :test 'equal))
88
89(defvar *use-implementation-types* t)
90
91(defun info-type-builtin (name)
92  (gethash name *builtin-type-info*))
93
94(defun (setf info-type-builtin) (val name)
95  (setf (gethash name *builtin-type-info*) val))
96
97(defun info-type-translator (name)
98  (gethash name *type-translators*))
99
100
101
102
103;;; Allow bootstrapping: mostly, allow us to bootstrap the type system
104;;; by having DEFTYPE expanders defined on built-in classes (the user
105;;; shouldn't be allowed to do so, at least not easily.
106
107;(defvar *type-system-initialized* nil)
108
109(defun %deftype (name fn doc)
110  (clear-type-cache)
111  (cond ((null fn)
112         (remhash name %deftype-expanders%))
113        ((and *type-system-initialized*
114              (or (built-in-type-p name)
115                  (let ((c (find-class name nil)))
116                    (and c (eq (class-name c) name)))))
117         (error "Cannot redefine type ~S because ~:[it is the name of a class~;it is a built-in type~]" name (built-in-type-p name)))
118        ((memq name *nx-known-declarations*)
119         (check-declaration-redefinition name 'deftype))
120        (t (setf (gethash name %deftype-expanders%) fn)
121           (record-source-file name 'type)))
122  (set-documentation name 'type doc)   ; nil clears it.
123  name)
124
125(defun %define-type-translator (name fn doc)
126  (declare (ignore doc))
127  (setf (gethash name *type-translators*) fn)
128  name)
129
130;;;(defun %deftype-expander (name)
131;;;  (or (gethash name %deftype-expanders%)
132;;;      (and *compiling-file* (%cdr (assq name *compile-time-deftype-expanders*)))))
133(defun %deftype-expander (name)
134  (gethash name %deftype-expanders%))
135
136(defun process-deftype-arglist (arglist &aux (in-optional? nil))
137  "Returns a NEW list similar to arglist except
138    inserts * as the default default for &optional args."
139  (mapcar #'(lambda (item)
140              (cond ((eq item '&optional) (setq in-optional? t) item)
141                    ((memq item lambda-list-keywords) (setq in-optional? nil) item)
142                    ((and in-optional? (symbolp item)) (list item ''*))
143                    (t item)))
144          arglist))
145
146
147(defun expand-type-macro (definer name arglist body env)
148  (setq name (require-type name 'symbol))
149  (multiple-value-bind (lambda doc)
150      (parse-macro-internal name arglist body env '*)
151    `(progn
152       (eval-when (:compile-toplevel)
153         (note-type-info ',name 'macro ,env))
154       (eval-when (:compile-toplevel :load-toplevel :execute)
155         (,definer ',name
156             (nfunction ,name ,lambda)
157           ,doc)))))
158
159(defmacro deftype (name arglist &body body &environment env)
160  "Define a new type, with syntax like DEFMACRO."
161  (expand-type-macro '%deftype name arglist body env))
162
163(defmacro def-type-translator (name arglist &body body &environment env)
164  (expand-type-macro '%define-type-translator name arglist body env))
165
166
167(defun type-expand (form &optional env &aux def)
168  (while (setq def (cond ((symbolp form)
169                          (gethash form %deftype-expanders%))
170                         ((and (consp form) (symbolp (%car form)))
171                          (gethash (%car form) %deftype-expanders%))
172                         (t nil)))
173    (setq form (funcall def (if (consp form) form (list form)) env)))
174  form)
175
176(defmethod print-object ((tc type-class) stream)
177  (print-unreadable-object (tc stream :type t :identity t)
178    (format stream "~s" (type-class-name tc))))
179
180(defmethod print-object ((c ctype) stream)
181  (print-unreadable-object (c stream :type t)
182    (format stream "~S" (type-specifier c))))
183
184(defmethod make-load-form ((c ctype) &optional env)
185  (declare (ignore env))
186  `(specifier-type ',(type-specifier c)))
187
188(defmethod make-load-form ((cell type-cell) &optional env)
189  (declare (ignore env))
190  `(register-type-cell `,(type-cell-type-specifier cell)))
191
192(defmethod print-object ((cell type-cell) stream)
193  (print-unreadable-object (cell stream :type t :identity t)
194    (format stream "for ~s" (type-cell-type-specifier cell))))
195
196(defun make-key-info (&key name type)
197  (%istruct 'key-info name type))
198
199(defun type-class-or-lose (name)
200  (or (cdr (assq name *type-classes*))
201      (error "~S is not a defined type class." name)))
202
203(eval-when (:compile-toplevel :execute)
204
205(defconstant type-class-function-slots
206  '((:simple-subtypep . #.type-class-simple-subtypep)
207    (:complex-subtypep-arg1 . #.type-class-complex-subtypep-arg1)
208    (:complex-subtypep-arg2 . #.type-class-complex-subtypep-arg2)
209    (:simple-union . #.type-class-simple-union)
210    (:complex-union . #.type-class-complex-union)
211    (:simple-intersection . #.type-class-simple-intersection)
212    (:complex-intersection . #.type-class-complex-intersection)
213    (:simple-= . #.type-class-simple-=)
214    (:complex-= . #.type-class-complex-=)
215    (:unparse . #.type-class-unparse)))
216
217)
218
219(defun class-typep (form class)
220  (memq class (%inited-class-cpl (class-of form))))
221
222;;; CLASS-FUNCTION-SLOT-OR-LOSE  --  Interface
223;;;
224(defun class-function-slot-or-lose (name)
225  (or (cdr (assoc name type-class-function-slots))
226      (error "~S is not a defined type class method." name)))
227
228
229(eval-when (:compile-toplevel :execute)
230
231;;; INVOKE-TYPE-METHOD  --  Interface
232;;;
233;;;    Invoke a type method on TYPE1 and TYPE2.  If the two types have the same
234;;; class, invoke the simple method.  Otherwise, invoke any complex method.  If
235;;; there isn't a distinct complex-arg1 method, then swap the arguments when
236;;; calling type1's method.  If no applicable method, return DEFAULT.
237;;;
238
239(defmacro invoke-type-method (simple complex-arg2 type1 type2 &key
240                                     (default '(values nil t))
241                                     complex-arg1)
242  (let ((simple (class-function-slot-or-lose simple))
243        (cslot1 (class-function-slot-or-lose (or complex-arg1 complex-arg2)))
244        (cslot2 (class-function-slot-or-lose complex-arg2)))
245    (once-only ((n-type1 type1)
246                (n-type2 type2))
247      (once-only ((class1 `(ctype-class-info ,n-type1))
248                  (class2 `(ctype-class-info ,n-type2)))
249        `(if (eq ,class1 ,class2)
250           (funcall (%svref ,class1 ,simple) ,n-type1 ,n-type2)
251           ,(once-only ((complex1 `(%svref ,class1 ,cslot1))
252                        (complex2 `(%svref ,class2 ,cslot2)))
253              `(cond (,complex2 (funcall ,complex2 ,n-type1 ,n-type2))
254                     (,complex1
255                      ,(if complex-arg1
256                         `(funcall ,complex1 ,n-type1 ,n-type2)
257                         `(funcall ,complex1 ,n-type2 ,n-type1)))
258                     (t ,default))))))))
259
260
261;;;; Utilities:
262
263;;; ANY-TYPE-OP, EVERY-TYPE-OP  --  Interface
264;;;
265;;;    Like ANY and EVERY, except that we handle two-arg uncertain predicates.
266;;; If the result is uncertain, then we return Default from the block PUNT.
267;;; If LIST-FIRST is true, then the list element is the first arg, otherwise
268;;; the second.
269;;;
270(defmacro any-type-op (op thing list &key (default '(values nil nil))
271                                list-first)
272  (let ((n-this (gensym))
273          (n-thing (gensym))
274          (n-val (gensym))
275          (n-win (gensym))
276          (n-uncertain (gensym)))
277    `(let ((,n-thing ,thing)
278             (,n-uncertain nil))
279       (dolist (,n-this ,list
280                              (if ,n-uncertain
281                                (return-from PUNT ,default)
282                                nil))
283           (multiple-value-bind (,n-val ,n-win)
284                                    ,(if list-first
285                                         `(,op ,n-this ,n-thing)
286                                         `(,op ,n-thing ,n-this))
287             (unless ,n-win (setq ,n-uncertain t))
288             (when ,n-val (return t)))))))
289;;;
290(defmacro every-type-op (op thing list &key (default '(values nil nil))
291                                  list-first)
292  (let ((n-this (gensym))
293          (n-thing (gensym))
294          (n-val (gensym))
295          (n-win (gensym)))
296    `(let ((,n-thing ,thing))
297       (dolist (,n-this ,list t)
298           (multiple-value-bind (,n-val ,n-win)
299                                    ,(if list-first
300                                         `(,op ,n-this ,n-thing)
301                                         `(,op ,n-thing ,n-this))
302             (unless ,n-win (return-from PUNT ,default))
303             (unless ,n-val (return nil)))))))
304
305)
306
307 
308;;; VANILLA-INTERSECTION  --  Interface
309;;;
310;;;    Compute the intersection for types that intersect only when one is a
311;;; hierarchical subtype of the other.
312;;;
313(defun vanilla-intersection (type1 type2)
314  (multiple-value-bind (stp1 win1)
315                           (csubtypep type1 type2)
316    (multiple-value-bind (stp2 win2)
317                               (csubtypep type2 type1)
318      (cond (stp1 (values type1 t))
319              (stp2 (values type2 t))
320              ((and win1 win2) (values *empty-type* t))
321              (t
322               (values type1 nil))))))
323
324
325;;; VANILLA-UNION  --  Interface
326;;;
327(defun vanilla-union (type1 type2)
328  (cond ((csubtypep type1 type2) type2)
329        ((csubtypep type2 type1) type1)
330        (t nil)))
331
332(defun hierarchical-intersection2 (type1 type2)
333  (multiple-value-bind (subtypep1 win1) (csubtypep type1 type2)
334    (multiple-value-bind (subtypep2 win2) (csubtypep type2 type1)
335      (cond (subtypep1 type1)
336            (subtypep2 type2)
337            ((and win1 win2) *empty-type*)
338            (t nil)))))
339
340(defun hierarchical-union2 (type1 type2)
341  (cond ((csubtypep type1 type2) type2)
342        ((csubtypep type2 type1) type1)
343        (t nil)))
344
345;;; DELEGATE-COMPLEX-{SUBTYPEP-ARG2,INTERSECTION}  --  Interface
346;;;
347;;;    These functions are used as method for types which need a complex
348;;; subtypep method to handle some superclasses, but cover a subtree of the
349;;; type graph (i.e. there is no simple way for any other type class to be a
350;;; subtype.)  There are always still complex ways, namely UNION and MEMBER
351;;; types, so we must give TYPE1's method a chance to run, instead of
352;;; immediately returning NIL, T.
353;;;
354(defun delegate-complex-subtypep-arg2 (type1 type2)
355  (let ((subtypep-arg1
356         (type-class-complex-subtypep-arg1
357          (ctype-class-info type1))))
358    (if subtypep-arg1
359        (funcall subtypep-arg1 type1 type2)
360        (values nil t))))
361;;;
362(defun delegate-complex-intersection (type1 type2)
363  (let ((method (type-class-complex-intersection (ctype-class-info type1))))
364    (if (and method (not (eq method #'delegate-complex-intersection)))
365        (funcall method type2 type1)
366        (hierarchical-intersection2 type1 type2))))
367
368;;; HAS-SUPERCLASSES-COMPLEX-SUBTYPEP-ARG1  --  Internal
369;;;
370;;;    Used by DEFINE-SUPERCLASSES to define the SUBTYPE-ARG1 method.  Info is
371;;; a list of conses (SUPERCLASS-CLASS . {GUARD-TYPE-SPECIFIER | NIL}).  Will
372;;; never be called with a hairy type as type2, since the hairy type type2
373;;; method gets first crack.
374;;;
375#|
376(defun has-superclasses-complex-subtypep-arg1 (type1 type2 info)
377  (values
378   (and (typep type2 'class)
379        (dolist (x info nil)
380          (when (or (not (cdr x))
381                    (csubtypep type1 (specifier-type (cdr x))))
382            (return
383             (or (eq type2 (car x))
384                 (let ((inherits (layout-inherits (class-layout (car x)))))
385                   (dotimes (i (length inherits) nil)
386                     (when (eq type2 (layout-class (svref inherits i)))
387                       (return t)))))))))
388   t))
389|#
390
391(eval-when (:compile-toplevel :execute)
392;;; DEFINE-SUPERCLASSES  --  Interface
393;;;
394;;;    Takes a list of specs of the form (superclass &optional guard).
395;;; Consider one spec (with no guard): any instance of type-class is also a
396;;; subtype of SUPERCLASS and of any of its superclasses.  If there are
397;;; multiple specs, then some will have guards.  We choose the first spec whose
398;;; guard is a supertype of TYPE1 and use its superclass.  In effect, a
399;;; sequence of guards G0, G1, G2 is actually G0, (and G1 (not G0)),
400;;; (and G2 (not (or G0 G1))).
401;;;
402#|
403(defmacro define-superclasses (type-class &rest specs)
404  (let ((info
405         (mapcar #'(lambda (spec)
406                     (destructuring-bind (super &optional guard)
407                                         spec
408                       (cons (find-class super) guard)))
409                 specs)))
410    `(progn
411      (setf (type-class-complex-subtypep-arg1
412             (type-class-or-lose ',type-class))
413            #'(lambda (type1 type2)
414                (has-superclasses-complex-subtypep-arg1 type1 type2 ',info)))
415       
416       (setf (type-class-complex-subtypep-arg2
417              (type-class-or-lose ',type-class))
418             #'delegate-complex-subtypep-arg2)
419       
420       (setf (type-class-complex-intersection
421              (type-class-or-lose ',type-class))
422             #'delegate-complex-intersection))))
423|#
424
425); eval-when (compile eval)
426
427
428(defun reparse-unknown-ctype (type)
429  (if (unknown-ctype-p type)
430    (specifier-type (type-specifier type))
431    type))
432
433(defun swapped-args-fun (f)
434  #'(lambda (x y)
435      (funcall f y x)))
436
437(defun equal-but-no-car-recursion (x y)
438  (cond ((eql x y) t)
439        ((consp x)
440         (and (consp y)
441              (eql (car x) (car y))
442              (equal-but-no-car-recursion (cdr x) (cdr y))))
443        (t nil)))
444
445(defun any/type (op thing list)
446  (declare (type function op))
447  (let ((certain? t))
448    (dolist (i list (values nil certain?))
449      (multiple-value-bind (sub-value sub-certain?) (funcall op thing i)
450        (if sub-certain?
451            (when sub-value (return (values t t)))
452            (setf certain? nil))))))
453
454(defun every/type (op thing list)
455  (declare (type function op))
456  (let ((certain? t))
457    (dolist (i list (if certain? (values t t) (values nil nil)))
458      (multiple-value-bind (sub-value sub-certain?) (funcall op thing i)
459        (if sub-certain?
460            (unless sub-value (return (values nil t)))
461            (setf certain? nil))))))
462
463(defun invoke-complex-=-other-method (type1 type2)
464  (let* ((type-class (ctype-class-info type1))
465         (method-fun (type-class-complex-= type-class)))
466    (if method-fun
467        (funcall (the function method-fun) type2 type1)
468        (values nil t))))
469
470(defun invoke-complex-subtypep-arg1-method (type1 type2 &optional subtypep win)
471  (let* ((type-class (ctype-class-info type1))
472         (method-fun (type-class-complex-subtypep-arg1 type-class)))
473    (if method-fun
474      (funcall (the function method-fun) type1 type2)
475      (values subtypep win))))
476
477(defun type-might-contain-other-types-p (type)
478  (or (hairy-ctype-p type)
479      (negation-ctype-p type)
480      (union-ctype-p type)
481      (intersection-ctype-p type)))
482
483
484(eval-when (:compile-toplevel :execute)
485
486(defmacro define-type-method ((class method &rest more-methods)
487                                    lambda-list &body body)
488  `(progn
489     (let* ((fn (nfunction (,class ,method ,@more-methods)
490                           (lambda ,lambda-list ,@body))))
491       ,@(mapcar #'(lambda (method)
492                         `(setf (%svref
493                                   (type-class-or-lose ',class)
494                             ,(class-function-slot-or-lose method))
495                                  fn))
496                     (cons method more-methods)))
497     nil))
498
499)
500
501
502(defun ctype-p (x)
503  (and (eql (typecode x) target::subtag-istruct)
504       (memq (istruct-type-name x)
505             '#.(cons 'ctype 
506                      (cons 'unknown-ctype                             
507                            (append (mapcar #'class-name 
508                                            (class-direct-subclasses (find-class 'args-ctype)))
509                                    (mapcar #'class-name 
510                                            (class-direct-subclasses (find-class 'ctype)))))))))
511
512
513(setf (type-predicate 'ctype) 'ctype-p)
514
515
516;;;; Function and Values types.
517;;;
518;;;    Pretty much all of the general type operations are illegal on VALUES
519;;; types, since we can't discriminate using them, do SUBTYPEP, etc.  FUNCTION
520;;; types are acceptable to the normal type operations, but are generally
521;;; considered to be equivalent to FUNCTION.  These really aren't true types in
522;;; any type theoretic sense, but we still parse them into CTYPE structures for
523;;; two reasons:
524;;; -- Parsing and unparsing work the same way, and indeed we can't tell
525;;;    whether a type is a function or values type without parsing it.
526;;; -- Many of the places that can be annotated with real types can also be
527;;;    annotated function or values types.
528
529;; Methods on the VALUES type class.
530
531(defun make-values-ctype (&key
532                          required
533                          optional
534                          rest
535                          keyp
536                          keywords
537                          allowp)
538  (%istruct 'values-ctype
539            (type-class-or-lose 'values)
540            nil
541            required
542            optional
543            rest
544            keyp
545            keywords
546            allowp
547           ))
548
549(defun values-ctype-p (x) (istruct-typep x 'values-ctype))
550(setf (type-predicate 'values-ctype) 'values-ctype-p)
551
552
553(define-type-method (values :simple-subtypep :complex-subtypep-arg1)
554                    (type1 type2)
555  (declare (ignore type2))
556  (error "Subtypep is illegal on this type:~%  ~S" (type-specifier type1)))
557
558(define-type-method (values :complex-subtypep-arg2)
559                    (type1 type2)
560  (declare (ignore type1))
561  (error "Subtypep is illegal on this type:~%  ~S" (type-specifier type2)))
562
563
564(define-type-method (values :unparse) (type)
565  (cons 'values (unparse-args-types type)))
566
567
568;;; TYPE=-LIST  --  Internal
569;;;
570;;;    Return true if List1 and List2 have the same elements in the same
571;;; positions according to TYPE=.  We return NIL, NIL if there is an uncertain
572;;; comparison.
573;;;
574(defun type=-list (list1 list2)
575  (declare (list list1 list2))
576  (do ((types1 list1 (cdr types1))
577       (types2 list2 (cdr types2)))
578      ((or (null types1) (null types2))
579       (if (or types1 types2)
580           (values nil t)
581           (values t t)))
582    (multiple-value-bind (val win)
583                               (type= (first types1) (first types2))
584      (unless win
585          (return (values nil nil)))
586      (unless val
587          (return (values nil t))))))
588
589(define-type-method (values :simple-=) (type1 type2)
590  (let ((rest1 (args-ctype-rest type1))
591        (rest2 (args-ctype-rest type2)))
592    (cond ((or (args-ctype-keyp type1) (args-ctype-keyp type2)
593               (args-ctype-allowp type1) (args-ctype-allowp type2))
594             (values nil nil))
595            ((and rest1 rest2 (type/= rest1 rest2))
596             (type= rest1 rest2))
597            ((or rest1 rest2)
598             (values nil t))
599            (t
600             (multiple-value-bind (req-val req-win)
601                 (type=-list (values-ctype-required type1)
602                             (values-ctype-required type2))
603               (multiple-value-bind (opt-val opt-win)
604                   (type=-list (values-ctype-optional type1)
605                               (values-ctype-optional type2))
606                 (values (and req-val opt-val) (and req-win opt-win))))))))
607
608
609;; Methods on the FUNCTION type class.
610
611
612(defun make-function-ctype (&key
613                            required
614                            optional
615                            rest
616                            keyp
617                            keywords
618                            allowp
619                            wild-args
620                            returns)
621  (%istruct 'function-ctype
622            (type-class-or-lose 'function)
623            nil
624            required
625            optional
626            rest
627            keyp
628            keywords
629            allowp
630            wild-args
631            returns
632           ))
633
634(defun function-ctype-p (x) (istruct-typep x 'function-ctype))
635(setf (type-predicate 'function-ctype) 'function-ctype-p)
636
637;;; A flag that we can bind to cause complex function types to be unparsed as
638;;; FUNCTION.  Useful when we want a type that we can pass to TYPEP.
639;;;
640(defvar *unparse-function-type-simplify* nil)
641
642(define-type-method (function :unparse) (type)
643  (if *unparse-function-type-simplify*
644    'function
645    (list 'function
646            (if (function-ctype-wild-args type)
647                '*
648                (unparse-args-types type))
649            (type-specifier
650             (function-ctype-returns type)))))
651
652;;; Since all function types are equivalent to FUNCTION, they are all subtypes
653;;; of each other.
654;;;
655
656(define-type-method (function :simple-subtypep) (type1 type2)
657 (flet ((fun-type-simple-p (type)
658          (not (or (function-ctype-rest type)
659                   (function-ctype-keyp type))))
660        (every-csubtypep (types1 types2)
661          (loop
662             for a1 in types1
663             for a2 in types2
664             do (multiple-value-bind (res sure-p)
665                    (csubtypep a1 a2)
666                  (unless res (return (values res sure-p))))
667             finally (return (values t t)))))
668   (macrolet ((3and (x y)
669                `(multiple-value-bind (val1 win1) ,x
670                   (if (and (not val1) win1)
671                       (values nil t)
672                       (multiple-value-bind (val2 win2) ,y
673                         (if (and val1 val2)
674                             (values t t)
675                             (values nil (and win2 (not val2)))))))))
676     (3and (values-subtypep (function-ctype-returns type1)
677                            (function-ctype-returns type2))
678           (cond ((function-ctype-wild-args type2) (values t t))
679                 ((function-ctype-wild-args type1)
680                  (cond ((function-ctype-keyp type2) (values nil nil))
681                        ((not (function-ctype-rest type2)) (values nil t))
682                        ((not (null (function-ctype-required type2))) (values nil t))
683                        (t (3and (type= *universal-type* (function-ctype-rest type2))
684                                 (every/type #'type= *universal-type*
685                                             (function-ctype-optional type2))))))
686                 ((not (and (fun-type-simple-p type1)
687                            (fun-type-simple-p type2)))
688                  (values nil nil))
689                 (t (multiple-value-bind (min1 max1) (function-type-nargs type1)
690                      (multiple-value-bind (min2 max2) (function-type-nargs type2)
691                        (cond ((or (> max1 max2) (< min1 min2))
692                               (values nil t))
693                              ((and (= min1 min2) (= max1 max2))
694                               (3and (every-csubtypep (function-ctype-required type1)
695                                                      (function-ctype-required type2))
696                                     (every-csubtypep (function-ctype-optional type1)
697                                                      (function-ctype-optional type2))))
698                              (t (every-csubtypep
699                                  (concatenate 'list
700                                               (function-ctype-required type1)
701                                               (function-ctype-optional type1))
702                                  (concatenate 'list
703                                               (function-ctype-required type2)
704                                               (function-ctype-optional type2)))))))))))))
705
706
707                   
708;(define-superclasses function (function))       
709
710
711;;; The union or intersection of two FUNCTION types is FUNCTION.
712;;; (unless the types are type=)
713;;;
714(define-type-method (function :simple-union) (type1 type2)
715  (if (type= type1 type2)
716    type1
717    (specifier-type 'function)))
718
719;;;
720(define-type-method (function :simple-intersection) (type1 type2)
721  (if (type= type1 type2)
722    type1
723    (specifier-type 'function)))
724
725
726(define-type-method (function :complex-intersection) (type1 type2)
727  (declare (type function-ctype type2))
728  (let ((function (specifier-type 'function)))
729    (if (eq type1 function)
730      type2
731      (type-intersection2 type1 function))))
732
733
734
735;;; ### Not very real, but good enough for redefining transforms according to
736;;; type:
737;;;
738(define-type-method (function :simple-=) (type1 type2)
739  (values (equalp type1 type2) t))
740
741;;; The CONSTANT-TYPE structure represents a use of the CONSTANT-ARGUMENT "type
742;;; specifier", which is only meaningful in function argument type specifiers
743;;; used within the compiler.
744;;;
745
746(defun clone-type-class-methods (src-tc dest-tc)
747  (do* ((n (uvsize src-tc))
748        (i 2 (1+ i)))
749       ((= i n) dest-tc)
750    (declare (fixnum i n))
751    (setf (%svref dest-tc i)
752          (%svref src-tc i))))
753
754(clone-type-class-methods (type-class-or-lose 'values) (type-class-or-lose 'constant))
755
756(defun make-constant-ctype (&key type)
757  (%istruct 'constant-ctype
758            (type-class-or-lose 'constant)
759            nil
760            type))
761
762(defun constant-ctype-p (x) (istruct-typep x 'constant-ctype))
763(setf (type-predicate 'constant-ctype) 'constant-ctype-p)
764
765(define-type-method (constant :unparse) (type)
766  `(constant-argument ,(type-specifier (constant-ctype-type type))))
767
768(define-type-method (constant :simple-=) (type1 type2)
769  (type= (constant-ctype-type type1) (constant-ctype-type type2)))
770
771(def-type-translator constant-argument (type &environment env)
772  (make-constant-ctype :type (specifier-type type env)))
773
774
775;;; Parse-Args-Types  --  Internal
776;;;
777;;;    Given a lambda-list like values type specification and a Args-Type
778;;; structure, fill in the slots in the structure accordingly.  This is used
779;;; for both FUNCTION and VALUES types.
780;;;
781
782(defun parse-args-types (lambda-list result &optional env)
783  (multiple-value-bind (required optional restp rest keyp keys allowp aux)
784                           (parse-lambda-list lambda-list)
785    (when aux
786      (error "&Aux in a FUNCTION or VALUES type: ~S." lambda-list))
787    (flet ((parse (spec) (specifier-type spec env)))
788      (setf (args-ctype-required result) (mapcar #'parse required))
789      (setf (args-ctype-optional result) (mapcar #'parse optional))
790      (setf (args-ctype-rest result) (if restp (parse rest) nil))
791      (setf (args-ctype-keyp result) keyp)
792      (let* ((key-info ()))
793        (dolist (key keys)
794          (when (or (atom key) (/= (length key) 2))
795            (signal-program-error "Keyword type description is not a two-list: ~S." key))
796          (let ((kwd (first key)))
797            (when (member kwd key-info :test #'eq :key #'(lambda (x) (key-info-name x)))
798              (signal-program-error "Repeated keyword ~S in lambda list: ~S." kwd lambda-list))
799            (push (make-key-info :name kwd
800                                 :type (parse (second key))) key-info)))
801        (setf (args-ctype-keywords result) (nreverse key-info)))
802      (setf (args-ctype-allowp result) allowp))))
803
804;;; Unparse-Args-Types  --  Internal
805;;;
806;;;    Return the lambda-list like type specification corresponding
807;;; to a Args-Type.
808;;;
809(defun unparse-args-types (type)
810  (let* ((result ()))
811
812    (dolist (arg (args-ctype-required type))
813      (push (type-specifier arg) result))
814
815    (when (args-ctype-optional type)
816      (push '&optional result)
817      (dolist (arg (args-ctype-optional type))
818          (push (type-specifier arg) result)))
819
820    (when (args-ctype-rest type)
821      (push '&rest result)
822      (push (type-specifier (args-ctype-rest type)) result))
823
824    (when (args-ctype-keyp type)
825      (push '&key result)
826      (dolist (key (args-ctype-keywords type))
827          (push (list (key-info-name key)
828                    (type-specifier (key-info-type key))) result)))
829
830    (when (args-ctype-allowp type)
831      (push '&allow-other-keys result))
832
833    (nreverse result)))
834
835(def-type-translator function (&optional (args '*) (result '*) &environment env)
836  (let ((res (make-function-ctype
837                :returns (values-specifier-type result env))))
838    (if (eq args '*)
839        (setf (function-ctype-wild-args res) t)
840        (parse-args-types args res env))
841    res))
842
843(def-type-translator values (&rest values &environment env)
844  (let ((res (make-values-ctype)))
845    (parse-args-types values res env)
846    (when (or (values-ctype-keyp res) (values-ctype-allowp res))
847      (signal-program-error "&KEY or &ALLOW-OTHER-KEYS in values type: ~s"
848                            res))
849    res))
850
851;;; Single-Value-Type  --  Interface
852;;;
853;;;    Return the type of the first value indicated by Type.  This is used by
854;;; people who don't want to have to deal with values types.
855;;;
856(defun single-value-type (type)
857  (declare (type ctype type))
858  (cond ((values-ctype-p type)
859         (or (car (args-ctype-required type))
860             (if (args-ctype-optional type)
861                 (type-union (car (args-ctype-optional type))
862                             (specifier-type 'null)))
863             (args-ctype-rest type)
864             (specifier-type 'null)))
865        ((eq type *wild-type*)
866         *universal-type*)
867        (t
868         type)))
869
870
871;;; FUNCTION-TYPE-NARGS  --  Interface
872;;;
873;;;    Return the minmum number of arguments that a function can be called
874;;; with, and the maximum number or NIL.  If not a function type, return
875;;; NIL, NIL.
876;;;
877(defun function-type-nargs (type)
878  (declare (type ctype type))
879  (if (function-ctype-p type)
880    (let ((fixed (length (args-ctype-required type))))
881        (if (or (args-ctype-rest type)
882                  (args-ctype-keyp type)
883                  (args-ctype-allowp type))
884        (values fixed nil)
885        (values fixed (+ fixed (length (args-ctype-optional type))))))
886    (values nil nil)))
887
888
889;;; Values-Types  --  Interface
890;;;
891;;;    Determine if Type corresponds to a definite number of values.  The first
892;;; value is a list of the types for each value, and the second value is the
893;;; number of values.  If the number of values is not fixed, then return NIL
894;;; and :Unknown.
895;;;
896(defun values-types (type)
897  (declare (type ctype type))
898  (cond ((eq type *wild-type*)
899           (values nil :unknown))
900          ((not (values-ctype-p type))
901           (values (list type) 1))
902          ((or (args-ctype-optional type)
903               (args-ctype-rest type)
904               (args-ctype-keyp type)
905               (args-ctype-allowp type))
906           (values nil :unknown))
907          (t
908           (let ((req (args-ctype-required type)))
909             (values (mapcar #'single-value-type req) (length req))))))
910
911
912;;; Values-Type-Types  --  Internal
913;;;
914;;;    Return two values:
915;;; 1] A list of all the positional (fixed and optional) types.
916;;; 2] The rest type (if any).  If keywords allowed, *universal-type*.  If no
917;;;    keywords or rest, *empty-type*.
918;;;
919(defun values-type-types (type &optional (default-type *empty-type*))
920  (declare (type values-ctype type))
921  (values (append (args-ctype-required type)
922                  (args-ctype-optional type))
923            (cond ((args-ctype-keyp type) *universal-type*)
924                  ((args-ctype-rest type))
925                  (t default-type))))
926
927
928;;; Fixed-Values-Op  --  Internal
929;;;
930;;;    Return a list of Operation applied to the types in Types1 and Types2,
931;;; padding with Rest2 as needed.  Types1 must not be shorter than Types2.  The
932;;; second value is T if Operation always returned a true second value.
933;;;
934(defun fixed-values-op (types1 types2 rest2 operation)
935  (declare (list types1 types2) (type ctype rest2) (type function operation))
936  (let ((exact t))
937    (values (mapcar #'(lambda (t1 t2)
938                              (multiple-value-bind (res win)
939                                  (funcall operation t1 t2)
940                                (unless win (setq exact nil))
941                                res))
942                        types1
943                        (append types2
944                                (make-list (- (length types1) (length types2))
945                                           :initial-element rest2)))
946              exact)))
947
948;;; Coerce-To-Values  --  Internal
949;;;
950;;; If Type isn't a values type, then make it into one:
951;;;    <type>  ==>  (values type &rest t)
952;;;
953(defun coerce-to-values (type)
954  (declare (type ctype type))
955  (if (values-ctype-p type)
956    type
957    (make-values-ctype :required (list type))))
958
959
960;;; Args-Type-Op  --  Internal
961;;;
962;;;    Do the specified Operation on Type1 and Type2, which may be any type,
963;;; including Values types.  With values types such as:
964;;;    (values a0 a1)
965;;;    (values b0 b1)
966;;;
967;;; We compute the more useful result:
968;;;    (values (<operation> a0 b0) (<operation> a1 b1))
969;;;
970;;; Rather than the precise result:
971;;;    (<operation> (values a0 a1) (values b0 b1))
972;;;
973;;; This has the virtue of always keeping the values type specifier outermost,
974;;; and retains all of the information that is really useful for static type
975;;; analysis.  We want to know what is always true of each value independently.
976;;; It is worthless to know that IF the first value is B0 then the second will
977;;; be B1.
978;;;
979;;; If the values count signatures differ, then we produce result with the
980;;; required value count chosen by Nreq when applied to the number of required
981;;; values in type1 and type2.  Any &key values become &rest T (anyone who uses
982;;; keyword values deserves to lose.)
983;;;
984;;; The second value is true if the result is definitely empty or if Operation
985;;; returned true as its second value each time we called it.  Since we
986;;; approximate the intersection of values types, the second value being true
987;;; doesn't mean the result is exact.
988;;;
989(defun args-type-op (type1 type2 operation nreq default-type)
990  (declare (type ctype type1 type2 default-type)
991           (type function operation nreq))
992  (if (eq type1 type2)
993    (values type1 t)
994    (if (or (values-ctype-p type1) (values-ctype-p type2))
995      (let ((type1 (coerce-to-values type1))
996            (type2 (coerce-to-values type2)))
997        (multiple-value-bind (types1 rest1)
998            (values-type-types type1 default-type)
999          (multiple-value-bind (types2 rest2)
1000              (values-type-types type2 default-type)
1001            (multiple-value-bind (rest rest-exact)
1002                (funcall operation rest1 rest2)
1003              (multiple-value-bind
1004                  (res res-exact)
1005                  (if (< (length types1) (length types2))
1006                    (fixed-values-op types2 types1 rest1 operation)
1007                    (fixed-values-op types1 types2 rest2 operation))
1008                (let* ((req (funcall nreq
1009                                     (length (args-ctype-required type1))
1010                                     (length (args-ctype-required type2))))
1011                       (required (subseq res 0 req))
1012                       (opt (subseq res req))
1013                       (opt-last (position rest opt :test-not #'type=
1014                                           :from-end t)))
1015                  (if (find *empty-type* required :test #'type=)
1016                    (values *empty-type* t)
1017                    (values (make-values-ctype
1018                             :required required
1019                             :optional (if opt-last
1020                                         (subseq opt 0 (1+ opt-last))
1021                                         ())
1022                             :rest (if (eq rest *empty-type*) nil rest))
1023                            (and rest-exact res-exact)))))))))
1024      (funcall operation type1 type2))))
1025
1026;;; Values-Type-Union, Values-Type-Intersection  --  Interface
1027;;;
1028;;;    Do a union or intersection operation on types that might be values
1029;;; types.  The result is optimized for utility rather than exactness, but it
1030;;; is guaranteed that it will be no smaller (more restrictive) than the
1031;;; precise result.
1032;;;
1033
1034(defun values-type-union (type1 type2)
1035  (declare (type ctype type1 type2))
1036  (cond ((or (eq type1 *wild-type*) (eq type2 *wild-type*)) *wild-type*)
1037        ((eq type1 *empty-type*) type2)
1038        ((eq type2 *empty-type*) type1)
1039        (t
1040         (values (args-type-op type1 type2 #'type-union #'min *empty-type*)))))
1041
1042(defun values-type-intersection (type1 type2)
1043  (declare (type ctype type1 type2))
1044  (cond ((eq type1 *wild-type*) (values type2 t))
1045        ((eq type2 *wild-type*) (values type1 t))
1046        (t
1047         (args-type-op type1 type2 #'type-intersection #'max
1048                       (specifier-type 'null)))))
1049
1050
1051;;; Values-Types-Intersect  --  Interface
1052;;;
1053;;;    Like Types-Intersect, except that it sort of works on values types.
1054;;; Note that due to the semantics of Values-Type-Intersection, this might
1055;;; return {T, T} when there isn't really any intersection (?).
1056;;;
1057(defun values-types-intersect (type1 type2)
1058  (cond ((or (eq type1 *empty-type*) (eq type2 *empty-type*))
1059           (values t t))
1060          ((or (values-ctype-p type1) (values-ctype-p type2))
1061           (multiple-value-bind (res win)
1062                                    (values-type-intersection type1 type2)
1063             (values (not (eq res *empty-type*))
1064                       win)))
1065          (t
1066           (types-intersect type1 type2))))
1067
1068;;; Values-Subtypep  --  Interface
1069;;;
1070;;;    A subtypep-like operation that can be used on any types, including
1071;;; values types.
1072;;;
1073
1074(defun values-subtypep (type1 type2)
1075  (declare (type ctype type1 type2))
1076  (cond ((eq type2 *wild-type*) (values t t))
1077        ((eq type1 *wild-type*)
1078         (values (eq type2 *universal-type*) t))
1079        ((not (values-types-intersect type1 type2))
1080         (values nil t))
1081        (t
1082         (if (or (values-ctype-p type1) (values-ctype-p type2))
1083           (let ((type1 (coerce-to-values type1))
1084                 (type2 (coerce-to-values type2)))
1085             (multiple-value-bind (types1 rest1)
1086                 (values-type-types type1)
1087               (multiple-value-bind (types2 rest2)
1088                   (values-type-types type2)
1089                 (cond ((< (length (values-ctype-required type1))
1090                           (length (values-ctype-required type2)))
1091                        (values nil t))
1092                       ((< (length types1) (length types2))
1093                        (values nil nil))
1094                       ((or (values-ctype-keyp type1)
1095                            (values-ctype-keyp type2))
1096                        (values nil nil))
1097                       (t
1098                        (do ((t1 types1 (rest t1))
1099                             (t2 types2 (rest t2)))
1100                            ((null t2)
1101                             (csubtypep rest1 rest2))
1102                          (multiple-value-bind
1103                              (res win-p)
1104                              (csubtypep (first t1) (first t2))
1105                            (unless win-p
1106                              (return (values nil nil)))
1107                            (unless res
1108                              (return (values nil t))))))))))
1109           (csubtypep type1 type2)))))
1110 
1111
1112;;;; Type method interfaces:
1113
1114;;; Csubtypep  --  Interface
1115;;;
1116;;;    Like subtypep, only works on Type structures.
1117;;;
1118(defun csubtypep (type1 type2)
1119  (declare (type ctype type1 type2))
1120  (unless (typep type1 'ctype)
1121    (report-bad-arg type1 'ctype))
1122  (unless (typep type2 'ctype)
1123    (report-bad-arg type2 'ctype))
1124  (cond ((or (eq type1 type2)
1125             (eq type1 *empty-type*)
1126             (eq type2 *wild-type*))
1127         (values t t))
1128        (t
1129         (invoke-type-method :simple-subtypep :complex-subtypep-arg2
1130                             type1 type2
1131                             :complex-arg1 :complex-subtypep-arg1))))
1132
1133;;; Type1 is a type-epecifier; type2 is a TYPE-CELL which may cache
1134;;; a mapping between a type-specifier and a CTYPE.
1135(defun cell-csubtypep-2 (type-specifier type-cell)
1136  (let* ((type1 (specifier-type type-specifier))
1137         (type2 (or (type-cell-ctype type-cell)
1138                    (let* ((ctype (specifier-type
1139                                   (type-cell-type-specifier type-cell))))
1140                      (when (cacheable-ctype-p ctype)
1141                        (setf (type-cell-ctype type-cell) ctype))
1142                      ctype))))
1143    (cond ((or (eq type1 type2)
1144               (eq type1 *empty-type*)
1145               (eq type2 *wild-type*))
1146           (values t t))
1147          (t
1148           (invoke-type-method :simple-subtypep :complex-subtypep-arg2
1149                               type1 type2
1150                               :complex-arg1 :complex-subtypep-arg1)))))
1151                             
1152
1153
1154;;; Type=  --  Interface
1155;;;
1156;;;    If two types are definitely equivalent, return true.  The second value
1157;;; indicates whether the first value is definitely correct.  This should only
1158;;; fail in the presence of Hairy types.
1159;;;
1160
1161(defun type= (type1 type2)
1162   (declare (type ctype type1 type2))
1163   (if (eq type1 type2)
1164     (values t t)
1165     (invoke-type-method :simple-= :complex-= type1 type2)))
1166
1167;;; TYPE/=  --  Interface
1168;;;
1169;;;    Not exactly the negation of TYPE=, since when the relationship is
1170;;; uncertain, we still return NIL, NIL.  This is useful in cases where the
1171;;; conservative assumption is =.
1172;;;
1173(defun type/= (type1 type2)
1174  (declare (type ctype type1 type2))
1175  (multiple-value-bind (res win)
1176      (type= type1 type2)
1177    (if win
1178        (values (not res) t)
1179        (values nil nil))))
1180
1181;;; Type-Union  --  Interface
1182;;;
1183;;;    Find a type which includes both types.  Any inexactness is represented
1184;;; by the fuzzy element types; we return a single value that is precise to the
1185;;; best of our knowledge.  This result is simplified into the canonical form,
1186;;; thus is not a UNION type unless there is no other way to represent the
1187;;; result.
1188;;;
1189
1190(defun type-union (&rest input-types)
1191  (%type-union input-types))
1192
1193(defun %type-union (input-types)
1194  (let* ((simplified (simplify-unions input-types)))
1195    (cond ((null simplified) *empty-type*)
1196          ((null (cdr simplified)) (car simplified))
1197          (t (make-union-ctype simplified)))))
1198
1199(defun simplify-unions (types)
1200  (when types
1201    (multiple-value-bind (first rest)
1202        (if (union-ctype-p (car types))
1203          (values (car (union-ctype-types (car types)))
1204                  (append (cdr (union-ctype-types (car types)))
1205                          (cdr types)))
1206          (values (car types) (cdr types)))
1207      (let ((rest (simplify-unions rest)) u)
1208        (dolist (r rest (cons first rest))
1209          (when (setq u (type-union2 first r))
1210            (return (simplify-unions (nsubstitute u r rest)))))))))
1211
1212(defun type-union2 (type1 type2)
1213  (declare (type ctype type1 type2))
1214  (setq type1 (reparse-unknown-ctype type1))
1215  (setq type2 (reparse-unknown-ctype type2))
1216  (cond ((eq type1 type2) type1)
1217        ((csubtypep type1 type2) type2)
1218        ((csubtypep type2 type1) type1)
1219        (t
1220         (flet ((1way (x y)
1221                  (invoke-type-method :simple-union :complex-union
1222                                      x y
1223                                      :default nil)))
1224           (or (1way type1 type2)
1225               (1way type2 type1))))))
1226
1227;;; Return as restrictive and simple a type as we can discover that is
1228;;; no more restrictive than the intersection of TYPE1 and TYPE2. At
1229;;; worst, we arbitrarily return one of the arguments as the first
1230;;; value (trying not to return a hairy type).
1231(defun type-approx-intersection2 (type1 type2)
1232  (declare (type ctype type1 type2))
1233  (cond ((type-intersection2 type1 type2))
1234        ((hairy-ctype-p type1) type2)
1235        (t type1)))
1236
1237
1238;;; Type-Intersection  --  Interface
1239;;;
1240;;;    Return as restrictive a type as we can discover that is no more
1241;;; restrictive than the intersection of Type1 and Type2.  The second value is
1242;;; true if the result is exact.  At worst, we randomly return one of the
1243;;; arguments as the first value (trying not to return a hairy type).
1244;;;
1245
1246(defun type-intersection (&rest input-types)
1247  (%type-intersection input-types))
1248
1249(defun %type-intersection (input-types)
1250  (let ((simplified (simplify-intersections input-types)))
1251    ;;(declare (type (vector ctype) simplified))
1252    ;; We want to have a canonical representation of types (or failing
1253    ;; that, punt to HAIRY-TYPE). Canonical representation would have
1254    ;; intersections inside unions but not vice versa, since you can
1255    ;; always achieve that by the distributive rule. But we don't want
1256    ;; to just apply the distributive rule, since it would be too easy
1257    ;; to end up with unreasonably huge type expressions. So instead
1258    ;; we try to generate a simple type by distributing the union; if
1259    ;; the type can't be made simple, we punt to HAIRY-TYPE.
1260    (if (and (cdr simplified) (some #'union-ctype-p simplified))
1261      (let* ((first-union (find-if #'union-ctype-p simplified))
1262             (other-types (remove first-union simplified))
1263             (distributed (maybe-distribute-one-union first-union other-types)))
1264        (if distributed
1265          (apply #'type-union distributed)
1266          (make-hairy-ctype
1267           :specifier `(and ,@(mapcar #'type-specifier simplified)))))
1268      (cond
1269        ((null simplified) *universal-type*)
1270        ((null (cdr simplified)) (car simplified))
1271        (t (make-intersection-ctype
1272            (some #'(lambda (c) (ctype-enumerable c)) simplified)
1273            simplified))))))
1274
1275(defun simplify-intersections (types)
1276  (when types
1277    (let ((first (if (typep (car types) 'ctype)
1278                   (%car types)
1279                   (specifier-type (%car types)))))
1280      (multiple-value-bind (first rest)
1281          (if (intersection-ctype-p first)
1282            (values (car (intersection-ctype-types first))
1283                    (append (cdr (intersection-ctype-types first))
1284                            (cdr types)))
1285            (values first (cdr types)))
1286        (let ((rest (simplify-intersections rest)) u)
1287          (dolist (r rest (cons first rest))
1288            (when (setq u (type-intersection2 first r))
1289              (return (simplify-intersections (nsubstitute u r rest))))))))))
1290
1291(defun type-intersection2 (type1 type2)
1292  (declare (type ctype type1 type2))
1293  (setq type1 (reparse-unknown-ctype type1))
1294  (setq type2 (reparse-unknown-ctype type2))
1295  (cond ((eq type1 type2)
1296         type1)
1297        ((or (intersection-ctype-p type1)
1298             (intersection-ctype-p type2))
1299         ;; Intersections of INTERSECTION-TYPE should have the
1300         ;; INTERSECTION-CTYPE-TYPES values broken out and intersected
1301         ;; separately. The full TYPE-INTERSECTION function knows how
1302         ;; to do that, so let it handle it.
1303         (type-intersection type1 type2))
1304        ;;
1305        ;; (AND (FUNCTION (T) T) GENERIC-FUNCTION) for instance, but
1306        ;; not (AND (FUNCTION (T) T) (FUNCTION (T) T)).
1307        ((let ((function (specifier-type 'function)))
1308           (or (and (function-ctype-p type1)
1309                    (not (function-ctype-p type2))
1310                    (neq function type2)
1311                    (csubtypep type2 function)
1312                    (not (csubtypep function type2)))
1313               (and (function-ctype-p type2)
1314                    (not (function-ctype-p type1))
1315                    (neq function type1)
1316                    (csubtypep type1 function)
1317                    (not (csubtypep function type1)))))
1318         nil)
1319        (t
1320         (flet ((1way (x y)
1321                  (invoke-type-method :simple-intersection
1322                                      :complex-intersection
1323                                      x y
1324                                      :default :no-type-method-found)))
1325           (let ((xy (1way type1 type2)))
1326             (or (and (not (eql xy :no-type-method-found)) xy)
1327                 (let ((yx (1way type2 type1)))
1328                   (or (and (not (eql yx :no-type-method-found)) yx)
1329                       (cond ((and (eql xy :no-type-method-found)
1330                                   (eql yx :no-type-method-found))
1331                              *empty-type*)
1332                             (t
1333                              nil))))))))))
1334
1335
1336
1337(defun maybe-distribute-one-union (union-type types)
1338  (let* ((intersection (apply #'type-intersection types))
1339         (union (mapcar (lambda (x) (type-intersection x intersection))
1340                        (union-ctype-types union-type))))
1341    (if (notany (lambda (x)
1342                  (or (hairy-ctype-p x)
1343                      (intersection-ctype-p x)))
1344                union)
1345        union
1346        nil)))
1347
1348;;; Types-Intersect  --  Interface
1349;;;
1350;;;    The first value is true unless the types don't intersect.  The second
1351;;; value is true if the first value is definitely correct.  NIL is considered
1352;;; to intersect with any type.  If T is a subtype of either type, then we also
1353;;; return T, T.  This way we consider hairy types to intersect with T.
1354;;;
1355(defun types-intersect (type1 type2)
1356  (declare (type ctype type1 type2))
1357  (if (or (eq type1 *empty-type*) (eq type2 *empty-type*))
1358      (values t t)
1359      (let ((intersection2 (type-intersection2 type1 type2)))
1360        (cond ((not intersection2)
1361               (if (or (csubtypep *universal-type* type1)
1362                       (csubtypep *universal-type* type2))
1363                   (values t t)
1364                   (values t nil)))
1365              ((eq intersection2 *empty-type*) (values nil t))
1366              (t (values t t))))))
1367
1368;;; Type-Specifier  --  Interface
1369;;;
1370;;;    Return a Common Lisp type specifier corresponding to this type.
1371;;;
1372(defun type-specifier (type)
1373  (unless (ctype-p type)
1374    (setq type (require-type type 'ctype)))
1375  (locally 
1376      (declare (type ctype type))
1377    (funcall (type-class-unparse (ctype-class-info type)) type)))
1378
1379
1380(defconstant compound-only-type-specifiers
1381  ;; See CLHS Figure 4-4.
1382  '(and mod satisfies eql not values member or))
1383
1384
1385;;; VALUES-SPECIFIER-TYPE  --  Interface
1386;;;
1387;;;    Return the type structure corresponding to a type specifier.  We pick
1388;;; off Structure types as a special case.
1389;;;
1390
1391(defun values-specifier-type-internal (orig env)
1392  (or (info-type-builtin orig) ; this table could contain bytes etal and ands ors nots of built-in types - no classes
1393     
1394      ;; Now that we have our hands on the environment, we could pass it into type-expand,
1395      ;; but we'd have no way of knowing whether the expansion depended on the env, so
1396      ;; we wouldn't know if the result is safe to cache.   So for now don't let type
1397      ;; expanders see the env, which just means they won't see compile-time types.
1398      (let ((spec (type-expand orig #+not-yet env)))
1399        (cond
1400         ((and (not (eq spec orig))
1401               (info-type-builtin spec)))
1402         ((or (eq (info-type-kind spec) :instance)
1403              (and (symbolp spec)
1404                   (typep (find-class spec nil env) 'compile-time-class)))
1405          (let* ((class-ctype (%class.ctype (find-class spec t env))))
1406            (or (class-ctype-translation class-ctype)
1407                class-ctype)))
1408         ((typep spec 'class)
1409          (let* ((class-ctype (%class.ctype spec)))
1410            (or (class-ctype-translation class-ctype)
1411                class-ctype)))
1412         ((let ((cell (find-builtin-cell spec nil)))
1413           (and cell (cdr cell))))
1414         (t
1415          (when (member spec compound-only-type-specifiers)
1416            (error 'invalid-type-specifier :typespec spec))
1417          (let* ((lspec (if (atom spec) (list spec) spec))
1418                 (fun (info-type-translator (car lspec))))
1419            (cond (fun (funcall fun lspec env))
1420                  ((or (and (consp spec)
1421                            (symbolp (car spec))
1422                            (not (or (find-class (car spec) nil env)
1423                                     (info-type-builtin (car spec)))))
1424                       (symbolp spec))
1425                   (when *type-system-initialized*
1426                     (signal 'parse-unknown-type :specifier spec))
1427                   ;;
1428                   ;; Inhibit caching...
1429                   nil)
1430                  (t
1431                   (error 'invalid-type-specifier :typespec spec)))))))))
1432
1433(eval-when (:compile-toplevel :execute)
1434  (defconstant type-cache-size (ash 1 12))
1435  (defconstant type-cache-mask (1- type-cache-size)))
1436
1437(defun compile-time-ctype-p (ctype)
1438  (and (typep ctype 'class-ctype)
1439       (typep (class-ctype-class ctype) 'compile-time-class)))
1440
1441
1442;;; We can get in trouble if we try to cache certain kinds of ctypes,
1443;;; notably MEMBER types which refer to objects which might
1444;;; be stack-allocated or might be EQUAL without being EQL.
1445(defun cacheable-ctype-p (ctype)
1446  (case (istruct-cell-name (%svref ctype 0))
1447    (member-ctype
1448     (dolist (m (member-ctype-members ctype) t)
1449       (when (or (typep m 'cons)
1450                 (typep m 'array))
1451         (return nil))))
1452    (union-ctype
1453     (every #'cacheable-ctype-p (union-ctype-types ctype)))
1454    (intersection-ctype
1455     (every #'cacheable-ctype-p (intersection-ctype-types ctype)))
1456    (array-ctype
1457     (cacheable-ctype-p (array-ctype-element-type ctype)))
1458    ((values-ctype function-ctype)
1459     (and (every #'cacheable-ctype-p (values-ctype-required ctype))
1460          (every #'cacheable-ctype-p (values-ctype-optional ctype))
1461          (let* ((rest (values-ctype-rest ctype)))
1462            (or (null rest) (cacheable-ctype-p rest)))
1463          (every #'(lambda (info)
1464                     (cacheable-ctype-p (key-info-type info)))
1465                 (values-ctype-keywords ctype))
1466          (or (not (eq (istruct-cell-name (%svref ctype 0)) 'function-ctype))
1467              (let* ((result (function-ctype-returns ctype)))
1468                (or (null result)
1469                    (cacheable-ctype-p result))))))
1470    (negation-ctype
1471     (cacheable-ctype-p (negation-ctype-type ctype)))
1472    (cons-ctype
1473     (and (cacheable-ctype-p (cons-ctype-car-ctype ctype))
1474          (cacheable-ctype-p (cons-ctype-cdr-ctype ctype))))
1475    (unknown-ctype nil)
1476    (class-ctype
1477     (not (typep (class-ctype-class ctype) 'compile-time-class)))
1478    ;; Anything else ?  Simple things (numbers, classes) can't lose.
1479    (t t)))
1480               
1481     
1482   
1483
1484(defun hash-type-specifier (spec)
1485  (logand (sxhash spec) type-cache-mask))
1486
1487
1488(let* ((type-cache-specs (make-array type-cache-size))
1489       (type-cache-ctypes (make-array type-cache-size))
1490       (probes 0)
1491       (hits 0)
1492       (ncleared 0)
1493       (locked nil)
1494       (lock (make-lock)))
1495 
1496  (defun clear-type-cache ()
1497    (with-lock-grabbed (lock)
1498      (%init-misc 0 type-cache-specs)
1499      (%init-misc 0 type-cache-ctypes)
1500      (incf ncleared))
1501    nil)
1502
1503  (defun values-specifier-type (spec &optional env)
1504    (if (typep spec 'class)
1505      (let* ((class-ctype (%class.ctype spec)))
1506        (or (class-ctype-translation class-ctype) class-ctype))
1507      (handler-case
1508          (with-lock-grabbed (lock)
1509            (if locked
1510              (or (values-specifier-type-internal spec env)
1511                  (make-unknown-ctype :specifier spec))
1512              (unwind-protect
1513                   (progn
1514                     (setq locked t)
1515                     (if (or (symbolp spec)
1516                             (and (consp spec)
1517                                  (symbolp (car spec))
1518                                  ;; hashing scheme uses equal, so only use when equivalent to eql
1519                                  (not (and (eq (car spec) 'member)
1520                                            (some (lambda (x)
1521                                                    (typep x '(or cons string bit-vector pathname)))
1522                                                  (cdr spec))))))
1523                       (let* ((idx (hash-type-specifier spec)))
1524                         (incf probes)
1525                         (if (equal (svref type-cache-specs idx) spec)
1526                           (progn
1527                             (incf hits)
1528                             (svref type-cache-ctypes idx))
1529                           (let* ((ctype (values-specifier-type-internal spec env)))
1530                             (if ctype
1531                               (progn
1532                                 (when (cacheable-ctype-p ctype)
1533                                   (setf (svref type-cache-specs idx) (copy-tree spec) ; in case it was stack-consed
1534                                         (svref type-cache-ctypes idx) ctype))
1535                                 ctype)
1536                               (make-unknown-ctype :specifier spec)))))
1537                       (values-specifier-type-internal spec env)))
1538                (setq locked nil))))
1539        (error (condition) (error condition)))))
1540 
1541  (defun type-cache-hit-rate ()
1542    (values hits probes))
1543 
1544  (defun type-cache-locked-p ()
1545    locked)
1546
1547  (defun lock-type-cache ()
1548    (setq locked t)))
1549                   
1550
1551 
1552
1553;;; SPECIFIER-TYPE  --  Interface
1554;;;
1555;;;    Like VALUES-SPECIFIER-TYPE, except that we guarantee to never return a
1556;;; VALUES type.
1557;;;
1558(defun specifier-type (x &optional env)
1559  (let ((res (values-specifier-type x env)))
1560    (when (values-ctype-p res)
1561      (signal-program-error "VALUES type illegal in this context:~%  ~S" x))
1562    res))
1563
1564(defun single-value-specifier-type (x &optional env)
1565  (let ((res (specifier-type x env)))
1566    (if (eq res *wild-type*)
1567        *universal-type*
1568        res)))
1569
1570(defun standardized-type-specifier (spec &optional env)
1571  (handler-case
1572      (type-specifier (specifier-type spec env))
1573    (program-error () spec)
1574    (parse-unknown-type () spec)))
1575
1576(defun modified-numeric-type (base
1577                              &key
1578                              (class      (numeric-ctype-class      base))
1579                              (format     (numeric-ctype-format     base))
1580                              (complexp   (numeric-ctype-complexp   base))
1581                              (low        (numeric-ctype-low        base))
1582                              (high       (numeric-ctype-high       base))
1583                              (enumerable (ctype-enumerable base)))
1584  (make-numeric-ctype :class class
1585                     :format format
1586                     :complexp complexp
1587                     :low low
1588                     :high high
1589                     :enumerable enumerable))
1590
1591;;; Precompute-Types  --  Interface
1592;;;
1593;;;    Take a list of type specifiers, compute the translation and define it as
1594;;; a builtin type.
1595;;;
1596 
1597(defun precompute-types (specs)
1598  (dolist (spec specs)
1599    (let ((res (specifier-type spec)))
1600      (when (numeric-ctype-p res)
1601        (let ((pred (make-numeric-ctype-predicate res)))
1602          (when pred (setf (numeric-ctype-predicate res) pred))))
1603      (unless (unknown-ctype-p res)
1604        (setf (info-type-builtin spec) res)
1605        (setf (info-type-kind spec) :primitive)))))
1606
1607;;;; Builtin types.
1608
1609;;; The NAMED-TYPE is used to represent *, T and NIL.  These types must be
1610;;; super or sub types of all types, not just classes and * & NIL aren't
1611;;; classes anyway, so it wouldn't make much sense to make them built-in
1612;;; classes.
1613;;;
1614
1615(defun define-named-ctype (name)
1616  (let* ((ctype (%istruct 'named-ctype
1617                          (type-class-or-lose 'named)
1618                          nil
1619                          name)))
1620    (setf (info-type-kind name) :builtin
1621          (info-type-builtin name) ctype)))
1622
1623
1624(defvar *wild-type* (define-named-ctype '*))
1625(defvar *empty-type* (define-named-ctype nil))
1626(defvar *universal-type* (define-named-ctype t))
1627
1628(defun named-ctype-p (x)
1629  (istruct-typep x 'named-ctype))
1630
1631(setf (type-predicate 'named-ctype) 'named-ctype-p)
1632
1633(define-type-method (named :simple-=) (type1 type2)
1634  (values (eq type1 type2) t))
1635
1636(define-type-method (named :complex-=) (type1 type2)
1637  (cond
1638    ((and (eq type2 *empty-type*)
1639          (intersection-ctype-p type1)
1640          ;; not allowed to be unsure on these... FIXME: keep the list
1641          ;; of CL types that are intersection types once and only
1642          ;; once.
1643          (not (or (type= type1 (specifier-type 'ratio))
1644                   (type= type1 (specifier-type 'keyword)))))
1645     ;; things like (AND (EQL 0) (SATISFIES ODDP)) or (AND FUNCTION
1646     ;; STREAM) can get here.  In general, we can't really tell
1647     ;; whether these are equal to NIL or not, so
1648     (values nil nil))
1649    ((type-might-contain-other-types-p type1)
1650     (invoke-complex-=-other-method type1 type2))
1651    (t (values nil t))))
1652
1653
1654(define-type-method (named :simple-subtypep) (type1 type2)
1655  (values (or (eq type1 *empty-type*) (eq type2 *wild-type*)) t))
1656
1657(define-type-method (named :complex-subtypep-arg1) (type1 type2)
1658  (cond ((eq type1 *empty-type*)
1659         t)
1660        (;; When TYPE2 might be the universal type in disguise
1661         (type-might-contain-other-types-p type2)
1662         ;; Now that the UNION and HAIRY COMPLEX-SUBTYPEP-ARG2 methods
1663         ;; can delegate to us (more or less as CALL-NEXT-METHOD) when
1664         ;; they're uncertain, we can't just barf on COMPOUND-TYPE and
1665         ;; HAIRY-TYPEs as we used to. Instead we deal with the
1666         ;; problem (where at least part of the problem is cases like
1667         ;;   (SUBTYPEP T '(SATISFIES FOO))
1668         ;; or
1669         ;;   (SUBTYPEP T '(AND (SATISFIES FOO) (SATISFIES BAR)))
1670         ;; where the second type is a hairy type like SATISFIES, or
1671         ;; is a compound type which might contain a hairy type) by
1672         ;; returning uncertainty.
1673         (values nil nil))
1674        (t
1675         ;; By elimination, TYPE1 is the universal type.
1676         (assert (or (eq type1 *wild-type*) (eq type1 *universal-type*)))
1677         ;; This case would have been picked off by the SIMPLE-SUBTYPEP
1678         ;; method, and so shouldn't appear here.
1679         (assert (not (eq type2 *universal-type*)))
1680         ;; Since TYPE2 is not EQ *UNIVERSAL-TYPE* and is not the
1681         ;; universal type in disguise, TYPE2 is not a superset of TYPE1.
1682         (values nil t))))
1683
1684
1685(define-type-method (named :complex-subtypep-arg2) (type1 type2)
1686  (assert (not (eq type2 *wild-type*))) ; * isn't really a type.
1687  (cond ((eq type2 *universal-type*)
1688         (values t t))
1689        ((type-might-contain-other-types-p type1)
1690         ;; those types can be *EMPTY-TYPE* or *UNIVERSAL-TYPE* in
1691         ;; disguise.  So we'd better delegate.
1692         (invoke-complex-subtypep-arg1-method type1 type2))
1693        (t
1694         ;; FIXME: This seems to rely on there only being 2 or 3
1695         ;; NAMED-TYPE values, and the exclusion of various
1696         ;; possibilities above. It would be good to explain it and/or
1697         ;; rewrite it so that it's clearer.
1698         (values (not (eq type2 *empty-type*)) t))))
1699
1700
1701(define-type-method (named :complex-intersection) (type1 type2)
1702  (hierarchical-intersection2 type1 type2))
1703
1704(define-type-method (named :unparse) (x)
1705  (named-ctype-name x))
1706
1707
1708;;;; Hairy and unknown types:
1709
1710;;; The Hairy-Type represents anything too wierd to be described
1711;;; reasonably or to be useful, such as SATISFIES.  We just remember
1712;;; the original type spec.
1713;;;
1714
1715(defun make-hairy-ctype (&key specifier (enumerable t))
1716  (%istruct 'hairy-ctype
1717            (type-class-or-lose 'hairy)
1718            enumerable
1719            specifier))
1720
1721(defun hairy-ctype-p (x)
1722  (or (istruct-typep x 'hairy-ctype)
1723      (istruct-typep x 'unknown-ctype)))
1724
1725(setf (type-predicate 'hairy-ctype) 'hairy-ctype-p)
1726
1727(define-type-method (hairy :unparse) (x) (hairy-ctype-specifier x))
1728
1729(define-type-method (hairy :simple-subtypep) (type1 type2)
1730  (let ((hairy-spec1 (hairy-ctype-specifier type1))
1731        (hairy-spec2 (hairy-ctype-specifier type2)))
1732    (cond ((equal-but-no-car-recursion hairy-spec1 hairy-spec2)
1733           (values t t))
1734          (t
1735           (values nil nil)))))
1736
1737(define-type-method (hairy :complex-subtypep-arg2) (type1 type2)
1738  (invoke-complex-subtypep-arg1-method type1 type2))
1739
1740(define-type-method (hairy :complex-subtypep-arg1) (type1 type2)
1741  (declare (ignore type1 type2))
1742  (values nil nil))
1743
1744(define-type-method (hairy :complex-=) (type1 type2)
1745  (if (and (unknown-ctype-p type2)
1746           (let* ((specifier2 (unknown-ctype-specifier type2))
1747                  (name2 (if (consp specifier2)
1748                           (car specifier2)
1749                           specifier2)))
1750             (info-type-kind name2)))
1751      (let ((type2 (specifier-type (unknown-ctype-specifier type2))))
1752        (if (unknown-ctype-p type2)
1753            (values nil nil)
1754            (type= type1 type2)))
1755  (values nil nil)))
1756
1757(define-type-method (hairy :simple-intersection :complex-intersection)
1758                    (type1 type2)
1759  (if (type= type1 type2)
1760    type1
1761    nil))
1762
1763
1764(define-type-method (hairy :simple-union) 
1765    (type1 type2)
1766  (if (type= type1 type2)
1767      type1
1768      nil))
1769
1770(define-type-method (hairy :simple-=) (type1 type2)
1771  (if (equal-but-no-car-recursion (hairy-ctype-specifier type1)
1772                                  (hairy-ctype-specifier type2))
1773      (values t t)
1774      (values nil nil)))
1775
1776
1777
1778(def-type-translator satisfies (&whole x fun)
1779  (unless (symbolp fun)
1780    (report-bad-arg fun 'symbol))
1781  (make-hairy-ctype :specifier x))
1782
1783
1784;;; Negation Ctypes
1785(defun make-negation-ctype (&key type (enumerable t))
1786  (%istruct 'negation-ctype
1787            (type-class-or-lose 'negation)
1788            enumerable
1789            type))
1790
1791(defun negation-ctype-p (x)
1792  (istruct-typep x 'negation-ctype))
1793
1794(setf (type-predicate 'negation-ctype) 'negation-ctype-p)
1795
1796(define-type-method (negation :unparse) (x)
1797  `(not ,(type-specifier (negation-ctype-type x))))
1798
1799(define-type-method (negation :simple-subtypep) (type1 type2)
1800  (csubtypep (negation-ctype-type type2) (negation-ctype-type type1)))
1801
1802(define-type-method (negation :complex-subtypep-arg2) (type1 type2)
1803  (let* ((complement-type2 (negation-ctype-type type2))
1804         (intersection2 (type-intersection type1 complement-type2)))
1805    (if intersection2
1806        ;; FIXME: if uncertain, maybe try arg1?
1807        (type= intersection2 *empty-type*)
1808        (invoke-complex-subtypep-arg1-method type1 type2))))
1809
1810(define-type-method (negation :complex-subtypep-arg1) (type1 type2)
1811  (block nil
1812    ;; (Several logical truths in this block are true as long as
1813    ;; b/=T. As of sbcl-0.7.1.28, it seems impossible to construct a
1814    ;; case with b=T where we actually reach this type method, but
1815    ;; we'll test for and exclude this case anyway, since future
1816    ;; maintenance might make it possible for it to end up in this
1817    ;; code.)
1818    (multiple-value-bind (equal certain)
1819        (type= type2 *universal-type*)
1820      (unless certain
1821        (return (values nil nil)))
1822      (when equal
1823        (return (values t t))))
1824    (let ((complement-type1 (negation-ctype-type type1)))
1825      ;; Do the special cases first, in order to give us a chance if
1826      ;; subtype/supertype relationships are hairy.
1827      (multiple-value-bind (equal certain) 
1828          (type= complement-type1 type2)
1829        ;; If a = b, ~a is not a subtype of b (unless b=T, which was
1830        ;; excluded above).
1831        (unless certain
1832          (return (values nil nil)))
1833        (when equal
1834          (return (values nil t))))
1835      ;; KLUDGE: ANSI requires that the SUBTYPEP result between any
1836      ;; two built-in atomic type specifiers never be uncertain. This
1837      ;; is hard to do cleanly for the built-in types whose
1838      ;; definitions include (NOT FOO), i.e. CONS and RATIO. However,
1839      ;; we can do it with this hack, which uses our global knowledge
1840      ;; that our implementation of the type system uses disjoint
1841      ;; implementation types to represent disjoint sets (except when
1842      ;; types are contained in other types).  (This is a KLUDGE
1843      ;; because it's fragile. Various changes in internal
1844      ;; representation in the type system could make it start
1845      ;; confidently returning incorrect results.) -- WHN 2002-03-08
1846      (unless (or (type-might-contain-other-types-p complement-type1)
1847                  (type-might-contain-other-types-p type2))
1848        ;; Because of the way our types which don't contain other
1849        ;; types are disjoint subsets of the space of possible values,
1850        ;; (SUBTYPEP '(NOT AA) 'B)=NIL when AA and B are simple (and B
1851        ;; is not T, as checked above).
1852        (return (values nil t)))
1853      ;; The old (TYPE= TYPE1 TYPE2) branch would never be taken, as
1854      ;; TYPE1 and TYPE2 will only be equal if they're both NOT types,
1855      ;; and then the :SIMPLE-SUBTYPEP method would be used instead.
1856      ;; But a CSUBTYPEP relationship might still hold:
1857      (multiple-value-bind (equal certain)
1858          (csubtypep complement-type1 type2)
1859        ;; If a is a subtype of b, ~a is not a subtype of b (unless
1860        ;; b=T, which was excluded above).
1861        (unless certain
1862          (return (values nil nil)))
1863        (when equal
1864          (return (values nil t))))
1865      (multiple-value-bind (equal certain)
1866          (csubtypep type2 complement-type1)
1867        ;; If b is a subtype of a, ~a is not a subtype of b.  (FIXME:
1868        ;; That's not true if a=T. Do we know at this point that a is
1869        ;; not T?)
1870        (unless certain
1871          (return (values nil nil)))
1872        (when equal
1873          (return (values nil t))))
1874      ;; old CSR comment ca. 0.7.2, now obsoleted by the SIMPLE-CTYPE?
1875      ;; KLUDGE case above: Other cases here would rely on being able
1876      ;; to catch all possible cases, which the fragility of this type
1877      ;; system doesn't inspire me; for instance, if a is type= to ~b,
1878      ;; then we want T, T; if this is not the case and the types are
1879      ;; disjoint (have an intersection of *empty-type*) then we want
1880      ;; NIL, T; else if the union of a and b is the *universal-type*
1881      ;; then we want T, T. So currently we still claim to be unsure
1882      ;; about e.g. (subtypep '(not fixnum) 'single-float).
1883      ;;
1884      ;; OTOH we might still get here:
1885      (values nil nil))))
1886
1887(define-type-method (negation :complex-=) (type1 type2)
1888  ;; (NOT FOO) isn't equivalent to anything that's not a negation
1889  ;; type, except possibly a type that might contain it in disguise.
1890  (declare (ignore type2))
1891  (if (type-might-contain-other-types-p type1)
1892      (values nil nil)
1893      (values nil t)))
1894
1895(define-type-method (negation :simple-intersection) (type1 type2)
1896  (let ((not1 (negation-ctype-type type1))
1897        (not2 (negation-ctype-type type2)))
1898    (cond
1899      ((csubtypep not1 not2) type2)
1900      ((csubtypep not2 not1) type1)
1901      ;; Why no analagous clause to the disjoint in the SIMPLE-UNION2
1902      ;; method, below?  The clause would read
1903      ;;
1904      ;; ((EQ (TYPE-UNION NOT1 NOT2) *UNIVERSAL-TYPE*) *EMPTY-TYPE*)
1905      ;;
1906      ;; but with proper canonicalization of negation types, there's
1907      ;; no way of constructing two negation types with union of their
1908      ;; negations being the universal type.
1909      (t
1910       nil))))
1911
1912(define-type-method (negation :complex-intersection) (type1 type2)
1913  (cond
1914    ((csubtypep type1 (negation-ctype-type type2)) *empty-type*)
1915    ((eq (type-intersection type1 (negation-ctype-type type2)) *empty-type*)
1916     type1)
1917    (t nil)))
1918
1919(define-type-method (negation :simple-union) (type1 type2)
1920  (let ((not1 (negation-ctype-type type1))
1921        (not2 (negation-ctype-type type2)))
1922    (cond
1923      ((csubtypep not1 not2) type1)
1924      ((csubtypep not2 not1) type2)
1925      ((eq (type-intersection not1 not2) *empty-type*)
1926       *universal-type*)
1927      (t nil))))
1928
1929(define-type-method (negation :complex-union) (type1 type2)
1930  (cond
1931    ((csubtypep (negation-ctype-type type2) type1) *universal-type*)
1932    ((eq (type-intersection type1 (negation-ctype-type type2)) *empty-type*)
1933     type2)
1934    (t nil)))
1935
1936(define-type-method (negation :simple-=) (type1 type2)
1937  (type= (negation-ctype-type type1) (negation-ctype-type type2)))
1938
1939(def-type-translator not (typespec &environment env)
1940  (let* ((not-type (specifier-type typespec env))
1941         (spec (type-specifier not-type)))
1942    (cond
1943      ;; canonicalize (NOT (NOT FOO))
1944      ((and (listp spec) (eq (car spec) 'not))
1945       (specifier-type (cadr spec) env))
1946      ;; canonicalize (NOT NIL) and (NOT T)
1947      ((eq not-type *empty-type*) *universal-type*)
1948      ((eq not-type *universal-type*) *empty-type*)
1949      ((and (numeric-ctype-p not-type)
1950            (null (numeric-ctype-low not-type))
1951            (null (numeric-ctype-high not-type)))
1952       (make-negation-ctype :type not-type))
1953      ((numeric-ctype-p not-type)
1954       (type-union
1955        (make-negation-ctype
1956         :type (modified-numeric-type not-type :low nil :high nil))
1957        (cond
1958          ((null (numeric-ctype-low not-type))
1959           (modified-numeric-type
1960            not-type
1961            :low (let ((h (numeric-ctype-high not-type)))
1962                   (if (consp h) (car h) (list h)))
1963            :high nil))
1964          ((null (numeric-ctype-high not-type))
1965           (modified-numeric-type
1966            not-type
1967            :low nil
1968            :high (let ((l (numeric-ctype-low not-type)))
1969                    (if (consp l) (car l) (list l)))))
1970          (t (type-union
1971              (modified-numeric-type
1972               not-type
1973               :low nil
1974               :high (let ((l (numeric-ctype-low not-type)))
1975                       (if (consp l) (car l) (list l))))
1976              (modified-numeric-type
1977               not-type
1978               :low (let ((h (numeric-ctype-high not-type)))
1979                      (if (consp h) (car h) (list h)))
1980               :high nil))))))
1981      ((intersection-ctype-p not-type)
1982       (apply #'type-union
1983              (mapcar #'(lambda (x)
1984                          (specifier-type `(not ,(type-specifier x)) env))
1985                      (intersection-ctype-types not-type))))
1986      ((union-ctype-p not-type)
1987       (apply #'type-intersection
1988              (mapcar #'(lambda (x)
1989                          (specifier-type `(not ,(type-specifier x)) env))
1990                      (union-ctype-types not-type))))
1991      ((member-ctype-p not-type)
1992       (let ((members (member-ctype-members not-type)))
1993         (if (some #'floatp members)
1994           (let (floats)
1995             (dolist (pair '((0.0f0 . -0.0f0) (0.0d0 . -0.0d0)))
1996               (when (member (car pair) members)
1997                 (assert (not (member (cdr pair) members)))
1998                 (push (cdr pair) floats)
1999                 (setf members (remove (car pair) members)))
2000               (when (member (cdr pair) members)
2001                 (assert (not (member (car pair) members)))
2002                 (push (car pair) floats)
2003                 (setf members (remove (cdr pair) members))))
2004             (apply #'type-intersection
2005                    (if (null members)
2006                      *universal-type*
2007                      (make-negation-ctype
2008                       :type (make-member-ctype :members members)))
2009                    (mapcar
2010                     (lambda (x)
2011                       (let ((type (ctype-of x)))
2012                         (type-union
2013                          (make-negation-ctype
2014                           :type (modified-numeric-type type
2015                                                          :low nil :high nil))
2016                            (modified-numeric-type type
2017                                                   :low nil :high (list x))
2018                            (make-member-ctype :members (list x))
2019                            (modified-numeric-type type
2020                                                   :low (list x) :high nil))))
2021                     floats)))
2022             (make-negation-ctype :type not-type))))
2023      ((and (cons-ctype-p not-type)
2024            (eq (cons-ctype-car-ctype not-type) *universal-type*)
2025            (eq (cons-ctype-cdr-ctype not-type) *universal-type*))
2026       (make-negation-ctype :type not-type))
2027      ((cons-ctype-p not-type)
2028       (type-union
2029        (make-negation-ctype :type (specifier-type 'cons env))
2030        (cond
2031          ((and (not (eq (cons-ctype-car-ctype not-type) *universal-type*))
2032                (not (eq (cons-ctype-cdr-ctype not-type) *universal-type*)))
2033           (type-union
2034            (make-cons-ctype
2035             (specifier-type `(not ,(type-specifier
2036                                     (cons-ctype-car-ctype not-type))) env)
2037             *universal-type*)
2038            (make-cons-ctype
2039             *universal-type*
2040             (specifier-type `(not ,(type-specifier
2041                                     (cons-ctype-cdr-ctype not-type))) env))))
2042          ((not (eq (cons-ctype-car-ctype not-type) *universal-type*))
2043           (make-cons-ctype
2044            (specifier-type `(not ,(type-specifier
2045                                    (cons-ctype-car-ctype not-type))) env)
2046            *universal-type*))
2047          ((not (eq (cons-ctype-cdr-ctype not-type) *universal-type*))
2048           (make-cons-ctype
2049            *universal-type*
2050            (specifier-type `(not ,(type-specifier
2051                                    (cons-ctype-cdr-ctype not-type))) env)))
2052          (t (error "Weird CONS type ~S" not-type)))))
2053      (t (make-negation-ctype :type not-type)))))
2054
2055
2056;;;; Numeric types.
2057
2058;;; A list of all the float formats, in order of decreasing precision.
2059;;;
2060(eval-when (:compile-toplevel :load-toplevel :execute)
2061  (defconstant float-formats
2062    '(long-float double-float single-float short-float)))
2063
2064;;; The type of a float format.
2065;;;
2066(deftype float-format () `(member ,@float-formats))
2067
2068(defun type-bound-number (x)
2069  (if (consp x)
2070      (destructuring-bind (result) x result)
2071      x))
2072
2073(defun make-numeric-ctype (&key class 
2074                                format
2075                                (complexp :real)
2076                                low
2077                                high
2078                                enumerable
2079                                predicate)
2080  ;; if interval is empty
2081  (if (and low
2082           high
2083           (if (or (consp low) (consp high)) ; if either bound is exclusive
2084             (>= (type-bound-number low) (type-bound-number high))
2085             (> low high)))
2086    *empty-type*
2087    (multiple-value-bind (canonical-low canonical-high)
2088        (case class
2089          (integer
2090           ;; INTEGER types always have their LOW and HIGH bounds
2091           ;; represented as inclusive, not exclusive values.
2092           (values (if (consp low)
2093                     (1+ (type-bound-number low))
2094                     low)
2095                   (if (consp high)
2096                     (1- (type-bound-number high))
2097                     high)))
2098          (t 
2099           ;; no canonicalization necessary
2100           (values low high)))
2101      (when (and (eq class 'rational)
2102                 (integerp canonical-low)
2103                 (integerp canonical-high)
2104                 (= canonical-low canonical-high))
2105        (setf class 'integer))
2106      (%istruct 'numeric-ctype
2107                (type-class-or-lose 'number)
2108                enumerable
2109                class
2110                format
2111                complexp
2112                canonical-low
2113                canonical-high
2114                predicate))))
2115   
2116
2117(defun make-numeric-ctype-predicate (ctype)
2118  (let ((class (numeric-ctype-class ctype))
2119        (lo (numeric-ctype-low ctype))
2120        (hi (numeric-ctype-high ctype)))
2121    (if (eq class 'integer)
2122      (if (and hi
2123               lo
2124               (<= hi target::target-most-positive-fixnum)
2125               (>= lo target::target-most-negative-fixnum))     
2126        #'(lambda (n)
2127            (and (fixnump n)
2128                 (locally (declare (fixnum n hi lo))
2129                   (and (%i>= n lo)
2130                        (%i<= n hi)))))))))
2131
2132(defun numeric-ctype-p (x)
2133  (istruct-typep x 'numeric-ctype))
2134
2135(setf (type-predicate 'numeric-ctype) 'numeric-ctype-p)
2136
2137(define-type-method (number :simple-=) (type1 type2)
2138  (values
2139   (and (eq (numeric-ctype-class type1) (numeric-ctype-class type2))
2140        (eq (numeric-ctype-format type1) (numeric-ctype-format type2))
2141        (eq (numeric-ctype-complexp type1) (numeric-ctype-complexp type2))
2142        (equalp (numeric-ctype-low type1) (numeric-ctype-low type2))
2143        (equalp (numeric-ctype-high type1) (numeric-ctype-high type2)))
2144   t))
2145
2146(define-type-method (number :unparse) (type)
2147  (let* ((complexp (numeric-ctype-complexp type))
2148         (low (numeric-ctype-low type))
2149         (high (numeric-ctype-high type))
2150         (base (case (numeric-ctype-class type)
2151                 (integer 'integer)
2152                 (rational 'rational)
2153                 (float (or (numeric-ctype-format type) 'float))
2154                 (t 'real))))
2155    (let ((base+bounds
2156           (cond ((and (eq base 'integer) high low)
2157                  (let ((high-count (logcount high))
2158                        (high-length (integer-length high)))
2159                    (cond ((= low 0)
2160                           (cond ((= high 0) '(integer 0 0))
2161                                 ((= high 1) 'bit)
2162                                 ((and (= high-count high-length)
2163                                       (plusp high-length))
2164                                  `(unsigned-byte ,high-length))
2165                                 (t
2166                                  `(mod ,(1+ high)))))
2167                          ((and (= low target::target-most-negative-fixnum)
2168                                (= high target::target-most-positive-fixnum))
2169                           'fixnum)
2170                          ((and (= low (lognot high))
2171                                (= high-count high-length)
2172                                (> high-count 0))
2173                           `(signed-byte ,(1+ high-length)))
2174                          (t
2175                           `(integer ,low ,high)))))
2176                 (high `(,base ,(or low '*) ,high))
2177                 (low
2178                  (if (and (eq base 'integer) (= low 0))
2179                      'unsigned-byte
2180                      `(,base ,low)))
2181                 (t base))))
2182      (ecase complexp
2183        (:real
2184         base+bounds)
2185        (:complex
2186         (if (eq base+bounds 'real)
2187             'complex
2188             `(complex ,base+bounds)))
2189        ((nil)
2190         (assert (eq base+bounds 'real))
2191         'number)))))
2192
2193;;; Numeric-Bound-Test  --  Internal
2194;;;
2195;;;    Return true if X is "less than or equal" to Y, taking open bounds into
2196;;; consideration.  Closed is the predicate used to test the bound on a closed
2197;;; interval (e.g. <=), and Open is the predicate used on open bounds (e.g. <).
2198;;; Y is considered to be the outside bound, in the sense that if it is
2199;;; infinite (NIL), then the test suceeds, whereas if X is infinite, then the
2200;;; test fails (unless Y is also infinite).
2201;;;
2202;;;    This is for comparing bounds of the same kind, e.g. upper and upper.
2203;;; Use Numeric-Bound-Test* for different kinds of bounds.
2204;;;
2205(defmacro numeric-bound-test (x y closed open)
2206  `(cond ((not ,y) t)
2207           ((not ,x) nil)
2208           ((consp ,x)
2209            (if (consp ,y)
2210              (,closed (car ,x) (car ,y))
2211              (,closed (car ,x) ,y)))
2212           (t
2213            (if (consp ,y)
2214              (,open ,x (car ,y))
2215              (,closed ,x ,y)))))
2216
2217;;; Numeric-Bound-Test*  --  Internal
2218;;;
2219;;;    Used to compare upper and lower bounds.  This is different from the
2220;;; same-bound case:
2221;;; -- Since X = NIL is -infinity, whereas y = NIL is +infinity, we return true
2222;;;    if *either* arg is NIL.
2223;;; -- an open inner bound is "greater" and also squeezes the interval, causing
2224;;;    us to use the Open test for those cases as well.
2225;;;
2226(defmacro numeric-bound-test* (x y closed open)
2227  `(cond ((not ,y) t)
2228         ((not ,x) t)
2229         ((consp ,x)
2230          (if (consp ,y)
2231              (,open (car ,x) (car ,y))
2232              (,open (car ,x) ,y)))
2233         (t
2234          (if (consp ,y)
2235              (,open ,x (car ,y))
2236              (,closed ,x ,y)))))
2237
2238;;; Numeric-Bound-Max  --  Internal
2239;;;
2240;;;    Return whichever of the numeric bounds X and Y is "maximal" according to
2241;;; the predicates Closed (e.g. >=) and Open (e.g. >).  This is only meaningful
2242;;; for maximizing like bounds, i.e. upper and upper.  If Max-P is true, then
2243;;; we return NIL if X or Y is NIL, otherwise we return the other arg.
2244;;;
2245(defmacro numeric-bound-max (x y closed open max-p)
2246  (once-only ((n-x x)
2247              (n-y y))
2248    `(cond
2249      ((not ,n-x) ,(if max-p nil n-y))
2250      ((not ,n-y) ,(if max-p nil n-x))
2251      ((consp ,n-x)
2252       (if (consp ,n-y)
2253         (if (,closed (car ,n-x) (car ,n-y)) ,n-x ,n-y)
2254         (if (,open (car ,n-x) ,n-y) ,n-x ,n-y)))
2255      (t
2256       (if (consp ,n-y)
2257         (if (,open (car ,n-y) ,n-x) ,n-y ,n-x)
2258         (if (,closed ,n-y ,n-x) ,n-y ,n-x))))))
2259
2260
2261(define-type-method (number :simple-subtypep) (type1 type2)
2262  (let ((class1 (numeric-ctype-class type1))
2263          (class2 (numeric-ctype-class type2))
2264          (complexp2 (numeric-ctype-complexp type2))
2265          (format2 (numeric-ctype-format type2))
2266          (low1 (numeric-ctype-low type1))
2267          (high1 (numeric-ctype-high type1))
2268          (low2 (numeric-ctype-low type2))
2269          (high2 (numeric-ctype-high type2)))
2270    ;;
2271    ;; If one is complex and the other isn't, they are disjoint.
2272    (cond ((not (or (eq (numeric-ctype-complexp type1) complexp2)
2273                        (null complexp2)))
2274             (values nil t))
2275            ;;
2276            ;; If the classes are specified and different, the types are
2277            ;; disjoint unless type2 is rational and type1 is integer.
2278            ((not (or (eq class1 class2) (null class2)
2279                        (and (eq class1 'integer) (eq class2 'rational))))
2280             (values nil t))
2281            ;;
2282            ;; If the float formats are specified and different, the types
2283            ;; are disjoint.
2284            ((not (or (eq (numeric-ctype-format type1) format2)
2285                        (null format2)))
2286             (values nil t))
2287            ;;
2288            ;; Check the bounds.
2289            ((and (numeric-bound-test low1 low2 >= >)
2290                    (numeric-bound-test high1 high2 <= <))
2291             (values t t))
2292            (t
2293             (values nil t)))))
2294
2295;(define-superclasses number (generic-number))
2296
2297;;; NUMERIC-TYPES-ADJACENT  --  Internal
2298;;;
2299;;;    If the high bound of Low is adjacent to the low bound of High, then
2300;;; return T, otherwise NIL.
2301;;;
2302(defun numeric-types-adjacent (low high)
2303  (let ((low-bound (numeric-ctype-high low))
2304        (high-bound (numeric-ctype-low high)))
2305    (cond ((not (and low-bound high-bound)) nil)
2306            ((consp low-bound)
2307             (eql (car low-bound) high-bound))
2308            ((consp high-bound)
2309             (eql (car high-bound) low-bound))
2310            ((and (eq (numeric-ctype-class low) 'integer)
2311                    (eq (numeric-ctype-class high) 'integer))
2312             (eql (1+ low-bound) high-bound))
2313            (t
2314             nil))))
2315
2316;;;
2317;;; Return a numeric type that is a supertype for both type1 and type2.
2318;;;
2319(define-type-method (number :simple-union) (type1 type2)
2320  (declare (type numeric-ctype type1 type2))
2321  (cond ((csubtypep type1 type2) type2)
2322        ((csubtypep type2 type1) type1)
2323        (t
2324         (let ((class1 (numeric-ctype-class type1))
2325               (format1 (numeric-ctype-format type1))
2326               (complexp1 (numeric-ctype-complexp type1))
2327               (class2 (numeric-ctype-class type2))
2328               (format2 (numeric-ctype-format type2))
2329               (complexp2 (numeric-ctype-complexp type2)))
2330           (cond
2331             ((and (eq class1 class2)
2332                   (eq format1 format2)
2333                   (eq complexp1 complexp2)
2334                   (or (numeric-types-intersect type1 type2)
2335                       (numeric-types-adjacent type1 type2)
2336                       (numeric-types-adjacent type2 type1)))
2337              (make-numeric-ctype
2338               :class class1
2339               :format format1
2340               :complexp complexp1
2341               :low (numeric-bound-max (numeric-ctype-low type1)
2342                                       (numeric-ctype-low type2)
2343                                       <= < t)
2344               :high (numeric-bound-max (numeric-ctype-high type1)
2345                                        (numeric-ctype-high type2)
2346                                        >= > t)))
2347             ;; FIXME: These two clauses are almost identical, and the
2348             ;; consequents are in fact identical in every respect.
2349             ((and (eq class1 'rational)
2350                   (eq class2 'integer)
2351                   (eq format1 format2)
2352                   (eq complexp1 complexp2)
2353                   (integerp (numeric-ctype-low type2))
2354                   (integerp (numeric-ctype-high type2))
2355                   (= (numeric-ctype-low type2) (numeric-ctype-high type2))
2356                   (or (numeric-types-adjacent type1 type2)
2357                       (numeric-types-adjacent type2 type1)))
2358              (make-numeric-ctype
2359               :class 'rational
2360               :format format1
2361               :complexp complexp1
2362               :low (numeric-bound-max (numeric-ctype-low type1)
2363                                       (numeric-ctype-low type2)
2364                                       <= < t)
2365               :high (numeric-bound-max (numeric-ctype-high type1)
2366                                        (numeric-ctype-high type2)
2367                                        >= > t)))
2368             ((and (eq class1 'integer)
2369                   (eq class2 'rational)
2370                   (eq format1 format2)
2371                   (eq complexp1 complexp2)
2372                   (integerp (numeric-ctype-low type1))
2373                   (integerp (numeric-ctype-high type1))
2374                   (= (numeric-ctype-low type1) (numeric-ctype-high type1))
2375                   (or (numeric-types-adjacent type1 type2)
2376                       (numeric-types-adjacent type2 type1)))
2377              (make-numeric-ctype
2378               :class 'rational
2379               :format format1
2380               :complexp complexp1
2381               :low (numeric-bound-max (numeric-ctype-low type1)
2382                                       (numeric-ctype-low type2)
2383                                       <= < t)
2384               :high (numeric-bound-max (numeric-ctype-high type1)
2385                                        (numeric-ctype-high type2)
2386                                        >= > t)))
2387             (t nil))))))
2388
2389(setf (info-type-kind 'number) :primitive
2390      (info-type-builtin 'number) (make-numeric-ctype :complexp nil))
2391
2392(def-type-translator complex (&optional spec &environment env)
2393  (if (eq spec '*)
2394      (make-numeric-ctype :complexp :complex)
2395      (labels ((not-numeric ()
2396                 (error "Component type for Complex is not numeric: ~S." spec))
2397               (not-real ()
2398                 (error "Component type for Complex is not a subtype of real: ~S." spec))
2399               (complex1 (component-type)
2400                 (unless (numeric-ctype-p component-type)
2401                   (not-numeric))
2402                 (when (eq (numeric-ctype-complexp component-type) :complex)
2403                   (not-real))
2404                 (let ((res (copy-uvector component-type)))
2405                   (setf (numeric-ctype-complexp res) :complex)
2406                   (setf (numeric-ctype-predicate res) nil) ; <<
2407                   res))
2408               (do-complex (ctype)
2409                 (cond
2410                   ((eq ctype *empty-type*) *empty-type*)
2411                   ((eq ctype *universal-type*) (not-real))
2412                   ((numeric-ctype-p ctype) (complex1 ctype))
2413                   ((union-ctype-p ctype)
2414                    (apply #'type-union
2415                           (mapcar #'do-complex (union-ctype-types ctype))))
2416                   ((member-ctype-p ctype)
2417                    (apply #'type-union
2418                           (mapcar (lambda (x) (do-complex (ctype-of x)))
2419                                   (member-ctype-members ctype))))
2420                   ((and (intersection-ctype-p ctype)
2421                         ;; just enough to handle simple types like RATIO.
2422                         (let ((numbers (remove-if-not
2423                                         #'numeric-ctype-p
2424                                         (intersection-ctype-types ctype))))
2425                           (and (car numbers)
2426                                (null (cdr numbers))
2427                                (eq (numeric-ctype-complexp (car numbers)) :real)
2428                                (complex1 (car numbers))))))
2429                   (t                   ; punt on harder stuff for now
2430                    (not-real)))))
2431        (let ((ctype (specifier-type spec env)))
2432          (do-complex ctype)))))
2433
2434;;; Check-Bound  --  Internal
2435;;;
2436;;;    Check that X is a well-formed numeric bound of the specified Type.
2437;;; If X is *, return NIL, otherwise return the bound.
2438;;;
2439(defmacro check-bound (x type)
2440  `(cond ((eq ,x '*) nil)
2441           ((or (typep ,x ',type)
2442                (and (consp ,x) (typep (car ,x) ',type) (null (cdr ,x))))
2443            ,x)
2444           (t
2445            (error "Bound is not *, a ~A or a list of a ~A: ~S" ',type ',type ,x))))
2446
2447(def-type-translator integer (&optional low high)
2448  (let* ((l (check-bound low integer))
2449         (lb (if (consp l) (1+ (car l)) l))
2450         (h (check-bound high integer))
2451         (hb (if (consp h) (1- (car h)) h)))
2452    (if (and hb lb (< hb lb))
2453      *empty-type*
2454      (make-numeric-ctype :class 'integer  :complexp :real
2455                          :enumerable (not (null (and l h)))
2456                          :low lb
2457                          :high hb))))
2458
2459(deftype mod (n)
2460  (unless (and (integerp n) (> n 0))
2461    (error "Bad N specified for MOD type specifier: ~S." n))
2462  `(integer 0 ,(1- n)))
2463
2464
2465(defmacro def-bounded-type (type class format)
2466  `(def-type-translator ,type (&optional low high)
2467     (let ((lb (check-bound low ,type))
2468             (hb (check-bound high ,type)))
2469       (unless (numeric-bound-test* lb hb <= <)
2470           (error "Lower bound ~S is not less than upper bound ~S." low high))
2471       (make-numeric-ctype :class ',class :format ',format :low lb :high hb))))
2472
2473(def-bounded-type rational rational nil)
2474
2475(defun coerce-bound (bound type inner-coerce-bound-fun)
2476  (declare (type function inner-coerce-bound-fun))
2477  (cond ((eql bound '*)
2478         bound)
2479        ((consp bound)
2480         (destructuring-bind (inner-bound) bound
2481           (list (funcall inner-coerce-bound-fun inner-bound type))))
2482        (t
2483         (funcall inner-coerce-bound-fun bound type))))
2484
2485(defun inner-coerce-real-bound (bound type)
2486  (ecase type
2487    (rational (rationalize bound))
2488    (float (if (floatp bound)
2489               bound
2490               ;; Coerce to the widest float format available, to
2491               ;; avoid unnecessary loss of precision:
2492               (coerce bound 'long-float)))))
2493
2494(defun coerced-real-bound (bound type)
2495  (coerce-bound bound type #'inner-coerce-real-bound))
2496
2497(defun coerced-float-bound (bound type)
2498  (coerce-bound bound type #'coerce))
2499
2500#|
2501(def-type-translator real (&optional (low '*) (high '*))
2502  (specifier-type `(or (float ,(coerced-real-bound  low 'float)
2503                              ,(coerced-real-bound high 'float))
2504                       (rational ,(coerced-real-bound  low 'rational)
2505                                 ,(coerced-real-bound high 'rational)))))
2506
2507(def-type-translator float (&optional (low '*) (high '*))
2508  (specifier-type
2509   `(or (single-float ,(coerced-float-bound  low 'single-float)
2510                      ,(coerced-float-bound high 'single-float))
2511        (double-float ,(coerced-float-bound  low 'double-float)
2512                      ,(coerced-float-bound high 'double-float)))))
2513|#
2514
2515(def-bounded-type float float nil)
2516(def-bounded-type real nil nil)
2517
2518(defmacro define-float-format (f)
2519  `(def-bounded-type ,f float ,f))
2520
2521(define-float-format short-float)
2522(define-float-format single-float)
2523(define-float-format double-float)
2524(define-float-format long-float)
2525
2526(defun numeric-types-intersect (type1 type2)
2527  (declare (type numeric-ctype type1 type2))
2528  (let* ((class1 (numeric-ctype-class type1))
2529         (class2 (numeric-ctype-class type2))
2530         (complexp1 (numeric-ctype-complexp type1))
2531         (complexp2 (numeric-ctype-complexp type2))
2532         (format1 (numeric-ctype-format type1))
2533         (format2 (numeric-ctype-format type2))
2534         (low1 (numeric-ctype-low type1))
2535         (high1 (numeric-ctype-high type1))
2536         (low2 (numeric-ctype-low type2))
2537         (high2 (numeric-ctype-high type2)))
2538    ;;
2539    ;; If one is complex and the other isn't, then they are disjoint.
2540    (cond ((not (or (eq complexp1 complexp2)
2541                    (null complexp1) (null complexp2)))
2542           nil)
2543          ;;
2544          ;; If either type is a float, then the other must either be specified
2545          ;; to be a float or unspecified.  Otherwise, they are disjoint.
2546          ((and (eq class1 'float) (not (member class2 '(float nil)))) nil)
2547          ((and (eq class2 'float) (not (member class1 '(float nil)))) nil)
2548          ;;
2549          ;; If the float formats are specified and different, the types
2550          ;; are disjoint.
2551          ((not (or (eq format1 format2) (null format1) (null format2)))
2552           nil)
2553          (t
2554           ;;
2555           ;; Check the bounds.  This is a bit odd because we must always have
2556           ;; the outer bound of the interval as the second arg.
2557           (if (numeric-bound-test high1 high2 <= <)
2558             (or (and (numeric-bound-test low1 low2 >= >)
2559                      (numeric-bound-test* low1 high2 <= <))
2560                 (and (numeric-bound-test low2 low1 >= >)
2561                      (numeric-bound-test* low2 high1 <= <)))
2562             (or (and (numeric-bound-test* low2 high1 <= <)
2563                      (numeric-bound-test low2 low1 >= >))
2564                 (and (numeric-bound-test high2 high1 <= <)
2565                      (numeric-bound-test* high2 low1 >= >))))))))
2566
2567;;; Round-Numeric-Bound  --  Internal
2568;;;
2569;;;    Take the numeric bound X and convert it into something that can be used
2570;;; as a bound in a numeric type with the specified Class and Format.  If up-p
2571;;; is true, then we round up as needed, otherwise we round down.  Up-p true
2572;;; implies that X is a lower bound, i.e. (N) > N.
2573;;;
2574;;; This is used by Numeric-Type-Intersection to mash the bound into the
2575;;; appropriate type number.  X may only be a float when Class is Float.
2576;;;
2577;;; ### Note: it is possible for the coercion to a float to overflow or
2578;;; underflow.  This happens when the bound doesn't fit in the specified
2579;;; format.  In this case, we should really return the appropriate
2580;;; {Most | Least}-{Positive | Negative}-XXX-Float float of desired format.
2581;;; But these conditions aren't currently signalled in any useful way.
2582;;;
2583;;; Also, when converting an open rational bound into a float we should
2584;;; probably convert it to a closed bound of the closest float in the specified
2585;;; format.  In general, open float bounds are fucked.
2586;;;
2587(defun round-numeric-bound (x class format up-p)
2588  (if x
2589    (let ((cx (if (consp x) (car x) x)))
2590        (ecase class
2591          ((nil rational) x)
2592          (integer
2593           (if (and (consp x) (integerp cx))
2594             (if up-p (1+ cx) (1- cx))
2595             (if up-p (ceiling cx) (floor cx))))
2596          (float
2597           (let ((res (if format (coerce cx format) (float cx))))
2598             (if (consp x) (list res) res)))))
2599    nil))
2600
2601;;; Number :Simple-Intersection type method  --  Internal
2602;;;
2603;;;    Handle the case of Type-Intersection on two numeric types.  We use
2604;;; Types-Intersect to throw out the case of types with no intersection.  If an
2605;;; attribute in Type1 is unspecified, then we use Type2's attribute, which
2606;;; must be at least as restrictive.  If the types intersect, then the only
2607;;; attributes that can be specified and different are the class and the
2608;;; bounds.
2609;;;
2610;;;    When the class differs, we use the more restrictive class.  The only
2611;;; interesting case is rational/integer, since rational includes integer.
2612;;;
2613;;;    We make the result lower (upper) bound the maximum (minimum) of the
2614;;; argument lower (upper) bounds.  We convert the bounds into the
2615;;; appropriate numeric type before maximizing.  This avoids possible confusion
2616;;; due to mixed-type comparisons (but I think the result is the same).
2617;;;
2618(define-type-method (number :simple-intersection) (type1 type2)
2619  (declare (type numeric-ctype type1 type2))
2620  (if (numeric-types-intersect type1 type2)
2621    (let* ((class1 (numeric-ctype-class type1))
2622           (class2 (numeric-ctype-class type2))
2623           (class (ecase class1
2624                    ((nil) class2)
2625                    ((integer float) class1)
2626                    (rational (if (eq class2 'integer) 'integer 'rational))))
2627           (format (or (numeric-ctype-format type1)
2628                       (numeric-ctype-format type2))))
2629      (make-numeric-ctype
2630       :class class
2631       :format format
2632       :complexp (or (numeric-ctype-complexp type1)
2633                     (numeric-ctype-complexp type2))
2634       :low (numeric-bound-max
2635             (round-numeric-bound (numeric-ctype-low type1)
2636                                  class format t)
2637             (round-numeric-bound (numeric-ctype-low type2)
2638                                  class format t)
2639             > >= nil)
2640       :high (numeric-bound-max
2641              (round-numeric-bound (numeric-ctype-high type1)
2642                                   class format nil)
2643              (round-numeric-bound (numeric-ctype-high type2)
2644                                   class format nil)
2645              < <= nil)))
2646    *empty-type*))
2647
2648;;; Float-Format-Max  --  Interface
2649;;;
2650;;;    Given two float formats, return the one with more precision.  If either
2651;;; one is null, return NIL.
2652;;;
2653(defun float-format-max (f1 f2)
2654  (when (and f1 f2)
2655    (dolist (f float-formats (error "Bad float format: ~S." f1))
2656      (when (or (eq f f1) (eq f f2))
2657          (return f)))))
2658
2659
2660;;; Numeric-Contagion  --  Interface
2661;;;
2662;;;    Return the result of an operation on Type1 and Type2 according to the
2663;;; rules of numeric contagion.  This is always NUMBER, some float format
2664;;; (possibly complex) or RATIONAL.  Due to rational canonicalization, there
2665;;; isn't much we can do here with integers or rational complex numbers.
2666;;;
2667;;;    If either argument is not a Numeric-Type, then return NUMBER.  This is
2668;;; useful mainly for allowing types that are technically numbers, but not a
2669;;; Numeric-Type.
2670;;;
2671(defun numeric-contagion (type1 type2)
2672  (if (and (numeric-ctype-p type1) (numeric-ctype-p type2))
2673    (let ((class1 (numeric-ctype-class type1))
2674            (class2 (numeric-ctype-class type2))
2675            (format1 (numeric-ctype-format type1))
2676            (format2 (numeric-ctype-format type2))
2677            (complexp1 (numeric-ctype-complexp type1))
2678            (complexp2 (numeric-ctype-complexp type2)))
2679        (cond ((or (null complexp1)
2680                   (null complexp2))
2681               (specifier-type 'number))
2682              ((eq class1 'float)
2683               (make-numeric-ctype
2684                  :class 'float
2685                  :format (ecase class2
2686                              (float (float-format-max format1 format2))
2687                              ((integer rational) format1)
2688                              ((nil)
2689                               ;; A double-float with any real number is a
2690                               ;; double-float.
2691                               (if (eq format1 'double-float)
2692                                 'double-float
2693                                 nil)))
2694                  :complexp (if (or (eq complexp1 :complex)
2695                                    (eq complexp2 :complex))
2696                              :complex
2697                              :real)))
2698              ((eq class2 'float) (numeric-contagion type2 type1))
2699              ((and (eq complexp1 :real) (eq complexp2 :real))
2700               (make-numeric-ctype
2701                  :class (and class1 class2 'rational)
2702                  :complexp :real))
2703              (t
2704               (specifier-type 'number))))
2705    (specifier-type 'number)))
2706
2707
2708
2709
2710;;;; Array types:
2711
2712;;; The Array-Type is used to represent all array types, including things such
2713;;; as SIMPLE-STRING.
2714;;;
2715
2716(defun make-array-ctype (&key
2717                         (dimensions '*)
2718                         (complexp '*)
2719                         element-type
2720                         (specialized-element-type *wild-type*))
2721  (%istruct 'array-ctype
2722            (type-class-or-lose 'array)
2723            nil
2724            dimensions
2725            complexp
2726            element-type
2727            specialized-element-type
2728            (unless (eq specialized-element-type *wild-type*)
2729              (ctype-subtype specialized-element-type))))
2730
2731(defun array-ctype-p (x) (istruct-typep x 'array-ctype))
2732(setf (type-predicate 'array-ctype) 'array-ctype-p)
2733
2734;;; Specialized-Element-Type-Maybe  --  Internal
2735;;;
2736;;;      What this does depends on the setting of the
2737;;; *use-implementation-types* switch.  If true, return the specialized element
2738;;; type, otherwise return the original element type.
2739;;;
2740(defun specialized-element-type-maybe (type)
2741  (declare (type array-ctype type))
2742  (if *use-implementation-types*
2743    (array-ctype-specialized-element-type type)
2744    (array-ctype-element-type type)))
2745
2746(define-type-method (array :simple-=) (type1 type2)
2747  (if (or (unknown-ctype-p (array-ctype-element-type type1))
2748          (unknown-ctype-p (array-ctype-element-type type2)))
2749    (multiple-value-bind (equalp certainp)
2750        (type= (array-ctype-element-type type1)
2751               (array-ctype-element-type type2))
2752      (assert (not (and (not equalp) certainp)))
2753      (values equalp certainp))
2754    (values (and (equal (array-ctype-dimensions type1)
2755                        (array-ctype-dimensions type2))
2756                 (eq (array-ctype-complexp type1)
2757                     (array-ctype-complexp type2))
2758                 (type= (specialized-element-type-maybe type1)
2759                        (specialized-element-type-maybe type2)))
2760            t)))
2761
2762(define-type-method (array :unparse) (type)
2763  (let ((dims (array-ctype-dimensions type))
2764          (eltype (type-specifier (array-ctype-element-type type)))
2765          (complexp (array-ctype-complexp type)))
2766    (cond ((eq dims '*)
2767             (if (eq eltype '*)
2768               (if complexp 'array 'simple-array)
2769               (if complexp `(array ,eltype) `(simple-array ,eltype))))
2770            ((= (length dims) 1) 
2771             (if complexp
2772               (if (eq (car dims) '*)
2773                   (case eltype
2774                     (bit 'bit-vector)
2775                     ((character base-char) 'base-string)
2776                     (* 'vector)
2777                     (t `(vector ,eltype)))
2778                   (case eltype
2779                     (bit `(bit-vector ,(car dims)))
2780                     ((character base-char) `(base-string ,(car dims)))
2781                     (t `(vector ,eltype ,(car dims)))))
2782               (if (eq (car dims) '*)
2783                   (case eltype
2784                     (bit 'simple-bit-vector)
2785                     ((base-char character) 'simple-base-string)
2786                     ((t) 'simple-vector)
2787                     (t `(simple-array ,eltype (*))))
2788                   (case eltype
2789                     (bit `(simple-bit-vector ,(car dims)))
2790                     ((base-char character) `(simple-base-string ,(car dims)))
2791                     ((t) `(simple-vector ,(car dims)))
2792                     (t `(simple-array ,eltype ,dims))))))
2793            (t
2794             (if complexp
2795               `(array ,eltype ,dims)
2796               `(simple-array ,eltype ,dims))))))
2797
2798(define-type-method (array :simple-subtypep) (type1 type2)
2799  (let ((dims1 (array-ctype-dimensions type1))
2800        (dims2 (array-ctype-dimensions type2))
2801        (complexp2 (array-ctype-complexp type2)))
2802    (cond (;; not subtypep unless dimensions are compatible
2803           (not (or (eq dims2 '*)
2804                    (and (not (eq dims1 '*))
2805                         (= (length (the list dims1))
2806                            (length (the list dims2)))
2807                         (every (lambda (x y)
2808                                  (or (eq y '*) (eql x y)))
2809                                (the list dims1)
2810                                (the list dims2)))))
2811           (values nil t))
2812          ;; not subtypep unless complexness is compatible
2813          ((not (or (eq complexp2 :maybe)
2814                    (eq (array-ctype-complexp type1) complexp2)))
2815           (values nil t))
2816          ;; Since we didn't fail any of the tests above, we win
2817          ;; if the TYPE2 element type is wild.
2818          ((eq (array-ctype-element-type type2) *wild-type*)
2819           (values t t))
2820          (;; Since we didn't match any of the special cases above, we
2821           ;; can't give a good answer unless both the element types
2822           ;; have been defined.
2823           (or (unknown-ctype-p (array-ctype-element-type type1))
2824               (unknown-ctype-p (array-ctype-element-type type2)))
2825           (values nil nil))
2826          (;; Otherwise, the subtype relationship holds iff the
2827           ;; types are equal, and they're equal iff the specialized
2828           ;; element types are identical.
2829           t
2830           (values (type= (specialized-element-type-maybe type1)
2831                          (specialized-element-type-maybe type2))
2832                   t)))))
2833
2834; (define-superclasses array (string string) (vector vector) (array))
2835
2836
2837(defun array-types-intersect (type1 type2)
2838  (declare (type array-ctype type1 type2))
2839  (let ((dims1 (array-ctype-dimensions type1))
2840        (dims2 (array-ctype-dimensions type2))
2841        (complexp1 (array-ctype-complexp type1))
2842        (complexp2 (array-ctype-complexp type2)))
2843    ;; See whether dimensions are compatible.
2844    (cond ((not (or (eq dims1 '*) (eq dims2 '*)
2845                    (and (= (length dims1) (length dims2))
2846                         (every (lambda (x y)
2847                                  (or (eq x '*) (eq y '*) (= x y)))
2848                                dims1 dims2))))
2849           (values nil t))
2850          ;; See whether complexpness is compatible.
2851          ((not (or (eq complexp1 :maybe)
2852                    (eq complexp2 :maybe)
2853                    (eq complexp1 complexp2)))
2854           (values nil t))
2855          ((or (eq (array-ctype-specialized-element-type type1) *wild-type*)
2856               (eq (array-ctype-specialized-element-type type2) *wild-type*)
2857               (type= (specialized-element-type-maybe type1)
2858                      (specialized-element-type-maybe type2)))
2859           (values t t))
2860          (t
2861           (values nil t)))))
2862
2863(define-type-method (array :simple-intersection) (type1 type2)
2864  (declare (type array-ctype type1 type2))
2865  (if (array-types-intersect type1 type2)
2866    (let ((dims1 (array-ctype-dimensions type1))
2867          (dims2 (array-ctype-dimensions type2))
2868          (complexp1 (array-ctype-complexp type1))
2869          (complexp2 (array-ctype-complexp type2))
2870          (eltype1 (array-ctype-element-type type1))
2871          (eltype2 (array-ctype-element-type type2)))
2872      (specialize-array-type
2873       (make-array-ctype
2874        :dimensions (cond ((eq dims1 '*) dims2)
2875                          ((eq dims2 '*) dims1)
2876                          (t
2877                           (mapcar #'(lambda (x y) (if (eq x '*) y x))
2878                                   dims1 dims2)))
2879        :complexp (if (eq complexp1 :maybe) complexp2 complexp1)
2880        :element-type (cond
2881                        ((eq eltype1 *wild-type*) eltype2)
2882                        ((eq eltype2 *wild-type*) eltype1)
2883                        (t (type-intersection eltype1 eltype2))))))
2884      *empty-type*))
2885
2886;;; Check-Array-Dimensions  --  Internal
2887;;;
2888;;;    Check a supplied dimension list to determine if it is legal.
2889;;;
2890(defun check-array-dimensions (dims)
2891  (typecase dims
2892    ((member *) dims)
2893    (integer
2894     (when (minusp dims)
2895       (signal-program-error "Arrays can't have a negative number of dimensions: ~D." dims))
2896     (when (>= dims array-rank-limit)
2897       (signal-program-error "Array type has too many dimensions: ~S." dims))
2898     (make-list dims :initial-element '*))
2899    (list
2900     (when (>= (length dims) array-rank-limit)
2901       (signal-program-error "Array type has too many dimensions: ~S." dims))
2902     (dolist (dim dims)
2903       (unless (eq dim '*)
2904           (unless (and (integerp dim)
2905                          (>= dim 0) (< dim array-dimension-limit))
2906             (signal-program-error "Bad dimension in array type: ~S." dim))))
2907     dims)
2908    (t
2909     (signal-program-error "Array dimensions is not a list, integer or *:~%  ~S"
2910                           dims))))
2911
2912(def-type-translator array (&optional element-type dimensions &environment env)
2913  (specialize-array-type
2914   (make-array-ctype :dimensions (check-array-dimensions dimensions)
2915                     :complexp :maybe
2916                     :element-type (specifier-type element-type env))))
2917
2918(def-type-translator simple-array (&optional element-type dimensions &environment env)
2919  (specialize-array-type
2920   (make-array-ctype :dimensions (check-array-dimensions dimensions)
2921                         :element-type (specifier-type element-type env)
2922                         :complexp nil)))
2923
2924;;; Order matters here.
2925(defparameter specialized-array-element-types
2926  '(nil bit (unsigned-byte 8) (signed-byte 8) (unsigned-byte 16)
2927    (signed-byte 16) (unsigned-byte 32) #+32-bit-target fixnum (signed-byte 32)
2928    #+64-bit-target (unsigned-byte 64)
2929    #+64-bit-target fixnum
2930    #+64-bit-target (signed-byte 64)
2931    character  short-float double-float))
2932
2933(defun specialize-array-type (type)
2934  (let* ((eltype (array-ctype-element-type type))
2935         (specialized-type (if (eq eltype *wild-type*)
2936                             *wild-type*
2937                             (dolist (stype-name specialized-array-element-types
2938                                      *universal-type*)
2939                               (let ((stype (specifier-type stype-name)))
2940                                 (when (csubtypep eltype stype)
2941                                   (return stype)))))))
2942   
2943    (setf (array-ctype-specialized-element-type type) specialized-type
2944          (array-ctype-typecode type) (unless (eq specialized-type *wild-type*)
2945                                        (ctype-subtype specialized-type)))
2946    type))
2947
2948
2949;;;; Member types.
2950
2951;;; The Member-Type represents uses of the MEMBER type specifier.  We bother
2952;;; with this at this level because MEMBER types are fairly important and union
2953;;; and intersection are well defined.
2954
2955(defun %make-member-ctype (members)
2956  (%istruct 'member-ctype
2957            (type-class-or-lose 'member)
2958            t
2959            members))
2960
2961(defun make-member-ctype (&key members)
2962  (let* ((singlep (subsetp '(-0.0f0 0.0f0) members))
2963         (doublep (subsetp '(-0.0d0 0.0d0) members))
2964         (union-types
2965          (if singlep
2966            (if doublep
2967              (list *ctype-of-single-float-0* *ctype-of-double-float-0*)
2968              (list *ctype-of-single-float-0*))
2969            (if doublep
2970              (list *ctype-of-double-float-0*)))))
2971    (if union-types
2972      (progn
2973        (if singlep
2974          (setq members (set-difference '(-0.0f0 0.0f0) members)))
2975        (if doublep
2976          (setq members (set-difference '(-0.d00 0.0d0) members)))
2977        (make-union-ctype (if (null members)
2978                            union-types
2979                            (cons (%make-member-ctype members) union-types))))
2980      (%make-member-ctype members))))
2981       
2982
2983(defun member-ctype-p (x) (istruct-typep x 'member-ctype))
2984(setf (type-predicate 'member-ctype) 'member-ctype-p)
2985
2986(define-type-method (member :unparse) (type)
2987  (if (type= type (specifier-type 'standard-char))
2988    'standard-char
2989    (let ((members (member-ctype-members type)))
2990      (if (equal members '(nil))
2991        'null
2992        `(member ,@members)))))
2993
2994(define-type-method (member :simple-subtypep) (type1 type2)
2995  (values (subsetp (member-ctype-members type1) (member-ctype-members type2))
2996            t))
2997
2998
2999(define-type-method (member :complex-subtypep-arg1) (type1 type2)
3000  (every/type (swapped-args-fun #'ctypep)
3001              type2
3002              (member-ctype-members type1)))
3003
3004;;; We punt if the odd type is enumerable and intersects with the member type.
3005;;; If not enumerable, then it is definitely not a subtype of the member type.
3006;;;
3007(define-type-method (member :complex-subtypep-arg2) (type1 type2)
3008  (cond ((not (ctype-enumerable type1)) (values nil t))
3009          ((types-intersect type1 type2)
3010           (invoke-complex-subtypep-arg1-method type1 type2))
3011          (t
3012           (values nil t))))
3013
3014(define-type-method (member :simple-intersection) (type1 type2)
3015  (let ((mem1 (member-ctype-members type1))
3016        (mem2 (member-ctype-members type2)))
3017    (values (cond ((subsetp mem1 mem2) type1)
3018                  ((subsetp mem2 mem1) type2)
3019                  (t
3020                   (let ((res (intersection mem1 mem2)))
3021                     (if res
3022                       (make-member-ctype :members res)
3023                       *empty-type*))))
3024            t)))
3025
3026(define-type-method (member :complex-intersection) (type1 type2)
3027  (block PUNT
3028    (collect ((members))
3029      (let ((mem2 (member-ctype-members type2)))
3030        (dolist (member mem2)
3031          (multiple-value-bind (val win) (ctypep member type1)
3032            (unless win
3033              (return-from punt nil))
3034            (when val (members member))))
3035        (cond ((subsetp mem2 (members)) type2)
3036              ((null (members)) *empty-type*)
3037              (t
3038               (make-member-ctype :members (members))))))))
3039
3040;;; We don't need a :COMPLEX-UNION, since the only interesting case is a union
3041;;; type, and the member/union interaction is handled by the union type
3042;;; method.
3043(define-type-method (member :simple-union) (type1 type2)
3044  (let ((mem1 (member-ctype-members type1))
3045        (mem2 (member-ctype-members type2)))
3046    (cond ((subsetp mem1 mem2) type2)
3047          ((subsetp mem2 mem1) type1)
3048          (t
3049           (make-member-ctype :members (union mem1 mem2))))))
3050
3051
3052(define-type-method (member :simple-=) (type1 type2)
3053  (let ((mem1 (member-ctype-members type1))
3054        (mem2 (member-ctype-members type2)))
3055    (values (and (subsetp mem1 mem2) (subsetp mem2 mem1))
3056            t)))
3057
3058(define-type-method (member :complex-=) (type1 type2)
3059  (if (ctype-enumerable type1)
3060    (multiple-value-bind (val win)
3061                               (csubtypep type2 type1)
3062        (if (or val (not win))
3063        (values nil nil)
3064        (values nil t)))
3065    (values nil t)))
3066
3067(def-type-translator member (&rest members)
3068  (if members
3069    (collect ((non-numbers) (numbers))
3070      (dolist (m (remove-duplicates members))
3071        (if (and (numberp m)
3072                 (not (and (floatp m) (zerop m))))
3073          (numbers (ctype-of m))
3074          (non-numbers m)))
3075      (apply #'type-union
3076             (if (non-numbers)
3077               (make-member-ctype :members (non-numbers))
3078               *empty-type*)
3079             (numbers)))
3080    *empty-type*))
3081
3082
3083
3084;;;; Union types:
3085
3086;;; The Union-Type represents uses of the OR type specifier which can't be
3087;;; canonicalized to something simpler.  Canonical form:
3088;;;
3089;;; 1] There is never more than one Member-Type component.
3090;;; 2] There are never any Union-Type components.
3091;;;
3092
3093(defun make-union-ctype (types)
3094  (declare (list types))
3095  (%istruct 'union-ctype
3096            (type-class-or-lose 'union)
3097            (every #'(lambda (x) (ctype-enumerable x)) types)
3098            types))
3099
3100(defun union-ctype-p (x) (istruct-typep x 'union-ctype))
3101(setf (type-predicate 'union-ctype) 'union-ctype-p)
3102
3103
3104;;;    If List, then return that, otherwise the OR of the component types.
3105;;;
3106(define-type-method (union :unparse) (type)
3107  (declare (type ctype type))
3108    (cond
3109      ((type= type (specifier-type 'list)) 'list)
3110      ((type= type (specifier-type 'float)) 'float)
3111      ((type= type (specifier-type 'real)) 'real)
3112      ((type= type (specifier-type 'sequence)) 'sequence)
3113      ((type= type (specifier-type 'bignum)) 'bignum)
3114      (t `(or ,@(mapcar #'type-specifier (union-ctype-types type))))))
3115
3116
3117
3118(define-type-method (union :simple-=) (type1 type2)
3119  (multiple-value-bind (subtype certain?)
3120      (csubtypep type1 type2)
3121    (if subtype
3122      (csubtypep type2 type1)
3123      (if certain?
3124        (values nil t)
3125        (multiple-value-bind (subtype certain?)
3126            (csubtypep type2 type1)
3127          (declare (ignore subtype))
3128          (values nil certain?))))))
3129
3130
3131(define-type-method (union :complex-=) (type1 type2)
3132  (declare (ignore type1))
3133  (if (some #'type-might-contain-other-types-p 
3134            (union-ctype-types type2))
3135    (values nil nil)
3136    (values nil t)))
3137
3138
3139(defun union-simple-subtypep (type1 type2)
3140  (every/type (swapped-args-fun #'union-complex-subtypep-arg2)
3141              type2
3142              (union-ctype-types type1)))
3143
3144(define-type-method (union :simple-subtypep) (type1 type2)
3145  (union-simple-subtypep type1 type2))
3146
3147(defun union-complex-subtypep-arg1 (type1 type2)
3148  (every/type (swapped-args-fun #'csubtypep)
3149              type2
3150              (union-ctype-types type1)))
3151
3152(define-type-method (union :complex-subtypep-arg1) (type1 type2)
3153  (union-complex-subtypep-arg1 type1 type2))
3154
3155(defun union-complex-subtypep-arg2 (type1 type2)
3156  (multiple-value-bind (sub-value sub-certain?)
3157      (progn
3158        (assert (union-ctype-p type2))
3159        (assert (not (union-ctype-p type1)))
3160        (type= type1
3161               (apply #'type-union
3162                      (mapcar (lambda (x) (type-intersection type1 x))
3163                              (union-ctype-types type2)))))
3164    (if sub-certain?
3165      (values sub-value sub-certain?)
3166      (invoke-complex-subtypep-arg1-method type1 type2))))
3167
3168(define-type-method (union :complex-subtypep-arg2) (type1 type2)
3169  (union-complex-subtypep-arg2 type1 type2))
3170
3171(define-type-method (union :simple-intersection :complex-intersection)
3172    (type1 type2)
3173  (assert (union-ctype-p type2))
3174  (cond ((and (union-ctype-p type1)
3175              (union-simple-subtypep type1 type2)) type1)
3176        ((and (union-ctype-p type1)
3177              (union-simple-subtypep type2 type1)) type2)
3178        ((and (not (union-ctype-p type1))
3179              (union-complex-subtypep-arg2 type1 type2))
3180         type1)
3181        ((and (not (union-ctype-p type1))
3182              (union-complex-subtypep-arg1 type2 type1))
3183         type2)
3184        (t 
3185         (let ((accumulator *empty-type*))
3186           (dolist (t2 (union-ctype-types type2) accumulator)
3187             (setf accumulator
3188                   (type-union accumulator
3189                               (type-intersection type1 t2))))))))
3190
3191
3192
3193(def-type-translator or (&rest type-specifiers &environment env)
3194  (apply #'type-union
3195         (mapcar #'(lambda (spec) (specifier-type spec env)) type-specifiers)))
3196
3197
3198;;; Intersection types
3199(defun make-intersection-ctype (enumerable types)
3200  (%istruct 'intersection-ctype
3201            (type-class-or-lose 'intersection)
3202            enumerable
3203            types))
3204
3205(defun intersection-ctype-p (x)
3206  (istruct-typep x 'intersection-ctype))
3207(setf (type-predicate 'intersection-ctype) 'intersection-ctype-p)
3208
3209(define-type-method (intersection :unparse) (type)
3210  (declare (type ctype type))
3211  (or (find type '(ratio keyword) :key #'specifier-type :test #'type=)
3212      `(and ,@(mapcar #'type-specifier (intersection-ctype-types type)))))
3213
3214;;; shared machinery for type equality: true if every type in the set
3215;;; TYPES1 matches a type in the set TYPES2 and vice versa
3216(defun type=-set (types1 types2)
3217  (flet (;; true if every type in the set X matches a type in the set Y
3218         (type<=-set (x y)
3219           (declare (type list x y))
3220           (every (lambda (xelement)
3221                    (position xelement y :test #'type=))
3222                  x)))
3223    (values (and (type<=-set types1 types2)
3224                 (type<=-set types2 types1))
3225            t)))
3226
3227(define-type-method (intersection :simple-=) (type1 type2)
3228  (type=-set (intersection-ctype-types type1)
3229             (intersection-ctype-types type2)))
3230
3231(defun %intersection-complex-subtypep-arg1 (type1 type2)
3232  (type= type1 (type-intersection type1 type2)))
3233
3234(defun %intersection-simple-subtypep (type1 type2)
3235  (every/type #'%intersection-complex-subtypep-arg1
3236              type1
3237              (intersection-ctype-types type2)))
3238
3239(define-type-method (intersection :simple-subtypep) (type1 type2)
3240  (%intersection-simple-subtypep type1 type2))
3241 
3242(define-type-method (intersection :complex-subtypep-arg1) (type1 type2)
3243  (%intersection-complex-subtypep-arg1 type1 type2))
3244
3245(defun %intersection-complex-subtypep-arg2 (type1 type2)
3246  (every/type #'csubtypep type1 (intersection-ctype-types type2)))
3247
3248(define-type-method (intersection :complex-subtypep-arg2) (type1 type2)
3249  (%intersection-complex-subtypep-arg2 type1 type2))
3250
3251(define-type-method (intersection :simple-union :complex-union)
3252    (type1 type2)
3253  (assert (intersection-ctype-p type2))
3254  (cond ((and (intersection-ctype-p type1)
3255              (%intersection-simple-subtypep type1 type2)) type2)
3256        ((and (intersection-ctype-p type1)
3257              (%intersection-simple-subtypep type2 type1)) type1)
3258        ((and (not (intersection-ctype-p type1))
3259              (%intersection-complex-subtypep-arg2 type1 type2))
3260         type2)
3261        ((and (not (intersection-ctype-p type1))
3262              (%intersection-complex-subtypep-arg1 type2 type1))
3263         type1)
3264        ((and (csubtypep type2 (specifier-type 'ratio))
3265              (numeric-ctype-p type1)
3266              (csubtypep type1 (specifier-type 'integer))
3267              (csubtypep type2
3268                         (make-numeric-ctype
3269                          :class 'rational
3270                          :complexp nil
3271                          :low (if (null (numeric-ctype-low type1))
3272                                 nil
3273                                 (list (1- (numeric-ctype-low type1))))
3274                          :high (if (null (numeric-ctype-high type1))
3275                                  nil
3276                                  (list (1+ (numeric-ctype-high type1)))))))
3277         (type-union type1
3278                     (apply #'type-intersection
3279                            (remove (specifier-type '(not integer))
3280                                    (intersection-ctype-types type2)
3281                                    :test #'type=))))
3282        (t
3283         (let ((accumulator *universal-type*))
3284           (do ((t2s (intersection-ctype-types type2) (cdr t2s)))
3285               ((null t2s) accumulator)
3286             (let ((union (type-union type1 (car t2s))))
3287               (when (union-ctype-p union)
3288                 (if (and (eq accumulator *universal-type*)
3289                          (null (cdr t2s)))
3290                     (return union)
3291                     (return nil)))
3292               (setf accumulator
3293                     (type-intersection accumulator union))))))))
3294
3295(def-type-translator and (&rest type-specifiers &environment env)
3296  (apply #'type-intersection
3297         (mapcar #'(lambda (spec) (specifier-type spec env))
3298                 type-specifiers)))
3299
3300;;; cons-ctype
3301(defun wild-ctype-to-universal-ctype (c)
3302  (if (type= c *wild-type*)
3303    *universal-type*
3304    c))
3305
3306(defun make-cons-ctype (car-ctype-value cdr-ctype-value)
3307  (if (or (eq car-ctype-value *empty-type*)
3308          (eq cdr-ctype-value *empty-type*))
3309    *empty-type*
3310    (%istruct 'cons-ctype
3311              (type-class-or-lose 'cons)
3312              nil
3313              (wild-ctype-to-universal-ctype car-ctype-value)
3314              (wild-ctype-to-universal-ctype cdr-ctype-value))))
3315
3316(defun cons-ctype-p (x)
3317  (istruct-typep x 'cons-ctype))
3318
3319(setf (type-predicate 'cons-ctype) 'cons-ctype-p)
3320 
3321(def-type-translator cons (&optional (car-type-spec '*) (cdr-type-spec '*) &environment env)
3322  (make-cons-ctype (specifier-type car-type-spec env)
3323                   (specifier-type cdr-type-spec env)))
3324
3325(define-type-method (cons :unparse) (type)
3326  (let* ((car-spec (type-specifier (cons-ctype-car-ctype type)))
3327         (cdr-spec (type-specifier (cons-ctype-cdr-ctype type))))
3328    (if (and (member car-spec '(t *))
3329             (member cdr-spec '(t *)))
3330      'cons
3331      `(cons ,car-spec ,cdr-spec))))
3332
3333(define-type-method (cons :simple-=) (type1 type2)
3334  (declare (cons-ctype type1 type2))
3335  (and (type= (cons-ctype-car-ctype type1) (cons-ctype-car-ctype type2))
3336       (type= (cons-ctype-cdr-ctype type1) (cons-ctype-cdr-ctype type2))))
3337
3338(define-type-method (cons :simple-subtypep) (type1 type2)
3339  (declare (cons-ctype type1 type2))
3340  (multiple-value-bind (val-car win-car)
3341      (csubtypep (cons-ctype-car-ctype type1) (cons-ctype-car-ctype type2))
3342    (multiple-value-bind (val-cdr win-cdr)
3343        (csubtypep (cons-ctype-cdr-ctype type1) (cons-ctype-cdr-ctype type2))
3344      (if (and val-car val-cdr)
3345        (values t (and win-car win-cdr))
3346        (values nil (or win-car win-cdr))))))
3347
3348(define-type-method (cons :simple-union) (type1 type2)
3349  (declare (type cons-ctype type1 type2))
3350  (let ((car-type1 (cons-ctype-car-ctype type1))
3351        (car-type2 (cons-ctype-car-ctype type2))
3352        (cdr-type1 (cons-ctype-cdr-ctype type1))
3353        (cdr-type2 (cons-ctype-cdr-ctype type2))
3354        (car-not1)
3355        (car-not2))
3356    (macrolet ((frob-car (car1 car2 cdr1 cdr2
3357                          &optional (not1 nil not1p))
3358                 `(type-union
3359                   (make-cons-ctype ,car1 (type-union ,cdr1 ,cdr2))
3360                   (make-cons-ctype
3361                    (type-intersection
3362                     ,car2
3363                     ,(if not1p
3364                          not1
3365                          `(specifier-type
3366                            `(not ,(type-specifier ,car1))))) 
3367                    ,cdr2))))
3368      (cond ((type= car-type1 car-type2)
3369             (make-cons-ctype car-type1
3370                              (type-union cdr-type1 cdr-type2)))
3371            ((type= cdr-type1 cdr-type2)
3372             (make-cons-ctype (type-union car-type1 car-type2)
3373                              cdr-type1))
3374            ((csubtypep car-type1 car-type2)
3375             (frob-car car-type1 car-type2 cdr-type1 cdr-type2))
3376            ((csubtypep car-type2 car-type1)
3377             (frob-car car-type2 car-type1 cdr-type2 cdr-type1))
3378            ;; more general case of the above, but harder to compute
3379            ((progn
3380               (setf car-not1 (specifier-type
3381                               `(not ,(type-specifier car-type1))))
3382               (not (csubtypep car-type2 car-not1)))
3383             (frob-car car-type1 car-type2 cdr-type1 cdr-type2 car-not1))
3384            ((progn
3385               (setf car-not2 (specifier-type
3386                               `(not ,(type-specifier car-type2))))
3387               (not (csubtypep car-type1 car-not2)))
3388             (frob-car car-type2 car-type1 cdr-type2 cdr-type1 car-not2))))))
3389           
3390(define-type-method (cons :simple-intersection) (type1 type2)
3391  (declare (type cons-ctype type1 type2))
3392  (let ((car-int2 (type-intersection2 (cons-ctype-car-ctype type1)
3393                                      (cons-ctype-car-ctype type2)))
3394        (cdr-int2 (type-intersection2 (cons-ctype-cdr-ctype type1)
3395                                      (cons-ctype-cdr-ctype type2))))
3396    (cond ((and car-int2 cdr-int2)
3397           (make-cons-ctype car-int2 cdr-int2))
3398          (car-int2
3399           (make-cons-ctype car-int2
3400                            (type-intersection (cons-ctype-cdr-ctype type1)
3401                                               (cons-ctype-cdr-ctype type2))))
3402          (cdr-int2
3403           (make-cons-ctype (type-intersection (cons-ctype-car-ctype type1)
3404                                               (cons-ctype-car-ctype type2))
3405                            cdr-int2)))))
3406
3407
3408;;; An UNKNOWN-TYPE is a type not known to the type system (not yet defined).
3409;;; We make this distinction since we don't want to complain about types that
3410;;; are hairy but defined.
3411;;;
3412
3413(defun make-unknown-ctype (&key specifier (enumerable t))
3414  (%istruct 'unknown-ctype
3415            (type-class-or-lose 'hairy)
3416            enumerable
3417            specifier))
3418
3419(defun unknown-ctype-p (x)
3420  (istruct-typep x 'unknown-ctype))
3421
3422(setf (type-predicate 'unknown-ctype) 'unknown-ctype-p)
3423
3424
3425
3426
3427
3428;;;; foreign-type types
3429
3430
3431(defun %make-foreign-ctype (foreign-type)
3432  (%istruct 'foreign-ctype
3433            (type-class-or-lose 'foreign)
3434            nil
3435            foreign-type))
3436
3437(defun foreign-ctype-p (x) (istruct-typep x 'foreign-ctype))
3438(setf (type-predicate 'foreign-ctype) 'foreign-ctype-p)
3439
3440(define-type-method (foreign :unparse) (type)
3441  `(foreign ,(unparse-foreign-type (foreign-ctype-foreign-type type))))
3442
3443(define-type-method (foreign :simple-subtypep) (type1 type2)
3444  (values (foreign-subtype-p (foreign-ctype-foreign-type type1)
3445                                   (foreign-ctype-foreign-type type2))
3446            t))
3447
3448;(define-superclasses foreign (foreign-value))
3449
3450(define-type-method (foreign :simple-=) (type1 type2)
3451  (let ((foreign-type-1 (foreign-ctype-foreign-type type1))
3452          (foreign-type-2 (foreign-ctype-foreign-type type2)))
3453    (values (or (eq foreign-type-1 foreign-type-2)
3454                    (foreign-type-= foreign-type-1 foreign-type-2))
3455              t)))
3456
3457(def-type-translator foreign (&optional (foreign-type nil))
3458  (typecase foreign-type
3459    (null
3460     (make-foreign-ctype))
3461    (foreign-type
3462     (make-foreign-ctype foreign-type))
3463    (t
3464     (make-foreign-ctype (parse-foreign-type foreign-type)))))
3465
3466(defun make-foreign-ctype (&optional foreign-type)
3467  (if foreign-type
3468      (let ((lisp-rep-type (compute-lisp-rep-type foreign-type)))
3469        (if lisp-rep-type
3470            (specifier-type lisp-rep-type)
3471            (%make-foreign-ctype foreign-type)))
3472      *universal-type*))
3473
3474
3475;;; CLASS-CTYPES are supposed to help integrate CLOS and the CMU type system.
3476;;; They mostly just contain a backpointer to the CLOS class; the CPL is then
3477;;;  used to resolve type relationships.
3478
3479(defun class-ctype-p (x) (istruct-typep x 'class-ctype))
3480(setf (type-predicate 'class-ctype) 'class-ctype-p)
3481
3482(defun args-ctype-p (x) (and (eql (typecode x) target::subtag-istruct)
3483                             (member (istruct-type-name x)
3484                                     '(args-ctype values-ctype function-ctype))))
3485
3486(setf (type-predicate 'args-ctype) 'args-ctype-p
3487      (type-predicate 'function-ctype) 'function-ctype-p
3488      (type-predicate 'values-ctype) 'values-ctype-p)
3489
3490
3491;;; Simple methods for TYPE= and SUBTYPEP should never be called when the two
3492;;; classes are equal, since there are EQ checks in those operations.
3493;;;
3494(define-type-method (class :simple-=) (type1 type2)
3495  (assert (not (eq type1 type2)))
3496  (values nil t))
3497
3498(define-type-method (class :simple-subtypep) (type1 type2)
3499  (assert (not (eq type1 type2)))
3500  (let* ((class1 (if (class-ctype-p type1) (class-ctype-class type1)))
3501         (class2 (if (class-ctype-p type2) (class-ctype-class type2))))
3502    (if (and class1 class2)
3503      (let* ((ordinal2 (%class-ordinal class2))
3504             (wrapper1 (%class.own-wrapper class1))
3505             (bits1 (if wrapper1 (%wrapper-cpl-bits wrapper1))))
3506        (if bits1
3507          (locally (declare (simple-bit-vector bits1)
3508                            (optimize (speed 3) (safety 0)))
3509            (values (if (< ordinal2 (length bits1))
3510                      (not (eql 0 (sbit bits1 ordinal2))))
3511                    t))
3512          (if (%standard-instance-p class1)
3513            (if (memq class2 (%class.local-supers class1))
3514              (values t t)
3515              (if (eq (%class-of-instance class1)
3516                      *forward-referenced-class-class*)
3517                (values nil nil)
3518                ;; %INITED-CLASS-CPL will return NIL if class1 can't
3519                ;; be finalized; in that case, we don't know the answer.
3520                (let ((supers (%inited-class-cpl class1)))
3521                  (if (memq class2 supers)
3522                    (values t t)
3523                    (values nil (not (null supers)))))))
3524            (values nil t))))
3525      (values nil t))))
3526
3527(defun find-class-intersection (c1 c2)
3528  (labels ((walk-subclasses (class f)
3529             (dolist (sub (class-direct-subclasses class))
3530               (walk-subclasses sub f))
3531             (funcall f class)))
3532    (let* ((intersection nil))
3533      (walk-subclasses c1 #'(lambda (c)
3534                              (when (subclassp c c2)
3535                                (pushnew (%class.ctype c) intersection))))
3536      (when intersection
3537        (%type-union intersection)))))
3538
3539(define-type-method (class :simple-intersection) (type1 type2)
3540  (assert (not (eq type1 type2)))
3541  (let* ((class1 (if (class-ctype-p type1) (class-ctype-class type1)))
3542         (class2 (if (class-ctype-p type2) (class-ctype-class type2))))
3543    (if (and class1
3544             (not (typep class1 'compile-time-class))
3545             class2
3546             (not (typep class2 'compile-time-class)))
3547      (cond ((subclassp class1 class2)
3548             type1)
3549            ((subclassp class2 class1)
3550             type2)
3551            ;;; In the STANDARD-CLASS case where neither's
3552            ;;; a subclass of the other, there may be
3553            ;;; one or mor classes that're a subclass of both.  We
3554            ;;; -could- try to find all such classes, but
3555            ;;; punt instead.
3556            (t (or (find-class-intersection class1 class2)
3557                 *empty-type*)))
3558      nil)))
3559
3560(define-type-method (class :complex-subtypep-arg2) (type1 class2)
3561  (if (and (intersection-ctype-p type1)
3562           (> (count-if #'class-ctype-p (intersection-ctype-types type1)) 1))
3563      (values nil nil)
3564      (if (function-ctype-p type1)
3565        (csubtypep (specifier-type 'function) class2)
3566        (invoke-complex-subtypep-arg1-method type1 class2 nil t))))
3567
3568(define-type-method (class :complex-subtypep-arg1) (type1 type2)
3569  (if (and (function-ctype-p type2)
3570           (eq type1 (specifier-type 'function))
3571           (function-ctype-wild-args type2)
3572           (eq *wild-type* (function-ctype-returns type2)))
3573      (values t t)
3574      (values nil t)))
3575
3576(define-type-method (class :unparse) (type)
3577  (class-name (class-ctype-class type)))
3578
3579
3580;;; TYPE-DIFFERENCE  --  Interface
3581;;;
3582;;;    Return the type that describes all objects that are in X but not in Y.
3583;;; If we can't determine this type, then return NIL.
3584;;;
3585;;;    For now, we only are clever dealing with union and member types.  If
3586;;; either type is not a union type, then we pretend that it is a union of just
3587;;; one type.  What we do is remove from X all the types that are a subtype any
3588;;; type in Y.  If any type in X intersects with a type in Y but is not a
3589;;; subtype, then we give up.
3590;;;
3591;;;    We must also special-case any member type that appears in the union.  We
3592;;; remove from X's members all objects that are TYPEP to Y.  If Y has any
3593;;; members, we must be careful that none of those members are CTYPEP to any
3594;;; of Y's non-member types.  We give up in this case, since to compute that
3595;;; difference we would have to break the type from X into some collection of
3596;;; types that represents the type without that particular element.  This seems
3597;;; too hairy to be worthwhile, given its low utility.
3598;;;
3599(defun type-difference (x y)
3600  (let ((x-types (if (union-ctype-p x) (union-ctype-types x) (list x)))
3601        (y-types (if (union-ctype-p y) (union-ctype-types y) (list y))))
3602    (collect ((res))
3603      (dolist (x-type x-types)
3604        (if (member-ctype-p x-type)
3605            (collect ((members))
3606              (dolist (mem (member-ctype-members x-type))
3607                (multiple-value-bind (val win) (ctypep mem y)
3608                  (unless win (return-from type-difference nil))
3609                  (unless val
3610                    (members mem))))
3611              (when (members)
3612                (res (make-member-ctype :members (members)))))
3613            (dolist (y-type y-types (res x-type))
3614              (multiple-value-bind (val win) (csubtypep x-type y-type)
3615                (unless win (return-from type-difference nil))
3616                (when val (return))
3617                (when (types-intersect x-type y-type)
3618                  (return-from type-difference nil))))))
3619      (let ((y-mem (find-if #'member-ctype-p y-types)))
3620        (when y-mem
3621          (let ((members (member-ctype-members y-mem)))
3622            (dolist (x-type x-types)
3623              (unless (member-ctype-p x-type)
3624                (dolist (member members)
3625                  (multiple-value-bind (val win) (ctypep member x-type)
3626                    (when (or (not win) val)
3627                      (return-from type-difference nil)))))))))
3628      (apply #'type-union (res)))))
3629
3630;;; CTypep  --  Interface
3631;;;
3632;;;    If Type is a type that we can do a compile-time test on, then return the
3633;;; whether the object is of that type as the first value and second value
3634;;; true.  Otherwise return NIL, NIL.
3635;;;
3636;;; We give up on unknown types, pick off FUNCTION and UNION types.  For
3637;;; structure types, we require that the type be defined in both the current
3638;;; and compiler environments, and that the INCLUDES be the same.
3639;;;
3640(defun ctypep (obj type)
3641  (declare (type ctype type))
3642  (etypecase type
3643    ((or numeric-ctype named-ctype member-ctype array-ctype cons-ctype)
3644     (values (%typep obj type) t))
3645    (class-ctype
3646     (values (not (null (class-typep  obj (class-ctype-class type)))) t)
3647)
3648    (union-ctype
3649     (any/type #'ctypep obj (union-ctype-types type)))
3650    (intersection-ctype
3651     (every/type #'ctypep obj (intersection-ctype-types type)))
3652    (function-ctype
3653     (values (functionp obj) t))
3654    (unknown-ctype
3655     (values nil nil))
3656    (foreign-ctype
3657     (values (foreign-typep obj (foreign-ctype-foreign-type type)) t))
3658    (negation-ctype
3659     (multiple-value-bind (res win)
3660         (ctypep obj (negation-ctype-type type))
3661       (if win
3662           (values (not res) t)
3663           (values nil nil))))
3664    (hairy-ctype
3665     ;; Now the tricky stuff.
3666     (let* ((hairy-spec (hairy-ctype-specifier type))
3667            (symbol (if (consp hairy-spec) (car hairy-spec) hairy-spec)))
3668       (ecase symbol
3669         (and                           ; how would this get there ?
3670          (if (atom hairy-spec)
3671            (values t t)
3672            (dolist (spec (cdr hairy-spec) (values t t))
3673              (multiple-value-bind (res win)
3674                  (ctypep obj (specifier-type spec))
3675                (unless win (return (values nil nil)))
3676                (unless res (return (values nil t)))))))
3677           (not                         ; how would this get there ?
3678            (multiple-value-bind
3679              (res win)
3680                (ctypep obj (specifier-type (cadr hairy-spec)))
3681              (if win
3682                (values (not res) t)
3683                (values nil nil))))
3684           (satisfies
3685            (let ((fun (second hairy-spec)))
3686              (cond ((and (symbolp fun) (fboundp fun))
3687                     ;; Binding *BREAK-ON-SIGNALS* here is a modularity
3688                     ;; violation intended to improve the signal-to-noise
3689                     ;; ratio on a mailing list.
3690                     (values (not (null (let* ((*break-on-signals* nil))
3691                                          (ignore-errors (funcall fun obj))))) t))
3692                    (t
3693                     (values nil nil))))))))))
3694
3695;;; %TYPEP -- internal.
3696;;;
3697;;; The actual typep engine.  The compiler only generates calls to this
3698;;; function when it can't figure out anything more intelligent to do.
3699;;;
3700; lose 1 function call -MAYBE
3701(defun %typep (object specifier)
3702  (%%typep object
3703           (if (typep specifier 'ctype)
3704             specifier
3705             (specifier-type specifier))))
3706
3707(eval-when (:compile-toplevel)
3708  (declaim (inline numeric-%%typep
3709                   array-%%typep
3710                   member-%%typep
3711                   cons-%%typep)))
3712
3713(defun numeric-%%typep (object type)
3714  (let ((pred (numeric-ctype-predicate type)))
3715    (if pred
3716      (funcall pred object)
3717      (and (numberp object)
3718           (let ((num (if (complexp object) (realpart object) object)))
3719             (ecase (numeric-ctype-class type)
3720               (integer (integerp num))
3721               (rational (rationalp num))
3722               (float
3723                (ecase (numeric-ctype-format type)
3724                  (single-float (typep num 'single-float))
3725                  (double-float (typep num 'double-float))
3726                  ((nil) (floatp num))))
3727               ((nil) t)))
3728           (flet ((bound-test (val)
3729                    (let ((low (numeric-ctype-low type))
3730                          (high (numeric-ctype-high type)))
3731                      (and (cond ((null low) t)
3732                                 ((listp low) (> val (car low)))
3733                                 (t (>= val low)))
3734                           (cond ((null high) t)
3735                                 ((listp high) (< val (car high)))
3736                                 (t (<= val high)))))))
3737             (ecase (numeric-ctype-complexp type)
3738               ((nil) t)
3739               (:complex
3740                (and (complexp object)
3741                     (bound-test (realpart object))
3742                     (bound-test (imagpart object))))
3743               (:real
3744                (and (not (complexp object))
3745                     (bound-test object)))))))))
3746
3747(defun array-%%typep (object type)
3748  (let* ((typecode (typecode object)))
3749    (declare (type (unsigned-byte 8) typecode))
3750    (and (>= typecode target::subtag-arrayH)
3751         (ecase (array-ctype-complexp type)
3752           ((t) (not (simple-array-p object)))
3753           ((nil) (simple-array-p object))
3754           ((* :maybe) t))
3755         (let* ((ctype-dimensions (array-ctype-dimensions type)))
3756           (or (eq ctype-dimensions '*)
3757               (if (eql typecode target::subtag-arrayH)
3758                   (let* ((rank (%svref object target::arrayH.rank-cell)))
3759                     (declare (fixnum rank))
3760                     (and (eql rank (length ctype-dimensions))
3761                          (do* ((i 0 (1+ i))
3762                                (dim target::arrayH.dim0-cell (1+ dim))
3763                                (want (array-ctype-dimensions type) (cdr want))
3764                                (got (%svref object dim) (%svref object dim)))
3765                               ((eql i rank) t)
3766                            (unless (or (eq (car want) '*)
3767                                        (eql (%car want) (the fixnum got)))
3768                              (return nil)))))
3769                   (and (null (cdr ctype-dimensions))
3770                        (or (eq (%car ctype-dimensions) '*)
3771                            (eql (%car ctype-dimensions)
3772                                 (if (eql typecode target::subtag-vectorH)
3773                                   (%svref object target::vectorH.physsize-cell)
3774                                   (uvsize object))))))))
3775         (or (eq (array-ctype-element-type type) *wild-type*)
3776             (eql (array-ctype-typecode type)
3777                  (if (> typecode target::subtag-vectorH)
3778                      typecode
3779                      (ldb target::arrayH.flags-cell-subtag-byte (the fixnum (%svref object target::arrayH.flags-cell)))))
3780             (type= (array-ctype-specialized-element-type type)
3781                    (specifier-type (array-element-type object)))))))
3782
3783
3784(defun member-%%typep (object type)
3785  (not (null (member object (member-ctype-members type)))))
3786
3787(defun cons-%%typep (object type) 
3788  (and (consp object)
3789       (%%typep (car object) (cons-ctype-car-ctype type))
3790       (%%typep (cdr object) (cons-ctype-cdr-ctype type)))) 
3791
3792
3793(defun %%typep (object type)
3794  ;(if (not (typep type 'ctype))(setq type (specifier-type type)))
3795  (locally (declare (type ctype type))
3796    (etypecase type
3797      (named-ctype
3798       (ecase (named-ctype-name type)
3799         ((* t) t)
3800         ((nil) nil)))
3801      (numeric-ctype
3802       (numeric-%%typep object type))
3803      (array-ctype
3804       (array-%%typep object type))
3805      (member-ctype
3806       (member-%%typep object type))
3807      (class-ctype
3808       (not (null (class-typep object (class-ctype-class type)))))
3809      (union-ctype
3810       (dolist (type (union-ctype-types type))
3811         (when (%%typep object type)
3812           (return t))))
3813      (intersection-ctype
3814       (dolist (type (intersection-ctype-types type) t)
3815         (unless (%%typep object type) (return nil))))
3816      (cons-ctype
3817       (cons-%%typep object type))
3818      (unknown-ctype
3819       ;; Parse it again to make sure it's really undefined.
3820       (let ((reparse (specifier-type (unknown-ctype-specifier type))))
3821         (if (typep reparse 'unknown-ctype)
3822           (error "Unknown type specifier: ~S"
3823                  (unknown-ctype-specifier reparse))
3824           (%%typep object reparse))))
3825      (negation-ctype
3826       (not (%%typep object (negation-ctype-type type))))
3827      (hairy-ctype
3828       ;; Now the tricky stuff.
3829       (let* ((hairy-spec (hairy-ctype-specifier type))
3830              (symbol (if (consp hairy-spec) (car hairy-spec) hairy-spec)))
3831         (ecase symbol
3832           (and
3833            (or (atom hairy-spec)
3834                (dolist (spec (cdr hairy-spec) t)
3835                  (unless (%%typep object (specifier-type spec))
3836                    (return nil)))))
3837           (not
3838            (unless (and (listp hairy-spec) (= (length hairy-spec) 2))
3839              (error "Invalid type specifier: ~S" hairy-spec))
3840            (not (%%typep object (specifier-type (cadr hairy-spec)))))
3841           (satisfies
3842            (unless (and (listp hairy-spec) (= (length hairy-spec) 2))
3843              (error "Invalid type specifier: ~S" hairy-spec))
3844            (let ((fn (cadr hairy-spec)))
3845              (if (funcall (typecase fn
3846                             (function fn)
3847                             (symbol (symbol-function fn))
3848                             (t
3849                              (coerce fn 'function)))
3850                           object)
3851                t
3852                nil))))))
3853      #|
3854    (foreign-ctype
3855     (foreign-typep object (foreign-ctype-foreign-type type)))
3856|#
3857      (function-ctype
3858       (error "Function types are not a legal argument to TYPEP:~%  ~S"
3859              (type-specifier type))))))
3860
3861
3862;;; Ctype-Of  --  Interface
3863;;;
3864;;;    Like Type-Of, only returns a Type structure instead of a type
3865;;; specifier.  We try to return the type most useful for type checking, rather
3866;;; than trying to come up with the one that the user might find most
3867;;; informative.
3868;;;
3869
3870(defun float-format-name (x)
3871  (declare (float x))
3872  (etypecase x
3873    (single-float "SINGLE-FLOAT")
3874    (double-float "DOUBLE-FLOAT")))
3875
3876(defun ctype-of-number (x)
3877  (let ((num (if (complexp x) (realpart x) x)))
3878    (multiple-value-bind (complexp low high)
3879        (if (complexp x)
3880            (let ((imag (imagpart x)))
3881              (values :complex (min num imag) (max num imag)))
3882            (values :real num num))
3883      (make-numeric-ctype :class (etypecase num
3884                                   (integer (if (complexp x)
3885                                                (if (integerp (imagpart x))
3886                                                    'integer
3887                                                    'rational)
3888                                                'integer))
3889                                   (rational 'rational)
3890                                   (float 'float))
3891                          :format (and (floatp num)
3892                                       (if (typep num 'double-float)
3893                                         'double-float
3894                                         'single-float))
3895                          :complexp complexp
3896                          :low low
3897                          :high high))))
3898
3899(defun ctype-of (x)
3900  (typecase x
3901    (function (specifier-type 'function)) ; GFs ..
3902    (symbol
3903     (make-member-ctype :members (list x)))
3904    (number (ctype-of-number x))
3905    (array
3906     (let ((etype (specifier-type (array-element-type x))))
3907       (make-array-ctype :dimensions (array-dimensions x)
3908                         :complexp (not (typep x 'simple-array))
3909                         :element-type etype
3910                         :specialized-element-type etype)))
3911    (t
3912     (%class.ctype (class-of x)))))
3913
3914(defvar *ctype-of-double-float-0* (ctype-of 0.0d0))
3915(defvar *ctype-of-single-float-0* (ctype-of 0.0f0))
3916
3917
3918
3919
3920; These DEFTYPES should only happen while initializing.
3921
3922(progn
3923(let-globally ((*type-system-initialized* nil))
3924
3925
3926(deftype bit () '(integer 0 1))
3927
3928(deftype eql (val) `(member ,val))
3929
3930(deftype signed-byte (&optional s)
3931  (cond ((eq s '*) 'integer)
3932          ((and (integerp s) (> s 0))
3933           (let ((bound (ash 1 (1- s))))
3934             `(integer ,(- bound) ,(1- bound))))
3935          (t
3936           (signal-program-error "Bad size specified for SIGNED-BYTE type specifier: ~S." s))))
3937 
3938(deftype unsigned-byte (&optional s)
3939  (cond ((eq s '*) '(integer 0))
3940        ((and (integerp s) (> s 0))
3941         `(integer 0 ,(1- (ash 1 s))))
3942        (t
3943         (error "Bad size specified for UNSIGNED-BYTE type specifier: ~S." s))))
3944
3945(deftype vector (&optional element-type size)
3946  `(array ,element-type (,size)))
3947
3948(deftype simple-vector (&optional size)
3949  `(simple-array t (,size)))
3950
3951(deftype base-string (&optional size)
3952  `(array base-char (,size)))
3953(deftype simple-base-string (&optional size)
3954  `(simple-array base-char (,size)))
3955
3956
3957
3958(deftype string (&optional size)
3959  `(array character (,size)))
3960
3961(deftype simple-string (&optional size)
3962  `(simple-array character (,size)))
3963
3964(deftype bit-vector (&optional size)
3965  `(array bit (,size)))
3966
3967(deftype simple-bit-vector (&optional size)
3968  `(simple-array bit (,size)))
3969
3970; TYPE-OF sometimes returns random symbols that aren't really type specifiers.
3971
3972(deftype simple-unsigned-word-vector (&optional size)
3973  `(simple-array (unsigned-byte 16) (,size)))
3974
3975(deftype simple-unsigned-byte-vector (&optional size)
3976  `(simple-array (unsigned-byte 8) (,size)))
3977
3978(deftype simple-unsigned-long-vector (&optional size)
3979  `(simple-array (unsigned-byte 32) (,size)))
3980
3981(deftype simple-signed-word-vector (&optional size)
3982  `(simple-array (signed-byte 16) (,size)))
3983
3984(deftype simple-signed-byte-vector (&optional size)
3985  `(simple-array (signed-byte 8) (,size)))
3986
3987(deftype simple-signed-long-vector (&optional size)
3988  `(simple-array (signed-byte 32) (,size)))
3989
3990
3991
3992(deftype simple-short-float-vector (&optional size)
3993  `(simple-array short-float (,size)))
3994
3995(deftype unsigned-word-vector (&optional size)
3996  `(vector (unsigned-byte 16) ,size))
3997
3998(deftype single-float-vector (&optional size)
3999  `(vector short-float ,size))
4000
4001(deftype unsigned-byte-vector (&optional size)
4002  `(vector (unsigned-byte 8) ,size))
4003
4004(deftype unsigned-long-vector (&optional size)
4005  `(vector (unsigned-byte 32) ,size))
4006
4007(deftype long-float-vector (&optional size)
4008  `(vector double-float ,size))
4009
4010(deftype long-vector (&optional size)
4011  `(vector (signed-byte 32) ,size))
4012
4013(deftype double-float-vector (&optional size)
4014  `(vector double-float ,size))
4015
4016(deftype byte-vector (&optional size)
4017  `(vector (signed-byte 8) ,size))
4018
4019(deftype general-vector (&optional size)
4020  `(vector t ,size))
4021
4022(deftype word-vector (&optional size)
4023  `(vector (signed-byte 16) ,size))
4024
4025(deftype short-float-vector (&optional size)
4026  `(vector single-float ,size))
4027
4028(deftype simple-1d-array (&optional size)
4029  `(simple-array * (,size)))
4030
4031(deftype simple-long-vector (&optional size)
4032  `(simple-array (signed-byte 32) (,size)))
4033
4034(deftype simple-word-vector (&optional size)
4035  `(simple-array (signed-byte 16) (,size)))
4036
4037(deftype simple-short-float-vector (&optional size)
4038  `(simple-array single-float (,size)))
4039
4040(deftype simple-byte-vector (&optional size)
4041  `(simple-array (signed-byte 8) (,size)))
4042
4043(deftype simple-double-float-vector (&optional size)
4044  `(simple-array double-float (,size)))
4045
4046(deftype simple-single-float-vector (&optional size)
4047  `(simple-array single-float (,size)))
4048
4049(deftype simple-long-float-vector (&optional size)
4050  `(simple-array double-float (,size)))
4051
4052(deftype simple-fixnum-vector (&optional size)
4053  `(simple-array fixnum (,size)))
4054
4055(deftype fixnum-vector (&optional size)
4056  `(array fixnum (,size)))
4057
4058#+64-bit-target
4059(deftype simple-doubleword-vector (&optional size)
4060  `(simple-array (signed-byte 64) (,size)))
4061
4062#+64-bit-target
4063(deftype simple-unsigned-doubleword-vector (&optional size)
4064  `(simple-array (unsigned-byte 64) (,size)))
4065
4066
4067(deftype short-float (&optional low high)
4068  `(single-float ,low ,high))
4069
4070(deftype long-float (&optional low high)
4071  `(double-float ,low ,high))
4072
4073#||
4074;;; As empty a type as you're likely to find ...
4075(deftype extended-char ()
4076  "Type of CHARACTERs that aren't BASE-CHARs."
4077  nil)
4078||#
4079
4080(deftype natural ()
4081  `(unsigned-byte ,target::nbits-in-word))
4082
4083(deftype signed-natural ()
4084  `(signed-byte ,target::nbits-in-word))
4085)
4086
4087
4088(let* ((builtin-translations 
4089        `((array . array)
4090          (simple-array . simple-array)
4091          (cons . cons)
4092          (vector . vector)
4093          (null . (member nil))
4094          (list . (or cons null))
4095          (sequence . (or list vector))
4096          (simple-vector . simple-vector)
4097          (bit-vector . bit-vector)
4098          (simple-bit-vector . simple-bit-vector)
4099          (simple-string . simple-string)
4100          (simple-base-string . simple-base-string)
4101          (string . string)
4102          (base-string . base-string)
4103          (real . real)
4104          (complex . complex)
4105          (float . float)
4106          (double-float . double-float)
4107          (long-float . double-float)
4108          (single-float . single-float)
4109          (short-float . single-float)
4110
4111          (rational . rational)
4112          (integer . integer)
4113          (ratio . (and rational (not integer)))
4114          (fixnum . (integer ,target::target-most-negative-fixnum
4115                     ,target::target-most-positive-fixnum))
4116          (bignum . (or (integer * (,target::target-most-negative-fixnum))
4117                         (integer (,target::target-most-positive-fixnum) *)))
4118         
4119          )))
4120  (dolist (spec builtin-translations)
4121    (setf (info-type-kind (car spec)) :primitive
4122          (info-type-builtin (car spec)) (specifier-type (cdr spec)))))
4123
4124
4125
4126
4127
4128       
4129(precompute-types '((mod 2) (mod 4) (mod 16) (mod #x100) (mod #x10000)
4130                    #-cross-compiling
4131                    (mod #x100000000)
4132                    (unsigned-byte 1) 
4133                    (unsigned-byte 8) (unsigned-byte 16) (unsigned-byte 32)
4134                    (unsigned-byte 64)
4135                    (signed-byte 8) (signed-byte 16) (signed-byte 32)
4136                    (signed-byte 64)
4137                    (or function symbol)
4138                    ))
4139
4140
4141(precompute-types *cl-types*)
4142
4143;;; Treat CHARACTER and BASE-CHAR as equivalent.
4144(setf (info-type-builtin 'character) (info-type-builtin 'base-char))
4145;;; And EXTENDED-CHAR as empty.
4146(setf (info-type-builtin 'extended-char) *empty-type*)
4147
4148(defparameter *null-type* (specifier-type 'null))
4149
4150
4151(flet ((set-builtin-class-type-translation (thing)
4152         (let* ((class-name (if (atom thing) thing (car thing)))
4153                (spec (if (atom thing) thing (cadr thing)))
4154                (spectype (specifier-type spec)))
4155           (setf (class-ctype-translation
4156                  (%class.ctype (find-class class-name))) spectype))))
4157  (mapc #'set-builtin-class-type-translation
4158        '(
4159          ;; Root Of All Evil
4160          t
4161          ;; Numbers:
4162          number real ratio complex rational fixnum
4163          ;;  Integers:
4164          signed-byte  unsigned-byte bit bignum integer
4165          ;;  Floats
4166           float  double-float single-float
4167          ;; Arrays
4168          array
4169          ;;  Simple Arrays
4170          simple-array
4171          ;;  Vectors
4172          vector string base-string bit-vector
4173          unsigned-byte-vector unsigned-word-vector unsigned-long-vector
4174          byte-vector word-vector long-vector
4175          single-float-vector double-float-vector
4176          general-vector
4177          fixnum-vector
4178          #+64-bit-target
4179          doubleword-vector
4180          #+64-bit-target
4181          unsigned-doubleword-vector
4182          ;;   Simple 1-Dimensional Arrays
4183          simple-1d-array  simple-string simple-base-string simple-bit-vector
4184          simple-unsigned-byte-vector
4185          simple-unsigned-long-vector
4186          simple-unsigned-word-vector
4187          simple-byte-vector
4188          simple-word-vector
4189          simple-long-vector 
4190          simple-single-float-vector 
4191          simple-double-float-vector
4192          simple-vector
4193          simple-fixnum-vector
4194          #+64-bit-target
4195          simple-doubleword-vector
4196          #+64-bit-target
4197          simple-unsigned-doubleword-vector
4198          ;; Sequence types
4199          sequence list  cons null
4200         
4201 )
4202                                                         
4203        ))
4204)
4205;(setq *type-system-initialized* t)
4206
4207
4208
4209
4210; These deftypes help the CMUCL compiler; the type system doesn't depend on them.
4211
4212;;; Since Clozure CL's DEFTYPE tries to globally define the type
4213;;; at compile-time as well as load- and execute time, hide
4214;;; the definition of these "built-in" types.  (It'd be cleaner
4215;;; to make DEFTYPE do something saner at compile-time.)
4216(let* ()                                ; make the following be non-toplevel
4217(deftype boolean () '(member t nil))
4218
4219(deftype atom () '(not cons))
4220;;;
4221;;; A type specifier.
4222(deftype type-specifier () '(or list symbol class))
4223;;;
4224;;; An index into an array.   Also used for sequence index.
4225(deftype index () `(integer 0 (,array-dimension-limit)))
4226;;;
4227;;; Array rank, total size...
4228(deftype array-rank () `(integer 0 (,array-rank-limit)))
4229(deftype array-total-size () `(integer 0 (,array-total-size-limit)))
4230;;;
4231;;; Some thing legal in an evaluated context.
4232(deftype form () t)
4233;;;
4234;;; Maclisp compatibility...
4235(deftype stringlike () '(or string symbol))
4236(deftype stringable () '(or string symbol character))
4237;;;
4238;;; Save a little typing...
4239(deftype truth () '(member t))
4240;;;
4241;;; A thing legal in places where we want the name of a file.
4242(deftype filename () '(or string pathname))
4243;;;
4244;;; A legal arg to pathname functions.
4245(deftype pathnamelike () '(or string pathname stream))
4246;;;
4247;;; A thing returned by the irrational functions.  We assume that they never
4248;;; compute a rational result.
4249(deftype irrational () '(or float (complex float)))
4250;;;
4251;;; Character components:
4252(deftype char-code () `(integer 0 (,char-code-limit)))
4253;;;
4254;;; A consed sequence result.  If a vector, is a simple array.
4255(deftype consed-sequence () '(or list (simple-array * (*))))
4256;;;
4257;;; The :end arg to a sequence...
4258(deftype sequence-end () '(or null index))
4259;;;
4260;;; A valid argument to a stream function...
4261(deftype streamlike () '(or stream (member nil t)))
4262;;;
4263;;; A thing that can be passed to funcall & friends.
4264(deftype callable () '(or function symbol))
4265
4266;;; Until we decide if and how to wedge this into the type system, make it
4267;;; equivalent to t.
4268;;;
4269(deftype void () t)
4270;;;
4271;;; An index into an integer.
4272(deftype bit-index () `(integer 0 ,target::target-most-positive-fixnum))
4273;;;
4274;;; Offset argument to Ash (a signed bit index).
4275(deftype ash-index () 'fixnum)
4276
4277;;; Not sure how to do this without SATISFIES.
4278(deftype setf-function-name () `(satisfies setf-function-name-p))
4279
4280;;; Better than nothing, arguably.
4281(deftype function-name () `(or symbol setf-function-name))
4282
4283(deftype valid-char-code () `(satisfies valid-char-code-p))
4284
4285)                                       ; end of LET* sleaze
4286
4287(defun array-or-union-ctype-element-type (ctype)
4288  (if (typep ctype 'array-ctype)
4289    (type-specifier (array-ctype-element-type ctype))
4290    (if (typep ctype 'union-ctype)
4291      `(or ,@(mapcar #'array-or-union-ctype-element-type 
4292                     (union-ctype-types ctype))))))
4293
4294
4295(defvar *simple-predicate-function-prototype*
4296  #'(lambda (thing)
4297      (%%typep thing #.(specifier-type t))))
4298
4299(defun make-simple-type-predicate (function datum)
4300  #+ppc-target
4301  (gvector :function
4302           (uvref *simple-predicate-function-prototype* 0)
4303           datum
4304           function
4305           nil
4306           (dpb 1 $lfbits-numreq 0))
4307  #+arm-target
4308  (%fix-fn-entrypoint
4309   (gvector :function
4310           0
4311           (uvref *simple-predicate-function-prototype* 1)
4312           datum
4313           function
4314           nil
4315           (dpb 1 $lfbits-numreq 0)))
4316  #+x86-target
4317  (%clone-x86-function
4318   *simple-predicate-function-prototype*
4319   datum
4320   function
4321   nil
4322   (dpb 1 $lfbits-numreq 0)))
4323
4324(defun check-ctypep (thing ctype)
4325  (multiple-value-bind (win sure) (ctypep thing ctype)
4326    (or win (not sure))))
4327
4328
4329(defun generate-predicate-for-ctype (ctype)
4330  (typecase ctype
4331    (numeric-ctype
4332     (or (numeric-ctype-predicate ctype)
4333         (make-simple-type-predicate 'numeric-%%typep ctype)))
4334    (array-ctype
4335     (make-simple-type-predicate 'array-%%typep ctype))
4336    (member-ctype
4337     (make-simple-type-predicate 'member-%%typep ctype))
4338    (named-ctype
4339     (case (named-ctype-name ctype)
4340       ((* t) #'true)
4341       (t #'false)))
4342    (cons-ctype
4343     (make-simple-type-predicate 'cons-%%typep ctype))
4344    (function-ctype
4345     #'functionp)
4346    (class-ctype
4347     (make-simple-type-predicate 'class-cell-typep (find-class-cell (class-name (class-ctype-class ctype)) t)))
4348    (t
4349     (make-simple-type-predicate 'check-ctypep ctype))))
4350   
4351       
4352
4353   
4354
4355;;; Ensure that standard EFFECTIVE-SLOT-DEFINITIONs have a meaningful
4356;;; type predicate, if we can.
4357(defmethod shared-initialize :after ((spec effective-slot-definition)
4358                                     slot-names
4359                                     &key 
4360                                     &allow-other-keys)
4361  (declare (ignore slot-names))
4362  (let* ((type (slot-definition-type spec)))
4363    (setf (slot-value spec 'type-predicate)
4364          (or (and (typep type 'symbol)
4365                   (not (eq type 't))
4366                   (type-predicate type))
4367              (handler-case
4368                  (let* ((ctype (specifier-type type)))
4369                    (unless (eq ctype *universal-type*)
4370                      (generate-predicate-for-ctype ctype)))
4371                (program-error ()
4372                  (warn "Invalid type specifier ~s in slot definition for ~s in class ~s." type (slot-definition-name spec) (slot-definition-class spec))
4373                  (lambda (v)
4374                    (cerror "Allow the assignment or initialization."
4375                            "Can't determine whether or not the value ~s should be used to initialize or assign to the slot ~&named ~s in an instance of ~s, because the slot is declared ~&to be of the invalid type ~s."
4376                            v (slot-definition-name spec) (slot-definition-class spec) (slot-definition-type spec))
4377                    ;; Suppress further checking, at least for things that use this effective slotd.
4378                    ;; (It's hard to avoid this, and more trouble than it's worth to do better.)
4379                    (setf (slot-value spec 'type-predicate) nil)
4380                    t))
4381                (parse-unknown-type (c)
4382                   (declare (ignore c))
4383                   #'(lambda (value)
4384                       ;; If the type's now known, install a new predicate.
4385                       (let* ((nowctype (specifier-type type)))
4386                         (unless (typep nowctype 'unknown-ctype)
4387                           (setf (slot-value spec 'type-predicate)
4388                                 (generate-predicate-for-ctype nowctype)))
4389                         (multiple-value-bind (win sure)
4390                             (ctypep value nowctype)
4391                           (or (not sure) win))))))))))
4392
Note: See TracBrowser for help on using the repository browser.