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

Last change on this file since 9240 was 9240, checked in by gz, 11 years ago

Propagate r9237 to trunk: Stop ignoring defstruct slot type
specifiers. Types are checked unconditionally (i.e. regardless of
safety settings) by constructors and slot setters.

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