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

Last change on this file was 16685, checked in by rme, 4 years ago

Update copyright/license headers in files.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 153.6 KB
RevLine 
[6]1;;;-*- Mode: Lisp; Package: CCL -*-
2;;;
[16685]3;;; Copyright 1994-2009 Clozure Associates
[6]4;;;
[16685]5;;; Licensed under the Apache License, Version 2.0 (the "License");
6;;; you may not use this file except in compliance with the License.
7;;; You may obtain a copy of the License at
[6]8;;;
[16685]9;;;     http://www.apache.org/licenses/LICENSE-2.0
[6]10;;;
[16685]11;;; Unless required by applicable law or agreed to in writing, software
12;;; distributed under the License is distributed on an "AS IS" BASIS,
13;;; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14;;; See the License for the specific language governing permissions and
15;;; limitations under the License.
[6]16
17;; This is a hacked-up version of the CMU CL type system.
18
[2326]19(in-package "CCL")
[6]20
21
[398]22
[6]23
24(defun parse-lambda-list (list)
25  (let* ((required)
26         (optional)
27         (keys)
28         (aux))
29    (let ((restp nil)
30          (rest nil)
31          (keyp nil)
32          (allowp nil)
33          (state :required))
34      (dolist (arg list)
35        (if (and (symbolp arg)
36                 (let ((name (symbol-name arg)))
37                   (and (/= (length name) 0)
38                        (char= (char name 0) #\&))))
39          (case arg
40            (&optional
41             (unless (eq state :required)
42               (error "Misplaced &optional in lambda-list: ~S." list))
43             (setq state '&optional))
44            (&rest
45             (unless (member state '(:required &optional))
46               (error "Misplaced &rest in lambda-list: ~S." list))
47             (setq state '&rest))
48            (&key
49             (unless (member state '(:required &optional :post-rest
50                                     ))
51               (error "Misplaced &key in lambda-list: ~S." list))
52             (setq keyp t)
53             (setq state '&key))
54            (&allow-other-keys
55             (unless (eq state '&key)
56               (error "Misplaced &allow-other-keys in lambda-list: ~S." list))
57             (setq allowp t  state '&allow-other-keys))
58            (&aux
59             (when (member state '(&rest))
60               (error "Misplaced &aux in lambda-list: ~S." list))
61             (setq state '&aux))
62            (t
63             (error "Unknown &keyword in lambda-list: ~S." arg)))
64          (case state
65            (:required (push arg required))
66            (&optional (push arg optional))
67            (&rest
68             (setq restp t  rest arg  state :post-rest))
69            (&key (push arg keys))
70            (&aux (push arg aux))
71            (t
72             (error "Found garbage in lambda-list when expecting a keyword: ~S." arg)))))
73     
74      (values (nreverse required) (nreverse optional) restp rest keyp (nreverse keys) allowp (nreverse aux)))))
75
76(defvar %deftype-expanders% (make-hash-table :test #'eq))
77(defvar *type-translators* (make-hash-table :test #'eq))
78(defvar *builtin-type-info* (make-hash-table :test #'equal))
79(defvar %builtin-type-cells% (make-hash-table :test 'equal))
80
81(defvar *use-implementation-types* t)
82
83(defun info-type-builtin (name)
84  (gethash name *builtin-type-info*))
85
86(defun (setf info-type-builtin) (val name)
87  (setf (gethash name *builtin-type-info*) val))
88
89(defun info-type-translator (name)
90  (gethash name *type-translators*))
91
92
93
94
[3963]95;;; Allow bootstrapping: mostly, allow us to bootstrap the type system
96;;; by having DEFTYPE expanders defined on built-in classes (the user
97;;; shouldn't be allowed to do so, at least not easily.
[6]98
99;(defvar *type-system-initialized* nil)
100
101(defun %deftype (name fn doc)
[1148]102  (clear-type-cache)
[6]103  (cond ((null fn)
104         (remhash name %deftype-expanders%))
105        ((and *type-system-initialized*
[12026]106              (or (built-in-type-p name)
107                  (let ((c (find-class name nil)))
108                    (and c (eq (class-name c) name)))))
[12045]109         (error "Cannot redefine type ~S because ~:[it is the name of a class~;it is a built-in type~]" name (built-in-type-p name)))
110        ((memq name *nx-known-declarations*)
111         (check-declaration-redefinition name 'deftype))
[6]112        (t (setf (gethash name %deftype-expanders%) fn)
113           (record-source-file name 'type)))
114  (set-documentation name 'type doc)   ; nil clears it.
115  name)
116
117(defun %define-type-translator (name fn doc)
118  (declare (ignore doc))
119  (setf (gethash name *type-translators*) fn)
120  name)
121
[3963]122;;;(defun %deftype-expander (name)
123;;;  (or (gethash name %deftype-expanders%)
124;;;      (and *compiling-file* (%cdr (assq name *compile-time-deftype-expanders*)))))
[6]125(defun %deftype-expander (name)
126  (gethash name %deftype-expanders%))
127
128(defun process-deftype-arglist (arglist &aux (in-optional? nil))
129  "Returns a NEW list similar to arglist except
130    inserts * as the default default for &optional args."
131  (mapcar #'(lambda (item)
132              (cond ((eq item '&optional) (setq in-optional? t) item)
133                    ((memq item lambda-list-keywords) (setq in-optional? nil) item)
134                    ((and in-optional? (symbolp item)) (list item ''*))
135                    (t item)))
136          arglist))
137
[279]138
[6]139(defun expand-type-macro (definer name arglist body env)
140  (setq name (require-type name 'symbol))
141  (multiple-value-bind (lambda doc)
142      (parse-macro-internal name arglist body env '*)
[12045]143    `(progn
144       (eval-when (:compile-toplevel)
145         (note-type-info ',name 'macro ,env))
146       (eval-when (:compile-toplevel :load-toplevel :execute)
147         (,definer ',name
148             (nfunction ,name ,lambda)
149           ,doc)))))
[6]150
151(defmacro deftype (name arglist &body body &environment env)
[929]152  "Define a new type, with syntax like DEFMACRO."
[6]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
[10426]180(defmethod make-load-form ((cell type-cell) &optional env)
181  (declare (ignore env))
182  `(register-type-cell `,(type-cell-type-specifier cell)))
[6]183
[10426]184(defmethod print-object ((cell type-cell) stream)
185  (print-unreadable-object (cell stream :type t :identity t)
186    (format stream "for ~s" (type-cell-type-specifier cell))))
187
[6]188(defun make-key-info (&key name type)
189  (%istruct 'key-info name type))
190
191(defun type-class-or-lose (name)
192  (or (cdr (assq name *type-classes*))
193      (error "~S is not a defined type class." name)))
194
195(eval-when (:compile-toplevel :execute)
196
197(defconstant type-class-function-slots
198  '((:simple-subtypep . #.type-class-simple-subtypep)
199    (:complex-subtypep-arg1 . #.type-class-complex-subtypep-arg1)
200    (:complex-subtypep-arg2 . #.type-class-complex-subtypep-arg2)
201    (:simple-union . #.type-class-simple-union)
202    (:complex-union . #.type-class-complex-union)
203    (:simple-intersection . #.type-class-simple-intersection)
204    (:complex-intersection . #.type-class-complex-intersection)
205    (:simple-= . #.type-class-simple-=)
206    (:complex-= . #.type-class-complex-=)
207    (:unparse . #.type-class-unparse)))
208
209)
210
211(defun class-typep (form class)
212  (memq class (%inited-class-cpl (class-of form))))
213
214;;; CLASS-FUNCTION-SLOT-OR-LOSE  --  Interface
215;;;
216(defun class-function-slot-or-lose (name)
217  (or (cdr (assoc name type-class-function-slots))
218      (error "~S is not a defined type class method." name)))
219
220
221(eval-when (:compile-toplevel :execute)
222
223;;; INVOKE-TYPE-METHOD  --  Interface
224;;;
225;;;    Invoke a type method on TYPE1 and TYPE2.  If the two types have the same
226;;; class, invoke the simple method.  Otherwise, invoke any complex method.  If
227;;; there isn't a distinct complex-arg1 method, then swap the arguments when
228;;; calling type1's method.  If no applicable method, return DEFAULT.
229;;;
230
231(defmacro invoke-type-method (simple complex-arg2 type1 type2 &key
232                                     (default '(values nil t))
233                                     complex-arg1)
234  (let ((simple (class-function-slot-or-lose simple))
235        (cslot1 (class-function-slot-or-lose (or complex-arg1 complex-arg2)))
236        (cslot2 (class-function-slot-or-lose complex-arg2)))
237    (once-only ((n-type1 type1)
238                (n-type2 type2))
239      (once-only ((class1 `(ctype-class-info ,n-type1))
240                  (class2 `(ctype-class-info ,n-type2)))
241        `(if (eq ,class1 ,class2)
242           (funcall (%svref ,class1 ,simple) ,n-type1 ,n-type2)
243           ,(once-only ((complex1 `(%svref ,class1 ,cslot1))
244                        (complex2 `(%svref ,class2 ,cslot2)))
245              `(cond (,complex2 (funcall ,complex2 ,n-type1 ,n-type2))
246                     (,complex1
247                      ,(if complex-arg1
248                         `(funcall ,complex1 ,n-type1 ,n-type2)
249                         `(funcall ,complex1 ,n-type2 ,n-type1)))
250                     (t ,default))))))))
251
252
253;;;; Utilities:
254
255;;; ANY-TYPE-OP, EVERY-TYPE-OP  --  Interface
256;;;
257;;;    Like ANY and EVERY, except that we handle two-arg uncertain predicates.
258;;; If the result is uncertain, then we return Default from the block PUNT.
259;;; If LIST-FIRST is true, then the list element is the first arg, otherwise
260;;; the second.
261;;;
262(defmacro any-type-op (op thing list &key (default '(values nil nil))
263                                list-first)
264  (let ((n-this (gensym))
265          (n-thing (gensym))
266          (n-val (gensym))
267          (n-win (gensym))
268          (n-uncertain (gensym)))
269    `(let ((,n-thing ,thing)
270             (,n-uncertain nil))
271       (dolist (,n-this ,list
272                              (if ,n-uncertain
273                                (return-from PUNT ,default)
274                                nil))
275           (multiple-value-bind (,n-val ,n-win)
276                                    ,(if list-first
277                                         `(,op ,n-this ,n-thing)
278                                         `(,op ,n-thing ,n-this))
279             (unless ,n-win (setq ,n-uncertain t))
280             (when ,n-val (return t)))))))
281;;;
282(defmacro every-type-op (op thing list &key (default '(values nil nil))
283                                  list-first)
284  (let ((n-this (gensym))
285          (n-thing (gensym))
286          (n-val (gensym))
287          (n-win (gensym)))
288    `(let ((,n-thing ,thing))
289       (dolist (,n-this ,list t)
290           (multiple-value-bind (,n-val ,n-win)
291                                    ,(if list-first
292                                         `(,op ,n-this ,n-thing)
293                                         `(,op ,n-thing ,n-this))
294             (unless ,n-win (return-from PUNT ,default))
295             (unless ,n-val (return nil)))))))
296
297)
298
299 
300;;; VANILLA-INTERSECTION  --  Interface
301;;;
302;;;    Compute the intersection for types that intersect only when one is a
303;;; hierarchical subtype of the other.
304;;;
305(defun vanilla-intersection (type1 type2)
306  (multiple-value-bind (stp1 win1)
307                           (csubtypep type1 type2)
308    (multiple-value-bind (stp2 win2)
309                               (csubtypep type2 type1)
310      (cond (stp1 (values type1 t))
311              (stp2 (values type2 t))
312              ((and win1 win2) (values *empty-type* t))
313              (t
314               (values type1 nil))))))
315
316
317;;; VANILLA-UNION  --  Interface
318;;;
319(defun vanilla-union (type1 type2)
320  (cond ((csubtypep type1 type2) type2)
[279]321        ((csubtypep type2 type1) type1)
322        (t nil)))
[6]323
[279]324(defun hierarchical-intersection2 (type1 type2)
325  (multiple-value-bind (subtypep1 win1) (csubtypep type1 type2)
326    (multiple-value-bind (subtypep2 win2) (csubtypep type2 type1)
327      (cond (subtypep1 type1)
328            (subtypep2 type2)
329            ((and win1 win2) *empty-type*)
330            (t nil)))))
[6]331
[279]332(defun hierarchical-union2 (type1 type2)
333  (cond ((csubtypep type1 type2) type2)
334        ((csubtypep type2 type1) type1)
335        (t nil)))
336
[6]337;;; DELEGATE-COMPLEX-{SUBTYPEP-ARG2,INTERSECTION}  --  Interface
338;;;
339;;;    These functions are used as method for types which need a complex
340;;; subtypep method to handle some superclasses, but cover a subtree of the
341;;; type graph (i.e. there is no simple way for any other type class to be a
342;;; subtype.)  There are always still complex ways, namely UNION and MEMBER
343;;; types, so we must give TYPE1's method a chance to run, instead of
344;;; immediately returning NIL, T.
345;;;
346(defun delegate-complex-subtypep-arg2 (type1 type2)
347  (let ((subtypep-arg1
348         (type-class-complex-subtypep-arg1
349          (ctype-class-info type1))))
350    (if subtypep-arg1
351        (funcall subtypep-arg1 type1 type2)
352        (values nil t))))
353;;;
354(defun delegate-complex-intersection (type1 type2)
355  (let ((method (type-class-complex-intersection (ctype-class-info type1))))
356    (if (and method (not (eq method #'delegate-complex-intersection)))
357        (funcall method type2 type1)
[279]358        (hierarchical-intersection2 type1 type2))))
[6]359
360;;; HAS-SUPERCLASSES-COMPLEX-SUBTYPEP-ARG1  --  Internal
361;;;
362;;;    Used by DEFINE-SUPERCLASSES to define the SUBTYPE-ARG1 method.  Info is
363;;; a list of conses (SUPERCLASS-CLASS . {GUARD-TYPE-SPECIFIER | NIL}).  Will
364;;; never be called with a hairy type as type2, since the hairy type type2
365;;; method gets first crack.
366;;;
367#|
368(defun has-superclasses-complex-subtypep-arg1 (type1 type2 info)
369  (values
370   (and (typep type2 'class)
371        (dolist (x info nil)
372          (when (or (not (cdr x))
373                    (csubtypep type1 (specifier-type (cdr x))))
374            (return
375             (or (eq type2 (car x))
376                 (let ((inherits (layout-inherits (class-layout (car x)))))
377                   (dotimes (i (length inherits) nil)
378                     (when (eq type2 (layout-class (svref inherits i)))
379                       (return t)))))))))
380   t))
381|#
382
383(eval-when (:compile-toplevel :execute)
384;;; DEFINE-SUPERCLASSES  --  Interface
385;;;
386;;;    Takes a list of specs of the form (superclass &optional guard).
387;;; Consider one spec (with no guard): any instance of type-class is also a
388;;; subtype of SUPERCLASS and of any of its superclasses.  If there are
389;;; multiple specs, then some will have guards.  We choose the first spec whose
390;;; guard is a supertype of TYPE1 and use its superclass.  In effect, a
391;;; sequence of guards G0, G1, G2 is actually G0, (and G1 (not G0)),
392;;; (and G2 (not (or G0 G1))).
393;;;
394#|
395(defmacro define-superclasses (type-class &rest specs)
396  (let ((info
397         (mapcar #'(lambda (spec)
398                     (destructuring-bind (super &optional guard)
399                                         spec
400                       (cons (find-class super) guard)))
401                 specs)))
402    `(progn
403      (setf (type-class-complex-subtypep-arg1
404             (type-class-or-lose ',type-class))
405            #'(lambda (type1 type2)
406                (has-superclasses-complex-subtypep-arg1 type1 type2 ',info)))
407       
408       (setf (type-class-complex-subtypep-arg2
409              (type-class-or-lose ',type-class))
410             #'delegate-complex-subtypep-arg2)
411       
412       (setf (type-class-complex-intersection
413              (type-class-or-lose ',type-class))
414             #'delegate-complex-intersection))))
415|#
416
417); eval-when (compile eval)
418
[279]419
420(defun reparse-unknown-ctype (type)
421  (if (unknown-ctype-p type)
422    (specifier-type (type-specifier type))
423    type))
424
425(defun swapped-args-fun (f)
426  #'(lambda (x y)
427      (funcall f y x)))
428
429(defun equal-but-no-car-recursion (x y)
430  (cond ((eql x y) t)
431        ((consp x)
432         (and (consp y)
433              (eql (car x) (car y))
434              (equal-but-no-car-recursion (cdr x) (cdr y))))
435        (t nil)))
436
437(defun any/type (op thing list)
438  (declare (type function op))
439  (let ((certain? t))
440    (dolist (i list (values nil certain?))
441      (multiple-value-bind (sub-value sub-certain?) (funcall op thing i)
442        (if sub-certain?
443            (when sub-value (return (values t t)))
444            (setf certain? nil))))))
445
446(defun every/type (op thing list)
447  (declare (type function op))
448  (let ((certain? t))
449    (dolist (i list (if certain? (values t t) (values nil nil)))
450      (multiple-value-bind (sub-value sub-certain?) (funcall op thing i)
451        (if sub-certain?
452            (unless sub-value (return (values nil t)))
453            (setf certain? nil))))))
454
455(defun invoke-complex-=-other-method (type1 type2)
456  (let* ((type-class (ctype-class-info type1))
457         (method-fun (type-class-complex-= type-class)))
458    (if method-fun
459        (funcall (the function method-fun) type2 type1)
460        (values nil t))))
461
462(defun invoke-complex-subtypep-arg1-method (type1 type2 &optional subtypep win)
463  (let* ((type-class (ctype-class-info type1))
464         (method-fun (type-class-complex-subtypep-arg1 type-class)))
465    (if method-fun
466      (funcall (the function method-fun) type1 type2)
467      (values subtypep win))))
468
469(defun type-might-contain-other-types-p (type)
470  (or (hairy-ctype-p type)
471      (negation-ctype-p type)
472      (union-ctype-p type)
473      (intersection-ctype-p type)))
474
475
[6]476(eval-when (:compile-toplevel :execute)
477
478(defmacro define-type-method ((class method &rest more-methods)
479                                    lambda-list &body body)
480  `(progn
[9892]481     (let* ((fn (nfunction (,class ,method ,@more-methods)
482                           (lambda ,lambda-list ,@body))))
[6]483       ,@(mapcar #'(lambda (method)
484                         `(setf (%svref
485                                   (type-class-or-lose ',class)
486                             ,(class-function-slot-or-lose method))
487                                  fn))
488                     (cons method more-methods)))
489     nil))
490
491)
492
493
494(defun ctype-p (x)
[1668]495  (and (eql (typecode x) target::subtag-istruct)
[10309]496       (memq (istruct-type-name x)
[6]497             '#.(cons 'ctype 
498                      (cons 'unknown-ctype                             
499                            (append (mapcar #'class-name 
500                                            (class-direct-subclasses (find-class 'args-ctype)))
501                                    (mapcar #'class-name 
502                                            (class-direct-subclasses (find-class 'ctype)))))))))
503
504
505(setf (type-predicate 'ctype) 'ctype-p)
506
507
508;;;; Function and Values types.
509;;;
510;;;    Pretty much all of the general type operations are illegal on VALUES
511;;; types, since we can't discriminate using them, do SUBTYPEP, etc.  FUNCTION
512;;; types are acceptable to the normal type operations, but are generally
513;;; considered to be equivalent to FUNCTION.  These really aren't true types in
514;;; any type theoretic sense, but we still parse them into CTYPE structures for
515;;; two reasons:
516;;; -- Parsing and unparsing work the same way, and indeed we can't tell
517;;;    whether a type is a function or values type without parsing it.
518;;; -- Many of the places that can be annotated with real types can also be
519;;;    annotated function or values types.
520
521;; Methods on the VALUES type class.
522
523(defun make-values-ctype (&key
524                          required
525                          optional
526                          rest
527                          keyp
528                          keywords
529                          allowp)
530  (%istruct 'values-ctype
531            (type-class-or-lose 'values)
532            nil
533            required
534            optional
535            rest
536            keyp
537            keywords
538            allowp
539           ))
540
541(defun values-ctype-p (x) (istruct-typep x 'values-ctype))
542(setf (type-predicate 'values-ctype) 'values-ctype-p)
543
544
545(define-type-method (values :simple-subtypep :complex-subtypep-arg1)
546                    (type1 type2)
547  (declare (ignore type2))
548  (error "Subtypep is illegal on this type:~%  ~S" (type-specifier type1)))
549
550(define-type-method (values :complex-subtypep-arg2)
551                    (type1 type2)
552  (declare (ignore type1))
553  (error "Subtypep is illegal on this type:~%  ~S" (type-specifier type2)))
554
555
556(define-type-method (values :unparse) (type)
557  (cons 'values (unparse-args-types type)))
558
559
560;;; TYPE=-LIST  --  Internal
561;;;
562;;;    Return true if List1 and List2 have the same elements in the same
563;;; positions according to TYPE=.  We return NIL, NIL if there is an uncertain
564;;; comparison.
565;;;
566(defun type=-list (list1 list2)
567  (declare (list list1 list2))
568  (do ((types1 list1 (cdr types1))
569       (types2 list2 (cdr types2)))
570      ((or (null types1) (null types2))
571       (if (or types1 types2)
572           (values nil t)
573           (values t t)))
574    (multiple-value-bind (val win)
575                               (type= (first types1) (first types2))
576      (unless win
577          (return (values nil nil)))
578      (unless val
579          (return (values nil t))))))
580
581(define-type-method (values :simple-=) (type1 type2)
582  (let ((rest1 (args-ctype-rest type1))
[279]583        (rest2 (args-ctype-rest type2)))
[6]584    (cond ((or (args-ctype-keyp type1) (args-ctype-keyp type2)
[279]585               (args-ctype-allowp type1) (args-ctype-allowp type2))
[6]586             (values nil nil))
587            ((and rest1 rest2 (type/= rest1 rest2))
588             (type= rest1 rest2))
589            ((or rest1 rest2)
590             (values nil t))
591            (t
592             (multiple-value-bind (req-val req-win)
[279]593                 (type=-list (values-ctype-required type1)
594                             (values-ctype-required type2))
[6]595               (multiple-value-bind (opt-val opt-win)
[279]596                   (type=-list (values-ctype-optional type1)
597                               (values-ctype-optional type2))
[6]598                 (values (and req-val opt-val) (and req-win opt-win))))))))
599
600
601;; Methods on the FUNCTION type class.
602
603
604(defun make-function-ctype (&key
605                            required
606                            optional
607                            rest
608                            keyp
609                            keywords
610                            allowp
611                            wild-args
612                            returns)
613  (%istruct 'function-ctype
614            (type-class-or-lose 'function)
615            nil
616            required
617            optional
618            rest
619            keyp
620            keywords
621            allowp
622            wild-args
623            returns
624           ))
625
626(defun function-ctype-p (x) (istruct-typep x 'function-ctype))
627(setf (type-predicate 'function-ctype) 'function-ctype-p)
628
629;;; A flag that we can bind to cause complex function types to be unparsed as
630;;; FUNCTION.  Useful when we want a type that we can pass to TYPEP.
631;;;
632(defvar *unparse-function-type-simplify* nil)
633
634(define-type-method (function :unparse) (type)
635  (if *unparse-function-type-simplify*
636    'function
637    (list 'function
638            (if (function-ctype-wild-args type)
639                '*
640                (unparse-args-types type))
641            (type-specifier
642             (function-ctype-returns type)))))
643
644;;; Since all function types are equivalent to FUNCTION, they are all subtypes
645;;; of each other.
646;;;
[279]647
[6]648(define-type-method (function :simple-subtypep) (type1 type2)
[279]649 (flet ((fun-type-simple-p (type)
650          (not (or (function-ctype-rest type)
651                   (function-ctype-keyp type))))
652        (every-csubtypep (types1 types2)
653          (loop
654             for a1 in types1
655             for a2 in types2
656             do (multiple-value-bind (res sure-p)
657                    (csubtypep a1 a2)
658                  (unless res (return (values res sure-p))))
659             finally (return (values t t)))))
660   (macrolet ((3and (x y)
661                `(multiple-value-bind (val1 win1) ,x
662                   (if (and (not val1) win1)
663                       (values nil t)
664                       (multiple-value-bind (val2 win2) ,y
665                         (if (and val1 val2)
666                             (values t t)
667                             (values nil (and win2 (not val2)))))))))
668     (3and (values-subtypep (function-ctype-returns type1)
669                            (function-ctype-returns type2))
670           (cond ((function-ctype-wild-args type2) (values t t))
671                 ((function-ctype-wild-args type1)
672                  (cond ((function-ctype-keyp type2) (values nil nil))
673                        ((not (function-ctype-rest type2)) (values nil t))
674                        ((not (null (function-ctype-required type2))) (values nil t))
675                        (t (3and (type= *universal-type* (function-ctype-rest type2))
676                                 (every/type #'type= *universal-type*
677                                             (function-ctype-optional type2))))))
678                 ((not (and (fun-type-simple-p type1)
679                            (fun-type-simple-p type2)))
680                  (values nil nil))
681                 (t (multiple-value-bind (min1 max1) (function-type-nargs type1)
682                      (multiple-value-bind (min2 max2) (function-type-nargs type2)
683                        (cond ((or (> max1 max2) (< min1 min2))
684                               (values nil t))
685                              ((and (= min1 min2) (= max1 max2))
686                               (3and (every-csubtypep (function-ctype-required type1)
687                                                      (function-ctype-required type2))
688                                     (every-csubtypep (function-ctype-optional type1)
689                                                      (function-ctype-optional type2))))
690                              (t (every-csubtypep
691                                  (concatenate 'list
692                                               (function-ctype-required type1)
693                                               (function-ctype-optional type1))
694                                  (concatenate 'list
695                                               (function-ctype-required type2)
696                                               (function-ctype-optional type2)))))))))))))
[6]697
[279]698
[6]699                   
700;(define-superclasses function (function))       
701
702
703;;; The union or intersection of two FUNCTION types is FUNCTION.
[279]704;;; (unless the types are type=)
[6]705;;;
706(define-type-method (function :simple-union) (type1 type2)
[279]707  (if (type= type1 type2)
708    type1
709    (specifier-type 'function)))
710
[6]711;;;
712(define-type-method (function :simple-intersection) (type1 type2)
[279]713  (if (type= type1 type2)
714    type1
715    (specifier-type 'function)))
[6]716
717
[12467]718(define-type-method (function :complex-intersection) (type1 type2)
719  (declare (type function-ctype type2))
720  (let ((function (specifier-type 'function)))
721    (if (eq type1 function)
722      type2
723      (type-intersection2 type1 function))))
724
725
726
[6]727;;; ### Not very real, but good enough for redefining transforms according to
728;;; type:
729;;;
730(define-type-method (function :simple-=) (type1 type2)
731  (values (equalp type1 type2) t))
732
733;;; The CONSTANT-TYPE structure represents a use of the CONSTANT-ARGUMENT "type
734;;; specifier", which is only meaningful in function argument type specifiers
735;;; used within the compiler.
736;;;
737
738(defun clone-type-class-methods (src-tc dest-tc)
739  (do* ((n (uvsize src-tc))
740        (i 2 (1+ i)))
741       ((= i n) dest-tc)
742    (declare (fixnum i n))
743    (setf (%svref dest-tc i)
744          (%svref src-tc i))))
745
746(clone-type-class-methods (type-class-or-lose 'values) (type-class-or-lose 'constant))
747
748(defun make-constant-ctype (&key type)
749  (%istruct 'constant-ctype
750            (type-class-or-lose 'constant)
751            nil
752            type))
753
754(defun constant-ctype-p (x) (istruct-typep x 'constant-ctype))
755(setf (type-predicate 'constant-ctype) 'constant-ctype-p)
756
757(define-type-method (constant :unparse) (type)
758  `(constant-argument ,(type-specifier (constant-ctype-type type))))
759
760(define-type-method (constant :simple-=) (type1 type2)
761  (type= (constant-ctype-type type1) (constant-ctype-type type2)))
762
[9892]763(def-type-translator constant-argument (type &environment env)
764  (make-constant-ctype :type (specifier-type type env)))
[6]765
766
767;;; Parse-Args-Types  --  Internal
768;;;
769;;;    Given a lambda-list like values type specification and a Args-Type
770;;; structure, fill in the slots in the structure accordingly.  This is used
771;;; for both FUNCTION and VALUES types.
772;;;
773
[9892]774(defun parse-args-types (lambda-list result &optional env)
[6]775  (multiple-value-bind (required optional restp rest keyp keys allowp aux)
776                           (parse-lambda-list lambda-list)
777    (when aux
778      (error "&Aux in a FUNCTION or VALUES type: ~S." lambda-list))
[9892]779    (flet ((parse (spec) (specifier-type spec env)))
780      (setf (args-ctype-required result) (mapcar #'parse required))
781      (setf (args-ctype-optional result) (mapcar #'parse optional))
782      (setf (args-ctype-rest result) (if restp (parse rest) nil))
783      (setf (args-ctype-keyp result) keyp)
784      (let* ((key-info ()))
785        (dolist (key keys)
[6]786          (when (or (atom key) (/= (length key) 2))
[279]787            (signal-program-error "Keyword type description is not a two-list: ~S." key))
[6]788          (let ((kwd (first key)))
789            (when (member kwd key-info :test #'eq :key #'(lambda (x) (key-info-name x)))
[279]790              (signal-program-error "Repeated keyword ~S in lambda list: ~S." kwd lambda-list))
[6]791            (push (make-key-info :name kwd
[9892]792                                 :type (parse (second key))) key-info)))
793        (setf (args-ctype-keywords result) (nreverse key-info)))
794      (setf (args-ctype-allowp result) allowp))))
[6]795
796;;; Unparse-Args-Types  --  Internal
797;;;
798;;;    Return the lambda-list like type specification corresponding
799;;; to a Args-Type.
800;;;
801(defun unparse-args-types (type)
802  (let* ((result ()))
803
804    (dolist (arg (args-ctype-required type))
805      (push (type-specifier arg) result))
806
807    (when (args-ctype-optional type)
808      (push '&optional result)
809      (dolist (arg (args-ctype-optional type))
810          (push (type-specifier arg) result)))
811
812    (when (args-ctype-rest type)
813      (push '&rest result)
814      (push (type-specifier (args-ctype-rest type)) result))
815
816    (when (args-ctype-keyp type)
817      (push '&key result)
818      (dolist (key (args-ctype-keywords type))
819          (push (list (key-info-name key)
820                    (type-specifier (key-info-type key))) result)))
821
822    (when (args-ctype-allowp type)
823      (push '&allow-other-keys result))
824
825    (nreverse result)))
826
[9892]827(def-type-translator function (&optional (args '*) (result '*) &environment env)
[6]828  (let ((res (make-function-ctype
[9892]829                :returns (values-specifier-type result env))))
[6]830    (if (eq args '*)
831        (setf (function-ctype-wild-args res) t)
[9892]832        (parse-args-types args res env))
[6]833    res))
834
[9892]835(def-type-translator values (&rest values &environment env)
[6]836  (let ((res (make-values-ctype)))
[9892]837    (parse-args-types values res env)
[279]838    (when (or (values-ctype-keyp res) (values-ctype-allowp res))
839      (signal-program-error "&KEY or &ALLOW-OTHER-KEYS in values type: ~s"
840                            res))
[6]841    res))
842
843;;; Single-Value-Type  --  Interface
844;;;
845;;;    Return the type of the first value indicated by Type.  This is used by
846;;; people who don't want to have to deal with values types.
847;;;
848(defun single-value-type (type)
849  (declare (type ctype type))
850  (cond ((values-ctype-p type)
851         (or (car (args-ctype-required type))
[279]852             (if (args-ctype-optional type)
853                 (type-union (car (args-ctype-optional type))
854                             (specifier-type 'null)))
[6]855             (args-ctype-rest type)
[279]856             (specifier-type 'null)))
[6]857        ((eq type *wild-type*)
858         *universal-type*)
859        (t
860         type)))
861
862
863;;; FUNCTION-TYPE-NARGS  --  Interface
864;;;
865;;;    Return the minmum number of arguments that a function can be called
866;;; with, and the maximum number or NIL.  If not a function type, return
867;;; NIL, NIL.
868;;;
869(defun function-type-nargs (type)
870  (declare (type ctype type))
871  (if (function-ctype-p type)
872    (let ((fixed (length (args-ctype-required type))))
873        (if (or (args-ctype-rest type)
874                  (args-ctype-keyp type)
875                  (args-ctype-allowp type))
876        (values fixed nil)
877        (values fixed (+ fixed (length (args-ctype-optional type))))))
878    (values nil nil)))
879
880
881;;; Values-Types  --  Interface
882;;;
883;;;    Determine if Type corresponds to a definite number of values.  The first
884;;; value is a list of the types for each value, and the second value is the
885;;; number of values.  If the number of values is not fixed, then return NIL
886;;; and :Unknown.
887;;;
888(defun values-types (type)
889  (declare (type ctype type))
890  (cond ((eq type *wild-type*)
891           (values nil :unknown))
892          ((not (values-ctype-p type))
893           (values (list type) 1))
894          ((or (args-ctype-optional type)
895               (args-ctype-rest type)
896               (args-ctype-keyp type)
897               (args-ctype-allowp type))
898           (values nil :unknown))
899          (t
900           (let ((req (args-ctype-required type)))
901             (values (mapcar #'single-value-type req) (length req))))))
902
903
904;;; Values-Type-Types  --  Internal
905;;;
906;;;    Return two values:
907;;; 1] A list of all the positional (fixed and optional) types.
908;;; 2] The rest type (if any).  If keywords allowed, *universal-type*.  If no
909;;;    keywords or rest, *empty-type*.
910;;;
[279]911(defun values-type-types (type &optional (default-type *empty-type*))
[12045]912  (declare (type values-ctype type))
[6]913  (values (append (args-ctype-required type)
[279]914                  (args-ctype-optional type))
[6]915            (cond ((args-ctype-keyp type) *universal-type*)
[279]916                  ((args-ctype-rest type))
917                  (t default-type))))
[6]918
919
920;;; Fixed-Values-Op  --  Internal
921;;;
922;;;    Return a list of Operation applied to the types in Types1 and Types2,
923;;; padding with Rest2 as needed.  Types1 must not be shorter than Types2.  The
924;;; second value is T if Operation always returned a true second value.
925;;;
926(defun fixed-values-op (types1 types2 rest2 operation)
927  (declare (list types1 types2) (type ctype rest2) (type function operation))
928  (let ((exact t))
929    (values (mapcar #'(lambda (t1 t2)
930                              (multiple-value-bind (res win)
[279]931                                  (funcall operation t1 t2)
[6]932                                (unless win (setq exact nil))
933                                res))
934                        types1
935                        (append types2
[279]936                                (make-list (- (length types1) (length types2))
937                                           :initial-element rest2)))
[6]938              exact)))
939
940;;; Coerce-To-Values  --  Internal
941;;;
942;;; If Type isn't a values type, then make it into one:
943;;;    <type>  ==>  (values type &rest t)
944;;;
945(defun coerce-to-values (type)
946  (declare (type ctype type))
947  (if (values-ctype-p type)
948    type
[279]949    (make-values-ctype :required (list type))))
[6]950
951
952;;; Args-Type-Op  --  Internal
953;;;
954;;;    Do the specified Operation on Type1 and Type2, which may be any type,
955;;; including Values types.  With values types such as:
956;;;    (values a0 a1)
957;;;    (values b0 b1)
958;;;
959;;; We compute the more useful result:
960;;;    (values (<operation> a0 b0) (<operation> a1 b1))
961;;;
962;;; Rather than the precise result:
963;;;    (<operation> (values a0 a1) (values b0 b1))
964;;;
965;;; This has the virtue of always keeping the values type specifier outermost,
966;;; and retains all of the information that is really useful for static type
967;;; analysis.  We want to know what is always true of each value independently.
968;;; It is worthless to know that IF the first value is B0 then the second will
969;;; be B1.
970;;;
971;;; If the values count signatures differ, then we produce result with the
972;;; required value count chosen by Nreq when applied to the number of required
973;;; values in type1 and type2.  Any &key values become &rest T (anyone who uses
974;;; keyword values deserves to lose.)
975;;;
976;;; The second value is true if the result is definitely empty or if Operation
977;;; returned true as its second value each time we called it.  Since we
978;;; approximate the intersection of values types, the second value being true
979;;; doesn't mean the result is exact.
980;;;
[279]981(defun args-type-op (type1 type2 operation nreq default-type)
982  (declare (type ctype type1 type2 default-type)
983           (type function operation nreq))
984  (if (eq type1 type2)
985    (values type1 t)
986    (if (or (values-ctype-p type1) (values-ctype-p type2))
987      (let ((type1 (coerce-to-values type1))
[6]988            (type2 (coerce-to-values type2)))
989        (multiple-value-bind (types1 rest1)
[279]990            (values-type-types type1 default-type)
[6]991          (multiple-value-bind (types2 rest2)
[279]992              (values-type-types type2 default-type)
[6]993            (multiple-value-bind (rest rest-exact)
[279]994                (funcall operation rest1 rest2)
[6]995              (multiple-value-bind
996                  (res res-exact)
997                  (if (< (length types1) (length types2))
[279]998                    (fixed-values-op types2 types1 rest1 operation)
999                    (fixed-values-op types1 types2 rest2 operation))
1000                (let* ((req (funcall nreq
1001                                     (length (args-ctype-required type1))
1002                                     (length (args-ctype-required type2))))
1003                       (required (subseq res 0 req))
1004                       (opt (subseq res req))
1005                       (opt-last (position rest opt :test-not #'type=
1006                                           :from-end t)))
1007                  (if (find *empty-type* required :test #'type=)
1008                    (values *empty-type* t)
1009                    (values (make-values-ctype
1010                             :required required
1011                             :optional (if opt-last
1012                                         (subseq opt 0 (1+ opt-last))
1013                                         ())
1014                             :rest (if (eq rest *empty-type*) nil rest))
1015                            (and rest-exact res-exact)))))))))
1016      (funcall operation type1 type2))))
[6]1017
1018;;; Values-Type-Union, Values-Type-Intersection  --  Interface
1019;;;
1020;;;    Do a union or intersection operation on types that might be values
1021;;; types.  The result is optimized for utility rather than exactness, but it
1022;;; is guaranteed that it will be no smaller (more restrictive) than the
1023;;; precise result.
1024;;;
1025
1026(defun values-type-union (type1 type2)
1027  (declare (type ctype type1 type2))
1028  (cond ((or (eq type1 *wild-type*) (eq type2 *wild-type*)) *wild-type*)
[279]1029        ((eq type1 *empty-type*) type2)
1030        ((eq type2 *empty-type*) type1)
1031        (t
1032         (values (args-type-op type1 type2 #'type-union #'min *empty-type*)))))
[6]1033
1034(defun values-type-intersection (type1 type2)
1035  (declare (type ctype type1 type2))
1036  (cond ((eq type1 *wild-type*) (values type2 t))
1037        ((eq type2 *wild-type*) (values type1 t))
1038        (t
[279]1039         (args-type-op type1 type2 #'type-intersection #'max
1040                       (specifier-type 'null)))))
[6]1041
1042
1043;;; Values-Types-Intersect  --  Interface
1044;;;
1045;;;    Like Types-Intersect, except that it sort of works on values types.
1046;;; Note that due to the semantics of Values-Type-Intersection, this might
1047;;; return {T, T} when there isn't really any intersection (?).
1048;;;
1049(defun values-types-intersect (type1 type2)
1050  (cond ((or (eq type1 *empty-type*) (eq type2 *empty-type*))
1051           (values t t))
1052          ((or (values-ctype-p type1) (values-ctype-p type2))
1053           (multiple-value-bind (res win)
1054                                    (values-type-intersection type1 type2)
1055             (values (not (eq res *empty-type*))
1056                       win)))
1057          (t
1058           (types-intersect type1 type2))))
1059
1060;;; Values-Subtypep  --  Interface
1061;;;
1062;;;    A subtypep-like operation that can be used on any types, including
1063;;; values types.
1064;;;
1065
1066(defun values-subtypep (type1 type2)
1067  (declare (type ctype type1 type2))
1068  (cond ((eq type2 *wild-type*) (values t t))
[279]1069        ((eq type1 *wild-type*)
1070         (values (eq type2 *universal-type*) t))
1071        ((not (values-types-intersect type1 type2))
1072         (values nil t))
1073        (t
1074         (if (or (values-ctype-p type1) (values-ctype-p type2))
1075           (let ((type1 (coerce-to-values type1))
1076                 (type2 (coerce-to-values type2)))
1077             (multiple-value-bind (types1 rest1)
1078                 (values-type-types type1)
1079               (multiple-value-bind (types2 rest2)
1080                   (values-type-types type2)
1081                 (cond ((< (length (values-ctype-required type1))
1082                           (length (values-ctype-required type2)))
1083                        (values nil t))
1084                       ((< (length types1) (length types2))
1085                        (values nil nil))
1086                       ((or (values-ctype-keyp type1)
1087                            (values-ctype-keyp type2))
1088                        (values nil nil))
1089                       (t
1090                        (do ((t1 types1 (rest t1))
1091                             (t2 types2 (rest t2)))
1092                            ((null t2)
1093                             (csubtypep rest1 rest2))
1094                          (multiple-value-bind
1095                              (res win-p)
1096                              (csubtypep (first t1) (first t2))
1097                            (unless win-p
1098                              (return (values nil nil)))
1099                            (unless res
1100                              (return (values nil t))))))))))
1101           (csubtypep type1 type2)))))
[6]1102 
1103
1104;;;; Type method interfaces:
1105
1106;;; Csubtypep  --  Interface
1107;;;
1108;;;    Like subtypep, only works on Type structures.
1109;;;
1110(defun csubtypep (type1 type2)
1111  (declare (type ctype type1 type2))
1112  (unless (typep type1 'ctype)
1113    (report-bad-arg type1 'ctype))
1114  (unless (typep type2 'ctype)
1115    (report-bad-arg type2 'ctype))
1116  (cond ((or (eq type1 type2)
[279]1117             (eq type1 *empty-type*)
1118             (eq type2 *wild-type*))
1119         (values t t))
1120        (t
1121         (invoke-type-method :simple-subtypep :complex-subtypep-arg2
1122                             type1 type2
1123                             :complex-arg1 :complex-subtypep-arg1))))
[10426]1124
1125;;; Type1 is a type-epecifier; type2 is a TYPE-CELL which may cache
1126;;; a mapping between a type-specifier and a CTYPE.
1127(defun cell-csubtypep-2 (type-specifier type-cell)
1128  (let* ((type1 (specifier-type type-specifier))
1129         (type2 (or (type-cell-ctype type-cell)
1130                    (let* ((ctype (specifier-type
1131                                   (type-cell-type-specifier type-cell))))
1132                      (when (cacheable-ctype-p ctype)
1133                        (setf (type-cell-ctype type-cell) ctype))
1134                      ctype))))
1135    (cond ((or (eq type1 type2)
1136               (eq type1 *empty-type*)
1137               (eq type2 *wild-type*))
1138           (values t t))
1139          (t
1140           (invoke-type-method :simple-subtypep :complex-subtypep-arg2
1141                               type1 type2
1142                               :complex-arg1 :complex-subtypep-arg1)))))
1143                             
1144
1145
[6]1146;;; Type=  --  Interface
1147;;;
1148;;;    If two types are definitely equivalent, return true.  The second value
1149;;; indicates whether the first value is definitely correct.  This should only
1150;;; fail in the presence of Hairy types.
1151;;;
1152
1153(defun type= (type1 type2)
1154   (declare (type ctype type1 type2))
1155   (if (eq type1 type2)
1156     (values t t)
1157     (invoke-type-method :simple-= :complex-= type1 type2)))
1158
1159;;; TYPE/=  --  Interface
1160;;;
1161;;;    Not exactly the negation of TYPE=, since when the relationship is
1162;;; uncertain, we still return NIL, NIL.  This is useful in cases where the
1163;;; conservative assumption is =.
1164;;;
1165(defun type/= (type1 type2)
1166  (declare (type ctype type1 type2))
1167  (multiple-value-bind (res win)
[279]1168      (type= type1 type2)
[6]1169    (if win
1170        (values (not res) t)
1171        (values nil nil))))
1172
1173;;; Type-Union  --  Interface
1174;;;
1175;;;    Find a type which includes both types.  Any inexactness is represented
1176;;; by the fuzzy element types; we return a single value that is precise to the
1177;;; best of our knowledge.  This result is simplified into the canonical form,
1178;;; thus is not a UNION type unless there is no other way to represent the
1179;;; result.
1180;;;
1181
[279]1182(defun type-union (&rest input-types)
1183  (%type-union input-types))
1184
1185(defun %type-union (input-types)
1186  (let* ((simplified (simplify-unions input-types)))
1187    (cond ((null simplified) *empty-type*)
1188          ((null (cdr simplified)) (car simplified))
1189          (t (make-union-ctype simplified)))))
1190
1191(defun simplify-unions (types)
1192  (when types
1193    (multiple-value-bind (first rest)
1194        (if (union-ctype-p (car types))
1195          (values (car (union-ctype-types (car types)))
1196                  (append (cdr (union-ctype-types (car types)))
1197                          (cdr types)))
1198          (values (car types) (cdr types)))
1199      (let ((rest (simplify-unions rest)) u)
1200        (dolist (r rest (cons first rest))
1201          (when (setq u (type-union2 first r))
1202            (return (simplify-unions (nsubstitute u r rest)))))))))
1203
1204(defun type-union2 (type1 type2)
[6]1205  (declare (type ctype type1 type2))
[279]1206  (setq type1 (reparse-unknown-ctype type1))
1207  (setq type2 (reparse-unknown-ctype type2))
1208  (cond ((eq type1 type2) type1)
1209        ((csubtypep type1 type2) type2)
1210        ((csubtypep type2 type1) type1)
1211        (t
1212         (flet ((1way (x y)
1213                  (invoke-type-method :simple-union :complex-union
1214                                      x y
1215                                      :default nil)))
1216           (or (1way type1 type2)
1217               (1way type2 type1))))))
[6]1218
[279]1219;;; Return as restrictive and simple a type as we can discover that is
1220;;; no more restrictive than the intersection of TYPE1 and TYPE2. At
1221;;; worst, we arbitrarily return one of the arguments as the first
1222;;; value (trying not to return a hairy type).
1223(defun type-approx-intersection2 (type1 type2)
[12467]1224  (declare (type ctype type1 type2))
[279]1225  (cond ((type-intersection2 type1 type2))
1226        ((hairy-ctype-p type1) type2)
1227        (t type1)))
1228
1229
[6]1230;;; Type-Intersection  --  Interface
1231;;;
1232;;;    Return as restrictive a type as we can discover that is no more
1233;;; restrictive than the intersection of Type1 and Type2.  The second value is
1234;;; true if the result is exact.  At worst, we randomly return one of the
1235;;; arguments as the first value (trying not to return a hairy type).
1236;;;
1237
[279]1238(defun type-intersection (&rest input-types)
1239  (%type-intersection input-types))
1240
1241(defun %type-intersection (input-types)
1242  (let ((simplified (simplify-intersections input-types)))
[5602]1243    ;;(declare (type (vector ctype) simplified))
[279]1244    ;; We want to have a canonical representation of types (or failing
1245    ;; that, punt to HAIRY-TYPE). Canonical representation would have
1246    ;; intersections inside unions but not vice versa, since you can
1247    ;; always achieve that by the distributive rule. But we don't want
1248    ;; to just apply the distributive rule, since it would be too easy
1249    ;; to end up with unreasonably huge type expressions. So instead
1250    ;; we try to generate a simple type by distributing the union; if
1251    ;; the type can't be made simple, we punt to HAIRY-TYPE.
1252    (if (and (cdr simplified) (some #'union-ctype-p simplified))
[5602]1253      (let* ((first-union (find-if #'union-ctype-p simplified))
1254             (other-types (remove first-union simplified))
1255             (distributed (maybe-distribute-one-union first-union other-types)))
1256        (if distributed
1257          (apply #'type-union distributed)
1258          (make-hairy-ctype
1259           :specifier `(and ,@(mapcar #'type-specifier simplified)))))
1260      (cond
1261        ((null simplified) *universal-type*)
1262        ((null (cdr simplified)) (car simplified))
1263        (t (make-intersection-ctype
1264            (some #'(lambda (c) (ctype-enumerable c)) simplified)
1265            simplified))))))
[279]1266
1267(defun simplify-intersections (types)
1268  (when types
[12467]1269    (let ((first (if (typep (car types) 'ctype)
1270                   (%car types)
1271                   (specifier-type (%car types)))))
1272      (multiple-value-bind (first rest)
1273          (if (intersection-ctype-p first)
1274            (values (car (intersection-ctype-types first))
1275                    (append (cdr (intersection-ctype-types first))
[279]1276                            (cdr types)))
[12467]1277            (values first (cdr types)))
1278        (let ((rest (simplify-intersections rest)) u)
1279          (dolist (r rest (cons first rest))
1280            (when (setq u (type-intersection2 first r))
1281              (return (simplify-intersections (nsubstitute u r rest))))))))))
[279]1282
1283(defun type-intersection2 (type1 type2)
[6]1284  (declare (type ctype type1 type2))
[279]1285  (setq type1 (reparse-unknown-ctype type1))
1286  (setq type2 (reparse-unknown-ctype type2))
1287  (cond ((eq type1 type2)
1288         type1)
1289        ((or (intersection-ctype-p type1)
1290             (intersection-ctype-p type2))
1291         ;; Intersections of INTERSECTION-TYPE should have the
1292         ;; INTERSECTION-CTYPE-TYPES values broken out and intersected
1293         ;; separately. The full TYPE-INTERSECTION function knows how
1294         ;; to do that, so let it handle it.
1295         (type-intersection type1 type2))
1296        ;;
1297        ;; (AND (FUNCTION (T) T) GENERIC-FUNCTION) for instance, but
1298        ;; not (AND (FUNCTION (T) T) (FUNCTION (T) T)).
1299        ((let ((function (specifier-type 'function)))
1300           (or (and (function-ctype-p type1)
[12467]1301                    (not (function-ctype-p type2))
1302                    (neq function type2)
[279]1303                    (csubtypep type2 function)
1304                    (not (csubtypep function type2)))
1305               (and (function-ctype-p type2)
[12467]1306                    (not (function-ctype-p type1))
1307                    (neq function type1)
[279]1308                    (csubtypep type1 function)
1309                    (not (csubtypep function type1)))))
1310         nil)
1311        (t
1312         (flet ((1way (x y)
1313                  (invoke-type-method :simple-intersection
1314                                      :complex-intersection
1315                                      x y
1316                                      :default :no-type-method-found)))
1317           (let ((xy (1way type1 type2)))
1318             (or (and (not (eql xy :no-type-method-found)) xy)
1319                 (let ((yx (1way type2 type1)))
1320                   (or (and (not (eql yx :no-type-method-found)) yx)
1321                       (cond ((and (eql xy :no-type-method-found)
1322                                   (eql yx :no-type-method-found))
1323                              *empty-type*)
1324                             (t
1325                              nil))))))))))
[6]1326
[279]1327
1328
1329(defun maybe-distribute-one-union (union-type types)
1330  (let* ((intersection (apply #'type-intersection types))
1331         (union (mapcar (lambda (x) (type-intersection x intersection))
1332                        (union-ctype-types union-type))))
1333    (if (notany (lambda (x)
1334                  (or (hairy-ctype-p x)
1335                      (intersection-ctype-p x)))
1336                union)
1337        union
1338        nil)))
1339
[6]1340;;; Types-Intersect  --  Interface
1341;;;
1342;;;    The first value is true unless the types don't intersect.  The second
1343;;; value is true if the first value is definitely correct.  NIL is considered
1344;;; to intersect with any type.  If T is a subtype of either type, then we also
1345;;; return T, T.  This way we consider hairy types to intersect with T.
1346;;;
1347(defun types-intersect (type1 type2)
1348  (declare (type ctype type1 type2))
1349  (if (or (eq type1 *empty-type*) (eq type2 *empty-type*))
1350      (values t t)
[279]1351      (let ((intersection2 (type-intersection2 type1 type2)))
1352        (cond ((not intersection2)
[6]1353               (if (or (csubtypep *universal-type* type1)
1354                       (csubtypep *universal-type* type2))
1355                   (values t t)
1356                   (values t nil)))
[279]1357              ((eq intersection2 *empty-type*) (values nil t))
[6]1358              (t (values t t))))))
1359
1360;;; Type-Specifier  --  Interface
1361;;;
1362;;;    Return a Common Lisp type specifier corresponding to this type.
1363;;;
1364(defun type-specifier (type)
[117]1365  (unless (ctype-p type)
1366    (setq type (require-type type 'ctype)))
1367  (locally 
1368      (declare (type ctype type))
1369    (funcall (type-class-unparse (ctype-class-info type)) type)))
[6]1370
[11665]1371
1372(defconstant compound-only-type-specifiers
1373  ;; See CLHS Figure 4-4.
1374  '(and mod satisfies eql not values member or))
1375
1376
[6]1377;;; VALUES-SPECIFIER-TYPE  --  Interface
1378;;;
1379;;;    Return the type structure corresponding to a type specifier.  We pick
1380;;; off Structure types as a special case.
1381;;;
1382
[9892]1383(defun values-specifier-type-internal (orig env)
[6]1384  (or (info-type-builtin orig) ; this table could contain bytes etal and ands ors nots of built-in types - no classes
1385     
[9892]1386      ;; Now that we have our hands on the environment, we could pass it into type-expand,
1387      ;; but we'd have no way of knowing whether the expansion depended on the env, so
1388      ;; we wouldn't know if the result is safe to cache.   So for now don't let type
1389      ;; expanders see the env, which just means they won't see compile-time types.
1390      (let ((spec (type-expand orig #+not-yet env)))
[6]1391        (cond
1392         ((and (not (eq spec orig))
1393               (info-type-builtin spec)))
[9892]1394         ((or (eq (info-type-kind spec) :instance)
1395              (and (symbolp spec)
1396                   (typep (find-class spec nil env) 'compile-time-class)))
1397          (let* ((class-ctype (%class.ctype (find-class spec t env))))
[6]1398            (or (class-ctype-translation class-ctype)
1399                class-ctype)))
1400         ((typep spec 'class)
1401          (let* ((class-ctype (%class.ctype spec)))
1402            (or (class-ctype-translation class-ctype)
1403                class-ctype)))
1404         ((let ((cell (find-builtin-cell spec nil)))
1405           (and cell (cdr cell))))
1406         (t
[11665]1407          (when (member spec compound-only-type-specifiers)
1408            (error 'invalid-type-specifier :typespec spec))
[6]1409          (let* ((lspec (if (atom spec) (list spec) spec))
1410                 (fun (info-type-translator (car lspec))))
[9892]1411            (cond (fun (funcall fun lspec env))
[11665]1412                  ((or (and (consp spec)
1413                            (symbolp (car spec))
1414                            (not (or (find-class (car spec) nil env)
1415                                     (info-type-builtin (car spec)))))
[6]1416                       (symbolp spec))
1417                   (when *type-system-initialized*
1418                     (signal 'parse-unknown-type :specifier spec))
1419                   ;;
1420                   ;; Inhibit caching...
1421                   nil)
1422                  (t
[11665]1423                   (error 'invalid-type-specifier :typespec spec)))))))))
[6]1424
1425(eval-when (:compile-toplevel :execute)
[297]1426  (defconstant type-cache-size (ash 1 12))
[6]1427  (defconstant type-cache-mask (1- type-cache-size)))
1428
[9892]1429(defun compile-time-ctype-p (ctype)
1430  (and (typep ctype 'class-ctype)
1431       (typep (class-ctype-class ctype) 'compile-time-class)))
1432
1433
[586]1434;;; We can get in trouble if we try to cache certain kinds of ctypes,
1435;;; notably MEMBER types which refer to objects which might
1436;;; be stack-allocated or might be EQUAL without being EQL.
1437(defun cacheable-ctype-p (ctype)
[10309]1438  (case (istruct-cell-name (%svref ctype 0))
[586]1439    (member-ctype
1440     (dolist (m (member-ctype-members ctype) t)
1441       (when (or (typep m 'cons)
1442                 (typep m 'array))
[589]1443         (return nil))))
[586]1444    (union-ctype
1445     (every #'cacheable-ctype-p (union-ctype-types ctype)))
1446    (intersection-ctype
1447     (every #'cacheable-ctype-p (intersection-ctype-types ctype)))
1448    (array-ctype
1449     (cacheable-ctype-p (array-ctype-element-type ctype)))
1450    ((values-ctype function-ctype)
1451     (and (every #'cacheable-ctype-p (values-ctype-required ctype))
1452          (every #'cacheable-ctype-p (values-ctype-optional ctype))
1453          (let* ((rest (values-ctype-rest ctype)))
1454            (or (null rest) (cacheable-ctype-p rest)))
1455          (every #'(lambda (info)
1456                     (cacheable-ctype-p (key-info-type info)))
1457                 (values-ctype-keywords ctype))
[10309]1458          (or (not (eq (istruct-cell-name (%svref ctype 0)) 'function-ctype))
[586]1459              (let* ((result (function-ctype-returns ctype)))
1460                (or (null result)
1461                    (cacheable-ctype-p result))))))
[589]1462    (negation-ctype
1463     (cacheable-ctype-p (negation-ctype-type ctype)))
1464    (cons-ctype
1465     (and (cacheable-ctype-p (cons-ctype-car-ctype ctype))
1466          (cacheable-ctype-p (cons-ctype-cdr-ctype ctype))))
[9250]1467    (unknown-ctype nil)
[9892]1468    (class-ctype
1469     (not (typep (class-ctype-class ctype) 'compile-time-class)))
[1668]1470    ;; Anything else ?  Simple things (numbers, classes) can't lose.
[586]1471    (t t)))
1472               
1473     
1474   
1475
[6]1476(defun hash-type-specifier (spec)
1477  (logand (sxhash spec) type-cache-mask))
1478
[13099]1479
[6]1480(let* ((type-cache-specs (make-array type-cache-size))
1481       (type-cache-ctypes (make-array type-cache-size))
1482       (probes 0)
1483       (hits 0)
1484       (ncleared 0)
[13099]1485       (locked nil)
1486       (lock (make-lock)))
[6]1487 
1488  (defun clear-type-cache ()
[13099]1489    (with-lock-grabbed (lock)
1490      (%init-misc 0 type-cache-specs)
1491      (%init-misc 0 type-cache-ctypes)
1492      (incf ncleared))
[6]1493    nil)
1494
[9892]1495  (defun values-specifier-type (spec &optional env)
[6]1496    (if (typep spec 'class)
1497      (let* ((class-ctype (%class.ctype spec)))
1498        (or (class-ctype-translation class-ctype) class-ctype))
[13099]1499      (handler-case
1500          (with-lock-grabbed (lock)
1501            (if locked
1502              (or (values-specifier-type-internal spec env)
1503                  (make-unknown-ctype :specifier spec))
1504              (unwind-protect
1505                   (progn
1506                     (setq locked t)
1507                     (if (or (symbolp spec)
1508                             (and (consp spec)
1509                                  (symbolp (car spec))
1510                                  ;; hashing scheme uses equal, so only use when equivalent to eql
1511                                  (not (and (eq (car spec) 'member)
1512                                            (some (lambda (x)
1513                                                    (typep x '(or cons string bit-vector pathname)))
1514                                                  (cdr spec))))))
1515                       (let* ((idx (hash-type-specifier spec)))
1516                         (incf probes)
1517                         (if (equal (svref type-cache-specs idx) spec)
1518                           (progn
1519                             (incf hits)
1520                             (svref type-cache-ctypes idx))
1521                           (let* ((ctype (values-specifier-type-internal spec env)))
1522                             (if ctype
1523                               (progn
1524                                 (when (cacheable-ctype-p ctype)
[15405]1525                                   (let* ((spec (copy-tree spec)))  ; in case it was stack-consed
1526                                     (without-interrupts
1527                                      (setf (svref type-cache-specs idx) spec
1528                                            (svref type-cache-ctypes idx) ctype))))
[13099]1529                                 ctype)
1530                               (make-unknown-ctype :specifier spec)))))
1531                       (values-specifier-type-internal spec env)))
1532                (setq locked nil))))
1533        (error (condition) (error condition)))))
[6]1534 
1535  (defun type-cache-hit-rate ()
1536    (values hits probes))
1537 
1538  (defun type-cache-locked-p ()
1539    locked)
1540
1541  (defun lock-type-cache ()
1542    (setq locked t)))
1543                   
1544
1545 
1546
1547;;; SPECIFIER-TYPE  --  Interface
1548;;;
1549;;;    Like VALUES-SPECIFIER-TYPE, except that we guarantee to never return a
1550;;; VALUES type.
1551;;;
[9887]1552(defun specifier-type (x &optional env)
[9892]1553  (let ((res (values-specifier-type x env)))
[6]1554    (when (values-ctype-p res)
[279]1555      (signal-program-error "VALUES type illegal in this context:~%  ~S" x))
[6]1556    res))
1557
[9892]1558(defun single-value-specifier-type (x &optional env)
1559  (let ((res (specifier-type x env)))
[279]1560    (if (eq res *wild-type*)
1561        *universal-type*
1562        res)))
[6]1563
[9892]1564(defun standardized-type-specifier (spec &optional env)
1565  (handler-case
1566      (type-specifier (specifier-type spec env))
[12045]1567    (program-error () spec)
[9892]1568    (parse-unknown-type () spec)))
[9240]1569
[279]1570(defun modified-numeric-type (base
1571                              &key
1572                              (class      (numeric-ctype-class      base))
1573                              (format     (numeric-ctype-format     base))
1574                              (complexp   (numeric-ctype-complexp   base))
1575                              (low        (numeric-ctype-low        base))
1576                              (high       (numeric-ctype-high       base))
1577                              (enumerable (ctype-enumerable base)))
1578  (make-numeric-ctype :class class
1579                     :format format
1580                     :complexp complexp
1581                     :low low
1582                     :high high
1583                     :enumerable enumerable))
1584
[6]1585;;; Precompute-Types  --  Interface
1586;;;
1587;;;    Take a list of type specifiers, compute the translation and define it as
1588;;; a builtin type.
1589;;;
1590 
1591(defun precompute-types (specs)
1592  (dolist (spec specs)
1593    (let ((res (specifier-type spec)))
1594      (when (numeric-ctype-p res)
1595        (let ((pred (make-numeric-ctype-predicate res)))
1596          (when pred (setf (numeric-ctype-predicate res) pred))))
1597      (unless (unknown-ctype-p res)
[11665]1598        (setf (info-type-builtin spec) res)
1599        (setf (info-type-kind spec) :primitive)))))
[6]1600
1601;;;; Builtin types.
1602
1603;;; The NAMED-TYPE is used to represent *, T and NIL.  These types must be
1604;;; super or sub types of all types, not just classes and * & NIL aren't
1605;;; classes anyway, so it wouldn't make much sense to make them built-in
1606;;; classes.
1607;;;
1608
1609(defun define-named-ctype (name)
1610  (let* ((ctype (%istruct 'named-ctype
1611                          (type-class-or-lose 'named)
1612                          nil
1613                          name)))
1614    (setf (info-type-kind name) :builtin
1615          (info-type-builtin name) ctype)))
1616
1617
1618(defvar *wild-type* (define-named-ctype '*))
1619(defvar *empty-type* (define-named-ctype nil))
1620(defvar *universal-type* (define-named-ctype t))
1621
[7917]1622(defun named-ctype-p (x)
1623  (istruct-typep x 'named-ctype))
1624
1625(setf (type-predicate 'named-ctype) 'named-ctype-p)
1626
[6]1627(define-type-method (named :simple-=) (type1 type2)
1628  (values (eq type1 type2) t))
1629
[279]1630(define-type-method (named :complex-=) (type1 type2)
1631  (cond
1632    ((and (eq type2 *empty-type*)
1633          (intersection-ctype-p type1)
1634          ;; not allowed to be unsure on these... FIXME: keep the list
1635          ;; of CL types that are intersection types once and only
1636          ;; once.
1637          (not (or (type= type1 (specifier-type 'ratio))
1638                   (type= type1 (specifier-type 'keyword)))))
1639     ;; things like (AND (EQL 0) (SATISFIES ODDP)) or (AND FUNCTION
1640     ;; STREAM) can get here.  In general, we can't really tell
1641     ;; whether these are equal to NIL or not, so
1642     (values nil nil))
1643    ((type-might-contain-other-types-p type1)
1644     (invoke-complex-=-other-method type1 type2))
1645    (t (values nil t))))
1646
1647
[6]1648(define-type-method (named :simple-subtypep) (type1 type2)
1649  (values (or (eq type1 *empty-type*) (eq type2 *wild-type*)) t))
1650
1651(define-type-method (named :complex-subtypep-arg1) (type1 type2)
[279]1652  (cond ((eq type1 *empty-type*)
1653         t)
1654        (;; When TYPE2 might be the universal type in disguise
1655         (type-might-contain-other-types-p type2)
1656         ;; Now that the UNION and HAIRY COMPLEX-SUBTYPEP-ARG2 methods
1657         ;; can delegate to us (more or less as CALL-NEXT-METHOD) when
1658         ;; they're uncertain, we can't just barf on COMPOUND-TYPE and
1659         ;; HAIRY-TYPEs as we used to. Instead we deal with the
1660         ;; problem (where at least part of the problem is cases like
1661         ;;   (SUBTYPEP T '(SATISFIES FOO))
1662         ;; or
1663         ;;   (SUBTYPEP T '(AND (SATISFIES FOO) (SATISFIES BAR)))
1664         ;; where the second type is a hairy type like SATISFIES, or
1665         ;; is a compound type which might contain a hairy type) by
1666         ;; returning uncertainty.
1667         (values nil nil))
1668        (t
1669         ;; By elimination, TYPE1 is the universal type.
1670         (assert (or (eq type1 *wild-type*) (eq type1 *universal-type*)))
1671         ;; This case would have been picked off by the SIMPLE-SUBTYPEP
1672         ;; method, and so shouldn't appear here.
1673         (assert (not (eq type2 *universal-type*)))
1674         ;; Since TYPE2 is not EQ *UNIVERSAL-TYPE* and is not the
1675         ;; universal type in disguise, TYPE2 is not a superset of TYPE1.
1676         (values nil t))))
[6]1677
[279]1678
[6]1679(define-type-method (named :complex-subtypep-arg2) (type1 type2)
[279]1680  (assert (not (eq type2 *wild-type*))) ; * isn't really a type.
1681  (cond ((eq type2 *universal-type*)
1682         (values t t))
1683        ((type-might-contain-other-types-p type1)
1684         ;; those types can be *EMPTY-TYPE* or *UNIVERSAL-TYPE* in
1685         ;; disguise.  So we'd better delegate.
1686         (invoke-complex-subtypep-arg1-method type1 type2))
1687        (t
1688         ;; FIXME: This seems to rely on there only being 2 or 3
1689         ;; NAMED-TYPE values, and the exclusion of various
1690         ;; possibilities above. It would be good to explain it and/or
1691         ;; rewrite it so that it's clearer.
1692         (values (not (eq type2 *empty-type*)) t))))
[6]1693
[279]1694
[6]1695(define-type-method (named :complex-intersection) (type1 type2)
[279]1696  (hierarchical-intersection2 type1 type2))
[6]1697
1698(define-type-method (named :unparse) (x)
1699  (named-ctype-name x))
1700
1701
1702;;;; Hairy and unknown types:
1703
[279]1704;;; The Hairy-Type represents anything too wierd to be described
1705;;; reasonably or to be useful, such as SATISFIES.  We just remember
1706;;; the original type spec.
[6]1707;;;
1708
1709(defun make-hairy-ctype (&key specifier (enumerable t))
1710  (%istruct 'hairy-ctype
1711            (type-class-or-lose 'hairy)
1712            enumerable
1713            specifier))
1714
1715(defun hairy-ctype-p (x)
[10426]1716  (or (istruct-typep x 'hairy-ctype)
1717      (istruct-typep x 'unknown-ctype)))
[6]1718
1719(setf (type-predicate 'hairy-ctype) 'hairy-ctype-p)
1720
1721(define-type-method (hairy :unparse) (x) (hairy-ctype-specifier x))
1722
1723(define-type-method (hairy :simple-subtypep) (type1 type2)
1724  (let ((hairy-spec1 (hairy-ctype-specifier type1))
1725        (hairy-spec2 (hairy-ctype-specifier type2)))
[279]1726    (cond ((equal-but-no-car-recursion hairy-spec1 hairy-spec2)
[6]1727           (values t t))
1728          (t
1729           (values nil nil)))))
1730
1731(define-type-method (hairy :complex-subtypep-arg2) (type1 type2)
[279]1732  (invoke-complex-subtypep-arg1-method type1 type2))
[6]1733
1734(define-type-method (hairy :complex-subtypep-arg1) (type1 type2)
1735  (declare (ignore type1 type2))
1736  (values nil nil))
1737
[279]1738(define-type-method (hairy :complex-=) (type1 type2)
1739  (if (and (unknown-ctype-p type2)
1740           (let* ((specifier2 (unknown-ctype-specifier type2))
1741                  (name2 (if (consp specifier2)
1742                           (car specifier2)
1743                           specifier2)))
1744             (info-type-kind name2)))
1745      (let ((type2 (specifier-type (unknown-ctype-specifier type2))))
1746        (if (unknown-ctype-p type2)
1747            (values nil nil)
1748            (type= type1 type2)))
1749  (values nil nil)))
1750
[6]1751(define-type-method (hairy :simple-intersection :complex-intersection)
1752                    (type1 type2)
[279]1753  (if (type= type1 type2)
1754    type1
1755    nil))
[6]1756
1757
[279]1758(define-type-method (hairy :simple-union) 
1759    (type1 type2)
1760  (if (type= type1 type2)
1761      type1
1762      nil))
1763
[6]1764(define-type-method (hairy :simple-=) (type1 type2)
[279]1765  (if (equal-but-no-car-recursion (hairy-ctype-specifier type1)
1766                                  (hairy-ctype-specifier type2))
1767      (values t t)
1768      (values nil nil)))
[6]1769
1770
[279]1771
[6]1772(def-type-translator satisfies (&whole x fun)
[279]1773  (unless (symbolp fun)
1774    (report-bad-arg fun 'symbol))
[6]1775  (make-hairy-ctype :specifier x))
1776
[279]1777
1778;;; Negation Ctypes
1779(defun make-negation-ctype (&key type (enumerable t))
1780  (%istruct 'negation-ctype
1781            (type-class-or-lose 'negation)
1782            enumerable
1783            type))
[6]1784
[279]1785(defun negation-ctype-p (x)
1786  (istruct-typep x 'negation-ctype))
[6]1787
[279]1788(setf (type-predicate 'negation-ctype) 'negation-ctype-p)
[6]1789
[279]1790(define-type-method (negation :unparse) (x)
1791  `(not ,(type-specifier (negation-ctype-type x))))
1792
1793(define-type-method (negation :simple-subtypep) (type1 type2)
1794  (csubtypep (negation-ctype-type type2) (negation-ctype-type type1)))
1795
1796(define-type-method (negation :complex-subtypep-arg2) (type1 type2)
1797  (let* ((complement-type2 (negation-ctype-type type2))
1798         (intersection2 (type-intersection type1 complement-type2)))
1799    (if intersection2
1800        ;; FIXME: if uncertain, maybe try arg1?
1801        (type= intersection2 *empty-type*)
1802        (invoke-complex-subtypep-arg1-method type1 type2))))
1803
1804(define-type-method (negation :complex-subtypep-arg1) (type1 type2)
1805  (block nil
1806    ;; (Several logical truths in this block are true as long as
1807    ;; b/=T. As of sbcl-0.7.1.28, it seems impossible to construct a
1808    ;; case with b=T where we actually reach this type method, but
1809    ;; we'll test for and exclude this case anyway, since future
1810    ;; maintenance might make it possible for it to end up in this
1811    ;; code.)
1812    (multiple-value-bind (equal certain)
1813        (type= type2 *universal-type*)
1814      (unless certain
1815        (return (values nil nil)))
1816      (when equal
1817        (return (values t t))))
1818    (let ((complement-type1 (negation-ctype-type type1)))
1819      ;; Do the special cases first, in order to give us a chance if
1820      ;; subtype/supertype relationships are hairy.
1821      (multiple-value-bind (equal certain) 
1822          (type= complement-type1 type2)
1823        ;; If a = b, ~a is not a subtype of b (unless b=T, which was
1824        ;; excluded above).
1825        (unless certain
1826          (return (values nil nil)))
1827        (when equal
1828          (return (values nil t))))
1829      ;; KLUDGE: ANSI requires that the SUBTYPEP result between any
1830      ;; two built-in atomic type specifiers never be uncertain. This
1831      ;; is hard to do cleanly for the built-in types whose
1832      ;; definitions include (NOT FOO), i.e. CONS and RATIO. However,
1833      ;; we can do it with this hack, which uses our global knowledge
1834      ;; that our implementation of the type system uses disjoint
1835      ;; implementation types to represent disjoint sets (except when
1836      ;; types are contained in other types).  (This is a KLUDGE
1837      ;; because it's fragile. Various changes in internal
1838      ;; representation in the type system could make it start
1839      ;; confidently returning incorrect results.) -- WHN 2002-03-08
1840      (unless (or (type-might-contain-other-types-p complement-type1)
1841                  (type-might-contain-other-types-p type2))
1842        ;; Because of the way our types which don't contain other
1843        ;; types are disjoint subsets of the space of possible values,
1844        ;; (SUBTYPEP '(NOT AA) 'B)=NIL when AA and B are simple (and B
1845        ;; is not T, as checked above).
1846        (return (values nil t)))
1847      ;; The old (TYPE= TYPE1 TYPE2) branch would never be taken, as
1848      ;; TYPE1 and TYPE2 will only be equal if they're both NOT types,
1849      ;; and then the :SIMPLE-SUBTYPEP method would be used instead.
1850      ;; But a CSUBTYPEP relationship might still hold:
1851      (multiple-value-bind (equal certain)
1852          (csubtypep complement-type1 type2)
1853        ;; If a is a subtype of b, ~a is not a subtype of b (unless
1854        ;; b=T, which was excluded above).
1855        (unless certain
1856          (return (values nil nil)))
1857        (when equal
1858          (return (values nil t))))
1859      (multiple-value-bind (equal certain)
1860          (csubtypep type2 complement-type1)
1861        ;; If b is a subtype of a, ~a is not a subtype of b.  (FIXME:
1862        ;; That's not true if a=T. Do we know at this point that a is
1863        ;; not T?)
1864        (unless certain
1865          (return (values nil nil)))
1866        (when equal
1867          (return (values nil t))))
1868      ;; old CSR comment ca. 0.7.2, now obsoleted by the SIMPLE-CTYPE?
1869      ;; KLUDGE case above: Other cases here would rely on being able
1870      ;; to catch all possible cases, which the fragility of this type
1871      ;; system doesn't inspire me; for instance, if a is type= to ~b,
1872      ;; then we want T, T; if this is not the case and the types are
1873      ;; disjoint (have an intersection of *empty-type*) then we want
1874      ;; NIL, T; else if the union of a and b is the *universal-type*
1875      ;; then we want T, T. So currently we still claim to be unsure
1876      ;; about e.g. (subtypep '(not fixnum) 'single-float).
1877      ;;
1878      ;; OTOH we might still get here:
1879      (values nil nil))))
1880
1881(define-type-method (negation :complex-=) (type1 type2)
1882  ;; (NOT FOO) isn't equivalent to anything that's not a negation
1883  ;; type, except possibly a type that might contain it in disguise.
1884  (declare (ignore type2))
1885  (if (type-might-contain-other-types-p type1)
1886      (values nil nil)
1887      (values nil t)))
1888
1889(define-type-method (negation :simple-intersection) (type1 type2)
1890  (let ((not1 (negation-ctype-type type1))
1891        (not2 (negation-ctype-type type2)))
1892    (cond
1893      ((csubtypep not1 not2) type2)
1894      ((csubtypep not2 not1) type1)
1895      ;; Why no analagous clause to the disjoint in the SIMPLE-UNION2
1896      ;; method, below?  The clause would read
1897      ;;
1898      ;; ((EQ (TYPE-UNION NOT1 NOT2) *UNIVERSAL-TYPE*) *EMPTY-TYPE*)
1899      ;;
1900      ;; but with proper canonicalization of negation types, there's
1901      ;; no way of constructing two negation types with union of their
1902      ;; negations being the universal type.
1903      (t
1904       nil))))
1905
1906(define-type-method (negation :complex-intersection) (type1 type2)
1907  (cond
1908    ((csubtypep type1 (negation-ctype-type type2)) *empty-type*)
1909    ((eq (type-intersection type1 (negation-ctype-type type2)) *empty-type*)
1910     type1)
1911    (t nil)))
1912
1913(define-type-method (negation :simple-union) (type1 type2)
1914  (let ((not1 (negation-ctype-type type1))
1915        (not2 (negation-ctype-type type2)))
1916    (cond
1917      ((csubtypep not1 not2) type1)
1918      ((csubtypep not2 not1) type2)
1919      ((eq (type-intersection not1 not2) *empty-type*)
1920       *universal-type*)
1921      (t nil))))
1922
1923(define-type-method (negation :complex-union) (type1 type2)
1924  (cond
1925    ((csubtypep (negation-ctype-type type2) type1) *universal-type*)
1926    ((eq (type-intersection type1 (negation-ctype-type type2)) *empty-type*)
1927     type2)
1928    (t nil)))
1929
1930(define-type-method (negation :simple-=) (type1 type2)
1931  (type= (negation-ctype-type type1) (negation-ctype-type type2)))
1932
[9892]1933(def-type-translator not (typespec &environment env)
1934  (let* ((not-type (specifier-type typespec env))
[279]1935         (spec (type-specifier not-type)))
1936    (cond
1937      ;; canonicalize (NOT (NOT FOO))
1938      ((and (listp spec) (eq (car spec) 'not))
[9892]1939       (specifier-type (cadr spec) env))
[279]1940      ;; canonicalize (NOT NIL) and (NOT T)
1941      ((eq not-type *empty-type*) *universal-type*)
1942      ((eq not-type *universal-type*) *empty-type*)
1943      ((and (numeric-ctype-p not-type)
1944            (null (numeric-ctype-low not-type))
1945            (null (numeric-ctype-high not-type)))
1946       (make-negation-ctype :type not-type))
1947      ((numeric-ctype-p not-type)
1948       (type-union
1949        (make-negation-ctype
1950         :type (modified-numeric-type not-type :low nil :high nil))
1951        (cond
1952          ((null (numeric-ctype-low not-type))
1953           (modified-numeric-type
1954            not-type
1955            :low (let ((h (numeric-ctype-high not-type)))
1956                   (if (consp h) (car h) (list h)))
1957            :high nil))
1958          ((null (numeric-ctype-high not-type))
1959           (modified-numeric-type
1960            not-type
1961            :low nil
1962            :high (let ((l (numeric-ctype-low not-type)))
1963                    (if (consp l) (car l) (list l)))))
1964          (t (type-union
1965              (modified-numeric-type
1966               not-type
1967               :low nil
1968               :high (let ((l (numeric-ctype-low not-type)))
1969                       (if (consp l) (car l) (list l))))
1970              (modified-numeric-type
1971               not-type
1972               :low (let ((h (numeric-ctype-high not-type)))
1973                      (if (consp h) (car h) (list h)))
1974               :high nil))))))
1975      ((intersection-ctype-p not-type)
1976       (apply #'type-union
1977              (mapcar #'(lambda (x)
[9892]1978                          (specifier-type `(not ,(type-specifier x)) env))
[279]1979                      (intersection-ctype-types not-type))))
1980      ((union-ctype-p not-type)
1981       (apply #'type-intersection
1982              (mapcar #'(lambda (x)
[9892]1983                          (specifier-type `(not ,(type-specifier x)) env))
[279]1984                      (union-ctype-types not-type))))
1985      ((member-ctype-p not-type)
1986       (let ((members (member-ctype-members not-type)))
1987         (if (some #'floatp members)
1988           (let (floats)
1989             (dolist (pair '((0.0f0 . -0.0f0) (0.0d0 . -0.0d0)))
1990               (when (member (car pair) members)
1991                 (assert (not (member (cdr pair) members)))
1992                 (push (cdr pair) floats)
1993                 (setf members (remove (car pair) members)))
1994               (when (member (cdr pair) members)
1995                 (assert (not (member (car pair) members)))
1996                 (push (car pair) floats)
1997                 (setf members (remove (cdr pair) members))))
1998             (apply #'type-intersection
1999                    (if (null members)
2000                      *universal-type*
2001                      (make-negation-ctype
2002                       :type (make-member-ctype :members members)))
2003                    (mapcar
2004                     (lambda (x)
2005                       (let ((type (ctype-of x)))
2006                         (type-union
2007                          (make-negation-ctype
2008                           :type (modified-numeric-type type
2009                                                          :low nil :high nil))
2010                            (modified-numeric-type type
2011                                                   :low nil :high (list x))
2012                            (make-member-ctype :members (list x))
2013                            (modified-numeric-type type
2014                                                   :low (list x) :high nil))))
2015                     floats)))
2016             (make-negation-ctype :type not-type))))
2017      ((and (cons-ctype-p not-type)
2018            (eq (cons-ctype-car-ctype not-type) *universal-type*)
2019            (eq (cons-ctype-cdr-ctype not-type) *universal-type*))
2020       (make-negation-ctype :type not-type))
2021      ((cons-ctype-p not-type)
2022       (type-union
[9892]2023        (make-negation-ctype :type (specifier-type 'cons env))
[279]2024        (cond
2025          ((and (not (eq (cons-ctype-car-ctype not-type) *universal-type*))
2026                (not (eq (cons-ctype-cdr-ctype not-type) *universal-type*)))
2027           (type-union
2028            (make-cons-ctype
2029             (specifier-type `(not ,(type-specifier
[9892]2030                                     (cons-ctype-car-ctype not-type))) env)
[279]2031             *universal-type*)
2032            (make-cons-ctype
2033             *universal-type*
2034             (specifier-type `(not ,(type-specifier
[9892]2035                                     (cons-ctype-cdr-ctype not-type))) env))))
[279]2036          ((not (eq (cons-ctype-car-ctype not-type) *universal-type*))
2037           (make-cons-ctype
2038            (specifier-type `(not ,(type-specifier
[9892]2039                                    (cons-ctype-car-ctype not-type))) env)
[279]2040            *universal-type*))
2041          ((not (eq (cons-ctype-cdr-ctype not-type) *universal-type*))
2042           (make-cons-ctype
2043            *universal-type*
2044            (specifier-type `(not ,(type-specifier
[9892]2045                                    (cons-ctype-cdr-ctype not-type))) env)))
[279]2046          (t (error "Weird CONS type ~S" not-type)))))
2047      (t (make-negation-ctype :type not-type)))))
2048
2049
[6]2050;;;; Numeric types.
2051
2052;;; A list of all the float formats, in order of decreasing precision.
2053;;;
2054(eval-when (:compile-toplevel :load-toplevel :execute)
2055  (defconstant float-formats
2056    '(long-float double-float single-float short-float)))
2057
2058;;; The type of a float format.
2059;;;
2060(deftype float-format () `(member ,@float-formats))
2061
[318]2062(defun type-bound-number (x)
2063  (if (consp x)
2064      (destructuring-bind (result) x result)
2065      x))
2066
[6]2067(defun make-numeric-ctype (&key class 
2068                                format
2069                                (complexp :real)
2070                                low
2071                                high
2072                                enumerable
2073                                predicate)
[318]2074  ;; if interval is empty
2075  (if (and low
2076           high
2077           (if (or (consp low) (consp high)) ; if either bound is exclusive
2078             (>= (type-bound-number low) (type-bound-number high))
2079             (> low high)))
2080    *empty-type*
2081    (multiple-value-bind (canonical-low canonical-high)
2082        (case class
2083          (integer
2084           ;; INTEGER types always have their LOW and HIGH bounds
2085           ;; represented as inclusive, not exclusive values.
2086           (values (if (consp low)
2087                     (1+ (type-bound-number low))
2088                     low)
2089                   (if (consp high)
2090                     (1- (type-bound-number high))
2091                     high)))
2092          (t 
2093           ;; no canonicalization necessary
2094           (values low high)))
2095      (when (and (eq class 'rational)
2096                 (integerp canonical-low)
2097                 (integerp canonical-high)
2098                 (= canonical-low canonical-high))
2099        (setf class 'integer))
2100      (%istruct 'numeric-ctype
2101                (type-class-or-lose 'number)
2102                enumerable
2103                class
2104                format
2105                complexp
2106                canonical-low
2107                canonical-high
2108                predicate))))
[6]2109   
2110
2111(defun make-numeric-ctype-predicate (ctype)
2112  (let ((class (numeric-ctype-class ctype))
2113        (lo (numeric-ctype-low ctype))
2114        (hi (numeric-ctype-high ctype)))
2115    (if (eq class 'integer)
[1701]2116      (if (and hi
2117               lo
2118               (<= hi target::target-most-positive-fixnum)
2119               (>= lo target::target-most-negative-fixnum))     
[6]2120        #'(lambda (n)
2121            (and (fixnump n)
2122                 (locally (declare (fixnum n hi lo))
2123                   (and (%i>= n lo)
2124                        (%i<= n hi)))))))))
2125
2126(defun numeric-ctype-p (x)
2127  (istruct-typep x 'numeric-ctype))
2128
2129(setf (type-predicate 'numeric-ctype) 'numeric-ctype-p)
2130
2131(define-type-method (number :simple-=) (type1 type2)
2132  (values
2133   (and (eq (numeric-ctype-class type1) (numeric-ctype-class type2))
2134        (eq (numeric-ctype-format type1) (numeric-ctype-format type2))
2135        (eq (numeric-ctype-complexp type1) (numeric-ctype-complexp type2))
[279]2136        (equalp (numeric-ctype-low type1) (numeric-ctype-low type2))
2137        (equalp (numeric-ctype-high type1) (numeric-ctype-high type2)))
[6]2138   t))
2139
2140(define-type-method (number :unparse) (type)
[318]2141  (let* ((complexp (numeric-ctype-complexp type))
2142         (low (numeric-ctype-low type))
2143         (high (numeric-ctype-high type))
2144         (base (case (numeric-ctype-class type)
2145                 (integer 'integer)
2146                 (rational 'rational)
2147                 (float (or (numeric-ctype-format type) 'float))
2148                 (t 'real))))
[6]2149    (let ((base+bounds
[318]2150           (cond ((and (eq base 'integer) high low)
2151                  (let ((high-count (logcount high))
2152                        (high-length (integer-length high)))
2153                    (cond ((= low 0)
2154                           (cond ((= high 0) '(integer 0 0))
2155                                 ((= high 1) 'bit)
2156                                 ((and (= high-count high-length)
2157                                       (plusp high-length))
2158                                  `(unsigned-byte ,high-length))
2159                                 (t
2160                                  `(mod ,(1+ high)))))
[1701]2161                          ((and (= low target::target-most-negative-fixnum)
2162                                (= high target::target-most-positive-fixnum))
[318]2163                           'fixnum)
2164                          ((and (= low (lognot high))
2165                                (= high-count high-length)
2166                                (> high-count 0))
2167                           `(signed-byte ,(1+ high-length)))
2168                          (t
2169                           `(integer ,low ,high)))))
2170                 (high `(,base ,(or low '*) ,high))
2171                 (low
2172                  (if (and (eq base 'integer) (= low 0))
2173                      'unsigned-byte
2174                      `(,base ,low)))
2175                 (t base))))
[6]2176      (ecase complexp
[318]2177        (:real
2178         base+bounds)
2179        (:complex
2180         (if (eq base+bounds 'real)
[6]2181             'complex
2182             `(complex ,base+bounds)))
[318]2183        ((nil)
2184         (assert (eq base+bounds 'real))
2185         'number)))))
[6]2186
2187;;; Numeric-Bound-Test  --  Internal
2188;;;
2189;;;    Return true if X is "less than or equal" to Y, taking open bounds into
2190;;; consideration.  Closed is the predicate used to test the bound on a closed
2191;;; interval (e.g. <=), and Open is the predicate used on open bounds (e.g. <).
2192;;; Y is considered to be the outside bound, in the sense that if it is
2193;;; infinite (NIL), then the test suceeds, whereas if X is infinite, then the
2194;;; test fails (unless Y is also infinite).
2195;;;
2196;;;    This is for comparing bounds of the same kind, e.g. upper and upper.
2197;;; Use Numeric-Bound-Test* for different kinds of bounds.
2198;;;
2199(defmacro numeric-bound-test (x y closed open)
2200  `(cond ((not ,y) t)
2201           ((not ,x) nil)
2202           ((consp ,x)
2203            (if (consp ,y)
2204              (,closed (car ,x) (car ,y))
2205              (,closed (car ,x) ,y)))
2206           (t
2207            (if (consp ,y)
2208              (,open ,x (car ,y))
2209              (,closed ,x ,y)))))
2210
2211;;; Numeric-Bound-Test*  --  Internal
2212;;;
2213;;;    Used to compare upper and lower bounds.  This is different from the
2214;;; same-bound case:
2215;;; -- Since X = NIL is -infinity, whereas y = NIL is +infinity, we return true
2216;;;    if *either* arg is NIL.
2217;;; -- an open inner bound is "greater" and also squeezes the interval, causing
2218;;;    us to use the Open test for those cases as well.
2219;;;
2220(defmacro numeric-bound-test* (x y closed open)
2221  `(cond ((not ,y) t)
[2519]2222         ((not ,x) t)
2223         ((consp ,x)
2224          (if (consp ,y)
[6]2225              (,open (car ,x) (car ,y))
2226              (,open (car ,x) ,y)))
[2519]2227         (t
2228          (if (consp ,y)
[6]2229              (,open ,x (car ,y))
2230              (,closed ,x ,y)))))
2231
2232;;; Numeric-Bound-Max  --  Internal
2233;;;
2234;;;    Return whichever of the numeric bounds X and Y is "maximal" according to
2235;;; the predicates Closed (e.g. >=) and Open (e.g. >).  This is only meaningful
2236;;; for maximizing like bounds, i.e. upper and upper.  If Max-P is true, then
2237;;; we return NIL if X or Y is NIL, otherwise we return the other arg.
2238;;;
2239(defmacro numeric-bound-max (x y closed open max-p)
2240  (once-only ((n-x x)
[318]2241              (n-y y))
2242    `(cond
2243      ((not ,n-x) ,(if max-p nil n-y))
2244      ((not ,n-y) ,(if max-p nil n-x))
2245      ((consp ,n-x)
2246       (if (consp ,n-y)
2247         (if (,closed (car ,n-x) (car ,n-y)) ,n-x ,n-y)
2248         (if (,open (car ,n-x) ,n-y) ,n-x ,n-y)))
2249      (t
2250       (if (consp ,n-y)
2251         (if (,open (car ,n-y) ,n-x) ,n-y ,n-x)
2252         (if (,closed ,n-y ,n-x) ,n-y ,n-x))))))
[6]2253
2254
2255(define-type-method (number :simple-subtypep) (type1 type2)
2256  (let ((class1 (numeric-ctype-class type1))
2257          (class2 (numeric-ctype-class type2))
2258          (complexp2 (numeric-ctype-complexp type2))
2259          (format2 (numeric-ctype-format type2))
2260          (low1 (numeric-ctype-low type1))
2261          (high1 (numeric-ctype-high type1))
2262          (low2 (numeric-ctype-low type2))
2263          (high2 (numeric-ctype-high type2)))
2264    ;;
2265    ;; If one is complex and the other isn't, they are disjoint.
2266    (cond ((not (or (eq (numeric-ctype-complexp type1) complexp2)
2267                        (null complexp2)))
2268             (values nil t))
2269            ;;
2270            ;; If the classes are specified and different, the types are
2271            ;; disjoint unless type2 is rational and type1 is integer.
2272            ((not (or (eq class1 class2) (null class2)
2273                        (and (eq class1 'integer) (eq class2 'rational))))
2274             (values nil t))
2275            ;;
2276            ;; If the float formats are specified and different, the types
2277            ;; are disjoint.
2278            ((not (or (eq (numeric-ctype-format type1) format2)
2279                        (null format2)))
2280             (values nil t))
2281            ;;
2282            ;; Check the bounds.
2283            ((and (numeric-bound-test low1 low2 >= >)
2284                    (numeric-bound-test high1 high2 <= <))
2285             (values t t))
2286            (t
2287             (values nil t)))))
2288
2289;(define-superclasses number (generic-number))
2290
2291;;; NUMERIC-TYPES-ADJACENT  --  Internal
2292;;;
2293;;;    If the high bound of Low is adjacent to the low bound of High, then
2294;;; return T, otherwise NIL.
2295;;;
2296(defun numeric-types-adjacent (low high)
2297  (let ((low-bound (numeric-ctype-high low))
[318]2298        (high-bound (numeric-ctype-low high)))
[6]2299    (cond ((not (and low-bound high-bound)) nil)
2300            ((consp low-bound)
2301             (eql (car low-bound) high-bound))
2302            ((consp high-bound)
2303             (eql (car high-bound) low-bound))
2304            ((and (eq (numeric-ctype-class low) 'integer)
2305                    (eq (numeric-ctype-class high) 'integer))
2306             (eql (1+ low-bound) high-bound))
2307            (t
2308             nil))))
2309
2310;;;
[318]2311;;; Return a numeric type that is a supertype for both type1 and type2.
[6]2312;;;
2313(define-type-method (number :simple-union) (type1 type2)
2314  (declare (type numeric-ctype type1 type2))
2315  (cond ((csubtypep type1 type2) type2)
[318]2316        ((csubtypep type2 type1) type1)
2317        (t
2318         (let ((class1 (numeric-ctype-class type1))
2319               (format1 (numeric-ctype-format type1))
2320               (complexp1 (numeric-ctype-complexp type1))
2321               (class2 (numeric-ctype-class type2))
2322               (format2 (numeric-ctype-format type2))
2323               (complexp2 (numeric-ctype-complexp type2)))
[2526]2324           (cond
2325             ((and (eq class1 class2)
2326                   (eq format1 format2)
2327                   (eq complexp1 complexp2)
2328                   (or (numeric-types-intersect type1 type2)
2329                       (numeric-types-adjacent type1 type2)
2330                       (numeric-types-adjacent type2 type1)))
2331              (make-numeric-ctype
2332               :class class1
2333               :format format1
2334               :complexp complexp1
2335               :low (numeric-bound-max (numeric-ctype-low type1)
2336                                       (numeric-ctype-low type2)
2337                                       <= < t)
2338               :high (numeric-bound-max (numeric-ctype-high type1)
2339                                        (numeric-ctype-high type2)
2340                                        >= > t)))
2341             ;; FIXME: These two clauses are almost identical, and the
2342             ;; consequents are in fact identical in every respect.
2343             ((and (eq class1 'rational)
2344                   (eq class2 'integer)
2345                   (eq format1 format2)
2346                   (eq complexp1 complexp2)
2347                   (integerp (numeric-ctype-low type2))
2348                   (integerp (numeric-ctype-high type2))
2349                   (= (numeric-ctype-low type2) (numeric-ctype-high type2))
2350                   (or (numeric-types-adjacent type1 type2)
2351                       (numeric-types-adjacent type2 type1)))
2352              (make-numeric-ctype
2353               :class 'rational
2354               :format format1
2355               :complexp complexp1
2356               :low (numeric-bound-max (numeric-ctype-low type1)
2357                                       (numeric-ctype-low type2)
2358                                       <= < t)
2359               :high (numeric-bound-max (numeric-ctype-high type1)
2360                                        (numeric-ctype-high type2)
2361                                        >= > t)))
2362             ((and (eq class1 'integer)
2363                   (eq class2 'rational)
2364                   (eq format1 format2)
2365                   (eq complexp1 complexp2)
2366                   (integerp (numeric-ctype-low type1))
2367                   (integerp (numeric-ctype-high type1))
2368                   (= (numeric-ctype-low type1) (numeric-ctype-high type1))
2369                   (or (numeric-types-adjacent type1 type2)
2370                       (numeric-types-adjacent type2 type1)))
2371              (make-numeric-ctype
2372               :class 'rational
2373               :format format1
2374               :complexp complexp1
2375               :low (numeric-bound-max (numeric-ctype-low type1)
2376                                       (numeric-ctype-low type2)
2377                                       <= < t)
2378               :high (numeric-bound-max (numeric-ctype-high type1)
2379                                        (numeric-ctype-high type2)
2380                                        >= > t)))
2381             (t nil))))))
[6]2382
2383(setf (info-type-kind 'number) :primitive
2384      (info-type-builtin 'number) (make-numeric-ctype :complexp nil))
2385
[9892]2386(def-type-translator complex (&optional spec &environment env)
[6]2387  (if (eq spec '*)
[2472]2388      (make-numeric-ctype :complexp :complex)
2389      (labels ((not-numeric ()
2390                 (error "Component type for Complex is not numeric: ~S." spec))
2391               (not-real ()
2392                 (error "Component type for Complex is not a subtype of real: ~S." spec))
2393               (complex1 (component-type)
2394                 (unless (numeric-ctype-p component-type)
2395                   (not-numeric))
2396                 (when (eq (numeric-ctype-complexp component-type) :complex)
2397                   (not-real))
2398                 (let ((res (copy-uvector component-type)))
2399                   (setf (numeric-ctype-complexp res) :complex)
2400                   (setf (numeric-ctype-predicate res) nil) ; <<
2401                   res))
2402               (do-complex (ctype)
2403                 (cond
2404                   ((eq ctype *empty-type*) *empty-type*)
2405                   ((eq ctype *universal-type*) (not-real))
2406                   ((numeric-ctype-p ctype) (complex1 ctype))
2407                   ((union-ctype-p ctype)
2408                    (apply #'type-union
2409                           (mapcar #'do-complex (union-ctype-types ctype))))
2410                   ((member-ctype-p ctype)
2411                    (apply #'type-union
2412                           (mapcar (lambda (x) (do-complex (ctype-of x)))
2413                                   (member-ctype-members ctype))))
2414                   ((and (intersection-ctype-p ctype)
2415                         ;; just enough to handle simple types like RATIO.
2416                         (let ((numbers (remove-if-not
2417                                         #'numeric-ctype-p
2418                                         (intersection-ctype-types ctype))))
2419                           (and (car numbers)
2420                                (null (cdr numbers))
2421                                (eq (numeric-ctype-complexp (car numbers)) :real)
2422                                (complex1 (car numbers))))))
2423                   (t                   ; punt on harder stuff for now
2424                    (not-real)))))
[9892]2425        (let ((ctype (specifier-type spec env)))
[2472]2426          (do-complex ctype)))))
[6]2427
2428;;; Check-Bound  --  Internal
2429;;;
2430;;;    Check that X is a well-formed numeric bound of the specified Type.
2431;;; If X is *, return NIL, otherwise return the bound.
2432;;;
2433(defmacro check-bound (x type)
2434  `(cond ((eq ,x '*) nil)
2435           ((or (typep ,x ',type)
2436                (and (consp ,x) (typep (car ,x) ',type) (null (cdr ,x))))
2437            ,x)
2438           (t
2439            (error "Bound is not *, a ~A or a list of a ~A: ~S" ',type ',type ,x))))
2440
2441(def-type-translator integer (&optional low high)
2442  (let* ((l (check-bound low integer))
[1701]2443         (lb (if (consp l) (1+ (car l)) l))
2444         (h (check-bound high integer))
2445         (hb (if (consp h) (1- (car h)) h)))
[6]2446    (if (and hb lb (< hb lb))
2447      *empty-type*
2448      (make-numeric-ctype :class 'integer  :complexp :real
2449                          :enumerable (not (null (and l h)))
2450                          :low lb
2451                          :high hb))))
2452
2453(deftype mod (n)
2454  (unless (and (integerp n) (> n 0))
2455    (error "Bad N specified for MOD type specifier: ~S." n))
2456  `(integer 0 ,(1- n)))
2457
2458
2459(defmacro def-bounded-type (type class format)
2460  `(def-type-translator ,type (&optional low high)
2461     (let ((lb (check-bound low ,type))
2462             (hb (check-bound high ,type)))
2463       (unless (numeric-bound-test* lb hb <= <)
2464           (error "Lower bound ~S is not less than upper bound ~S." low high))
2465       (make-numeric-ctype :class ',class :format ',format :low lb :high hb))))
2466
2467(def-bounded-type rational rational nil)
[279]2468
2469(defun coerce-bound (bound type inner-coerce-bound-fun)
2470  (declare (type function inner-coerce-bound-fun))
2471  (cond ((eql bound '*)
2472         bound)
2473        ((consp bound)
2474         (destructuring-bind (inner-bound) bound
2475           (list (funcall inner-coerce-bound-fun inner-bound type))))
2476        (t
2477         (funcall inner-coerce-bound-fun bound type))))
2478
2479(defun inner-coerce-real-bound (bound type)
2480  (ecase type
2481    (rational (rationalize bound))
2482    (float (if (floatp bound)
2483               bound
2484               ;; Coerce to the widest float format available, to
2485               ;; avoid unnecessary loss of precision:
2486               (coerce bound 'long-float)))))
2487
2488(defun coerced-real-bound (bound type)
2489  (coerce-bound bound type #'inner-coerce-real-bound))
2490
2491(defun coerced-float-bound (bound type)
2492  (coerce-bound bound type #'coerce))
2493
[12045]2494#|
[279]2495(def-type-translator real (&optional (low '*) (high '*))
2496  (specifier-type `(or (float ,(coerced-real-bound  low 'float)
2497                              ,(coerced-real-bound high 'float))
2498                       (rational ,(coerced-real-bound  low 'rational)
2499                                 ,(coerced-real-bound high 'rational)))))
2500
2501(def-type-translator float (&optional (low '*) (high '*))
2502  (specifier-type
2503   `(or (single-float ,(coerced-float-bound  low 'single-float)
2504                      ,(coerced-float-bound high 'single-float))
2505        (double-float ,(coerced-float-bound  low 'double-float)
2506                      ,(coerced-float-bound high 'double-float)))))
[12045]2507|#
[279]2508
[6]2509(def-bounded-type float float nil)
2510(def-bounded-type real nil nil)
2511
2512(defmacro define-float-format (f)
2513  `(def-bounded-type ,f float ,f))
2514
2515(define-float-format short-float)
2516(define-float-format single-float)
2517(define-float-format double-float)
2518(define-float-format long-float)
2519
2520(defun numeric-types-intersect (type1 type2)
2521  (declare (type numeric-ctype type1 type2))
2522  (let* ((class1 (numeric-ctype-class type1))
[279]2523         (class2 (numeric-ctype-class type2))
2524         (complexp1 (numeric-ctype-complexp type1))
2525         (complexp2 (numeric-ctype-complexp type2))
2526         (format1 (numeric-ctype-format type1))
2527         (format2 (numeric-ctype-format type2))
2528         (low1 (numeric-ctype-low type1))
2529         (high1 (numeric-ctype-high type1))
2530         (low2 (numeric-ctype-low type2))
2531         (high2 (numeric-ctype-high type2)))
[6]2532    ;;
2533    ;; If one is complex and the other isn't, then they are disjoint.
2534    (cond ((not (or (eq complexp1 complexp2)
[279]2535                    (null complexp1) (null complexp2)))
2536           nil)
2537          ;;
2538          ;; If either type is a float, then the other must either be specified
2539          ;; to be a float or unspecified.  Otherwise, they are disjoint.
2540          ((and (eq class1 'float) (not (member class2 '(float nil)))) nil)
2541          ((and (eq class2 'float) (not (member class1 '(float nil)))) nil)
2542          ;;
2543          ;; If the float formats are specified and different, the types
2544          ;; are disjoint.
2545          ((not (or (eq format1 format2) (null format1) (null format2)))
2546           nil)
2547          (t
2548           ;;
2549           ;; Check the bounds.  This is a bit odd because we must always have
2550           ;; the outer bound of the interval as the second arg.
2551           (if (numeric-bound-test high1 high2 <= <)
2552             (or (and (numeric-bound-test low1 low2 >= >)
2553                      (numeric-bound-test* low1 high2 <= <))
2554                 (and (numeric-bound-test low2 low1 >= >)
2555                      (numeric-bound-test* low2 high1 <= <)))
2556             (or (and (numeric-bound-test* low2 high1 <= <)
2557                      (numeric-bound-test low2 low1 >= >))
2558                 (and (numeric-bound-test high2 high1 <= <)
2559                      (numeric-bound-test* high2 low1 >= >))))))))
[6]2560
2561;;; Round-Numeric-Bound  --  Internal
2562;;;
2563;;;    Take the numeric bound X and convert it into something that can be used
2564;;; as a bound in a numeric type with the specified Class and Format.  If up-p
2565;;; is true, then we round up as needed, otherwise we round down.  Up-p true
2566;;; implies that X is a lower bound, i.e. (N) > N.
2567;;;
2568;;; This is used by Numeric-Type-Intersection to mash the bound into the
2569;;; appropriate type number.  X may only be a float when Class is Float.
2570;;;
2571;;; ### Note: it is possible for the coercion to a float to overflow or
2572;;; underflow.  This happens when the bound doesn't fit in the specified
2573;;; format.  In this case, we should really return the appropriate
2574;;; {Most | Least}-{Positive | Negative}-XXX-Float float of desired format.
2575;;; But these conditions aren't currently signalled in any useful way.
2576;;;
2577;;; Also, when converting an open rational bound into a float we should
2578;;; probably convert it to a closed bound of the closest float in the specified
2579;;; format.  In general, open float bounds are fucked.
2580;;;
2581(defun round-numeric-bound (x class format up-p)
2582  (if x
2583    (let ((cx (if (consp x) (car x) x)))
2584        (ecase class
2585          ((nil rational) x)
2586          (integer
2587           (if (and (consp x) (integerp cx))
[279]2588             (if up-p (1+ cx) (1- cx))
2589             (if up-p (ceiling cx) (floor cx))))
[6]2590          (float
2591           (let ((res (if format (coerce cx format) (float cx))))
2592             (if (consp x) (list res) res)))))
2593    nil))
2594
2595;;; Number :Simple-Intersection type method  --  Internal
2596;;;
2597;;;    Handle the case of Type-Intersection on two numeric types.  We use
2598;;; Types-Intersect to throw out the case of types with no intersection.  If an
2599;;; attribute in Type1 is unspecified, then we use Type2's attribute, which
2600;;; must be at least as restrictive.  If the types intersect, then the only
2601;;; attributes that can be specified and different are the class and the
2602;;; bounds.
2603;;;
2604;;;    When the class differs, we use the more restrictive class.  The only
2605;;; interesting case is rational/integer, since rational includes integer.
2606;;;
2607;;;    We make the result lower (upper) bound the maximum (minimum) of the
2608;;; argument lower (upper) bounds.  We convert the bounds into the
2609;;; appropriate numeric type before maximizing.  This avoids possible confusion
2610;;; due to mixed-type comparisons (but I think the result is the same).
2611;;;
2612(define-type-method (number :simple-intersection) (type1 type2)
[12045]2613  (declare (type numeric-ctype type1 type2))
[6]2614  (if (numeric-types-intersect type1 type2)
2615    (let* ((class1 (numeric-ctype-class type1))
[279]2616           (class2 (numeric-ctype-class type2))
2617           (class (ecase class1
2618                    ((nil) class2)
2619                    ((integer float) class1)
2620                    (rational (if (eq class2 'integer) 'integer 'rational))))
2621           (format (or (numeric-ctype-format type1)
2622                       (numeric-ctype-format type2))))
2623      (make-numeric-ctype
2624       :class class
2625       :format format
2626       :complexp (or (numeric-ctype-complexp type1)
2627                     (numeric-ctype-complexp type2))
2628       :low (numeric-bound-max
2629             (round-numeric-bound (numeric-ctype-low type1)
2630                                  class format t)
2631             (round-numeric-bound (numeric-ctype-low type2)
2632                                  class format t)
[2519]2633             > >= nil)
[279]2634       :high (numeric-bound-max
2635              (round-numeric-bound (numeric-ctype-high type1)
2636                                   class format nil)
2637              (round-numeric-bound (numeric-ctype-high type2)
2638                                   class format nil)
[2519]2639              < <= nil)))
[279]2640    *empty-type*))
[6]2641
2642;;; Float-Format-Max  --  Interface
2643;;;
2644;;;    Given two float formats, return the one with more precision.  If either
2645;;; one is null, return NIL.
2646;;;
2647(defun float-format-max (f1 f2)
2648  (when (and f1 f2)
2649    (dolist (f float-formats (error "Bad float format: ~S." f1))
2650      (when (or (eq f f1) (eq f f2))
2651          (return f)))))
2652
2653
2654;;; Numeric-Contagion  --  Interface
2655;;;
2656;;;    Return the result of an operation on Type1 and Type2 according to the
2657;;; rules of numeric contagion.  This is always NUMBER, some float format
2658;;; (possibly complex) or RATIONAL.  Due to rational canonicalization, there
2659;;; isn't much we can do here with integers or rational complex numbers.
2660;;;
2661;;;    If either argument is not a Numeric-Type, then return NUMBER.  This is
2662;;; useful mainly for allowing types that are technically numbers, but not a
2663;;; Numeric-Type.
2664;;;
2665(defun numeric-contagion (type1 type2)
2666  (if (and (numeric-ctype-p type1) (numeric-ctype-p type2))
2667    (let ((class1 (numeric-ctype-class type1))
2668            (class2 (numeric-ctype-class type2))
2669            (format1 (numeric-ctype-format type1))
2670            (format2 (numeric-ctype-format type2))
2671            (complexp1 (numeric-ctype-complexp type1))
2672            (complexp2 (numeric-ctype-complexp type2)))
2673        (cond ((or (null complexp1)
[279]2674                   (null complexp2))
[6]2675               (specifier-type 'number))
2676              ((eq class1 'float)
2677               (make-numeric-ctype
2678                  :class 'float
2679                  :format (ecase class2
2680                              (float (float-format-max format1 format2))
2681                              ((integer rational) format1)
[279]2682                              ((nil)
2683                               ;; A double-float with any real number is a
2684                               ;; double-float.
2685                               (if (eq format1 'double-float)
2686                                 'double-float
2687                                 nil)))
[6]2688                  :complexp (if (or (eq complexp1 :complex)
[279]2689                                    (eq complexp2 :complex))
2690                              :complex
2691                              :real)))
[6]2692              ((eq class2 'float) (numeric-contagion type2 type1))
2693              ((and (eq complexp1 :real) (eq complexp2 :real))
2694               (make-numeric-ctype
2695                  :class (and class1 class2 'rational)
2696                  :complexp :real))
2697              (t
2698               (specifier-type 'number))))
2699    (specifier-type 'number)))
2700
[279]2701
2702
[6]2703
2704;;;; Array types:
2705
2706;;; The Array-Type is used to represent all array types, including things such
2707;;; as SIMPLE-STRING.
2708;;;
2709
2710(defun make-array-ctype (&key
2711                         (dimensions '*)
2712                         (complexp '*)
2713                         element-type
2714                         (specialized-element-type *wild-type*))
2715  (%istruct 'array-ctype
2716            (type-class-or-lose 'array)
2717            nil
2718            dimensions
2719            complexp
2720            element-type
[7950]2721            specialized-element-type
2722            (unless (eq specialized-element-type *wild-type*)
2723              (ctype-subtype specialized-element-type))))
[6]2724
2725(defun array-ctype-p (x) (istruct-typep x 'array-ctype))
2726(setf (type-predicate 'array-ctype) 'array-ctype-p)
2727
2728;;; Specialized-Element-Type-Maybe  --  Internal
2729;;;
2730;;;      What this does depends on the setting of the
2731;;; *use-implementation-types* switch.  If true, return the specialized element
2732;;; type, otherwise return the original element type.
2733;;;
2734(defun specialized-element-type-maybe (type)
2735  (declare (type array-ctype type))
2736  (if *use-implementation-types*
[1789]2737    (array-ctype-specialized-element-type type)
2738    (array-ctype-element-type type)))
[6]2739
2740(define-type-method (array :simple-=) (type1 type2)
[279]2741  (if (or (unknown-ctype-p (array-ctype-element-type type1))
2742          (unknown-ctype-p (array-ctype-element-type type2)))
2743    (multiple-value-bind (equalp certainp)
2744        (type= (array-ctype-element-type type1)
2745               (array-ctype-element-type type2))
2746      (assert (not (and (not equalp) certainp)))
2747      (values equalp certainp))
2748    (values (and (equal (array-ctype-dimensions type1)
2749                        (array-ctype-dimensions type2))
2750                 (eq (array-ctype-complexp type1)
2751                     (array-ctype-complexp type2))
2752                 (type= (specialized-element-type-maybe type1)
2753                        (specialized-element-type-maybe type2)))
2754            t)))
[6]2755
2756(define-type-method (array :unparse) (type)
2757  (let ((dims (array-ctype-dimensions type))
2758          (eltype (type-specifier (array-ctype-element-type type)))
2759          (complexp (array-ctype-complexp type)))
2760    (cond ((eq dims '*)
2761             (if (eq eltype '*)
2762               (if complexp 'array 'simple-array)
2763               (if complexp `(array ,eltype) `(simple-array ,eltype))))
2764            ((= (length dims) 1) 
2765             (if complexp
2766               (if (eq (car dims) '*)
2767                   (case eltype
2768                     (bit 'bit-vector)
[7917]2769                     ((character base-char) 'base-string)
[6]2770                     (* 'vector)
2771                     (t `(vector ,eltype)))
2772                   (case eltype
2773                     (bit `(bit-vector ,(car dims)))
[7917]2774                     ((character base-char) `(base-string ,(car dims)))
[6]2775                     (t `(vector ,eltype ,(car dims)))))
2776               (if (eq (car dims) '*)
2777                   (case eltype
2778                     (bit 'simple-bit-vector)
[7917]2779                     ((base-char character) 'simple-base-string)
[6]2780                     ((t) 'simple-vector)
2781                     (t `(simple-array ,eltype (*))))
2782                   (case eltype
2783                     (bit `(simple-bit-vector ,(car dims)))
[7917]2784                     ((base-char character) `(simple-base-string ,(car dims)))
[6]2785                     ((t) `(simple-vector ,(car dims)))
2786                     (t `(simple-array ,eltype ,dims))))))
2787            (t
2788             (if complexp
2789               `(array ,eltype ,dims)
2790               `(simple-array ,eltype ,dims))))))
2791
2792(define-type-method (array :simple-subtypep) (type1 type2)
2793  (let ((dims1 (array-ctype-dimensions type1))
[279]2794        (dims2 (array-ctype-dimensions type2))
2795        (complexp2 (array-ctype-complexp type2)))
2796    (cond (;; not subtypep unless dimensions are compatible
2797           (not (or (eq dims2 '*)
2798                    (and (not (eq dims1 '*))
2799                         (= (length (the list dims1))
2800                            (length (the list dims2)))
2801                         (every (lambda (x y)
2802                                  (or (eq y '*) (eql x y)))
2803                                (the list dims1)
2804                                (the list dims2)))))
2805           (values nil t))
2806          ;; not subtypep unless complexness is compatible
2807          ((not (or (eq complexp2 :maybe)
2808                    (eq (array-ctype-complexp type1) complexp2)))
2809           (values nil t))
2810          ;; Since we didn't fail any of the tests above, we win
2811          ;; if the TYPE2 element type is wild.
2812          ((eq (array-ctype-element-type type2) *wild-type*)
2813           (values t t))
2814          (;; Since we didn't match any of the special cases above, we
2815           ;; can't give a good answer unless both the element types
2816           ;; have been defined.
2817           (or (unknown-ctype-p (array-ctype-element-type type1))
2818               (unknown-ctype-p (array-ctype-element-type type2)))
2819           (values nil nil))
2820          (;; Otherwise, the subtype relationship holds iff the
2821           ;; types are equal, and they're equal iff the specialized
2822           ;; element types are identical.
2823           t
2824           (values (type= (specialized-element-type-maybe type1)
2825                          (specialized-element-type-maybe type2))
2826                   t)))))
[6]2827
2828; (define-superclasses array (string string) (vector vector) (array))
2829
2830
2831(defun array-types-intersect (type1 type2)
2832  (declare (type array-ctype type1 type2))
2833  (let ((dims1 (array-ctype-dimensions type1))
[279]2834        (dims2 (array-ctype-dimensions type2))
2835        (complexp1 (array-ctype-complexp type1))
2836        (complexp2 (array-ctype-complexp type2)))
2837    ;; See whether dimensions are compatible.
[6]2838    (cond ((not (or (eq dims1 '*) (eq dims2 '*)
[279]2839                    (and (= (length dims1) (length dims2))
2840                         (every (lambda (x y)
2841                                  (or (eq x '*) (eq y '*) (= x y)))
2842                                dims1 dims2))))
2843           (values nil t))
2844          ;; See whether complexpness is compatible.
2845          ((not (or (eq complexp1 :maybe)
2846                    (eq complexp2 :maybe)
2847                    (eq complexp1 complexp2)))
2848           (values nil t))
2849          ((or (eq (array-ctype-specialized-element-type type1) *wild-type*)
2850               (eq (array-ctype-specialized-element-type type2) *wild-type*)
2851               (type= (specialized-element-type-maybe type1)
2852                      (specialized-element-type-maybe type2)))
2853           (values t t))
2854          (t
2855           (values nil t)))))
[6]2856
2857(define-type-method (array :simple-intersection) (type1 type2)
2858  (declare (type array-ctype type1 type2))
2859  (if (array-types-intersect type1 type2)
2860    (let ((dims1 (array-ctype-dimensions type1))
[2528]2861          (dims2 (array-ctype-dimensions type2))
2862          (complexp1 (array-ctype-complexp type1))
2863          (complexp2 (array-ctype-complexp type2))
2864          (eltype1 (array-ctype-element-type type1))
2865          (eltype2 (array-ctype-element-type type2)))
2866      (specialize-array-type
2867       (make-array-ctype
2868        :dimensions (cond ((eq dims1 '*) dims2)
2869                          ((eq dims2 '*) dims1)
2870                          (t
2871                           (mapcar #'(lambda (x y) (if (eq x '*) y x))
2872                                   dims1 dims2)))
2873        :complexp (if (eq complexp1 :maybe) complexp2 complexp1)
2874        :element-type (cond
2875                        ((eq eltype1 *wild-type*) eltype2)
2876                        ((eq eltype2 *wild-type*) eltype1)
2877                        (t (type-intersection eltype1 eltype2))))))
2878      *empty-type*))
[6]2879
2880;;; Check-Array-Dimensions  --  Internal
2881;;;
2882;;;    Check a supplied dimension list to determine if it is legal.
2883;;;
2884(defun check-array-dimensions (dims)
2885  (typecase dims
2886    ((member *) dims)
2887    (integer
2888     (when (minusp dims)
[279]2889       (signal-program-error "Arrays can't have a negative number of dimensions: ~D." dims))
[6]2890     (when (>= dims array-rank-limit)
[279]2891       (signal-program-error "Array type has too many dimensions: ~S." dims))
[6]2892     (make-list dims :initial-element '*))
2893    (list
2894     (when (>= (length dims) array-rank-limit)
[279]2895       (signal-program-error "Array type has too many dimensions: ~S." dims))
[6]2896     (dolist (dim dims)
2897       (unless (eq dim '*)
2898           (unless (and (integerp dim)
2899                          (>= dim 0) (< dim array-dimension-limit))
[279]2900             (signal-program-error "Bad dimension in array type: ~S." dim))))
[6]2901     dims)
2902    (t
[279]2903     (signal-program-error "Array dimensions is not a list, integer or *:~%  ~S"
2904                           dims))))
[6]2905
[9892]2906(def-type-translator array (&optional element-type dimensions &environment env)
[6]2907  (specialize-array-type
2908   (make-array-ctype :dimensions (check-array-dimensions dimensions)
[279]2909                     :complexp :maybe
[9892]2910                     :element-type (specifier-type element-type env))))
[6]2911
[9892]2912(def-type-translator simple-array (&optional element-type dimensions &environment env)
[6]2913  (specialize-array-type
2914   (make-array-ctype :dimensions (check-array-dimensions dimensions)
[9892]2915                         :element-type (specifier-type element-type env)
[6]2916                         :complexp nil)))
2917
[1789]2918;;; Order matters here.
[6]2919(defparameter specialized-array-element-types
[2528]2920  '(nil bit (unsigned-byte 8) (signed-byte 8) (unsigned-byte 16)
[4876]2921    (signed-byte 16) (unsigned-byte 32) #+32-bit-target fixnum (signed-byte 32)
[16679]2922    #+64-bit-target fixnum
[3963]2923    #+64-bit-target (unsigned-byte 64)
2924    #+64-bit-target (signed-byte 64)
[16085]2925    character  short-float double-float
2926    #||(complex short-float) (complex double-float)||#))
[6]2927
2928(defun specialize-array-type (type)
[7950]2929  (let* ((eltype (array-ctype-element-type type))
2930         (specialized-type (if (eq eltype *wild-type*)
2931                             *wild-type*
2932                             (dolist (stype-name specialized-array-element-types
2933                                      *universal-type*)
2934                               (let ((stype (specifier-type stype-name)))
2935                                 (when (csubtypep eltype stype)
2936                                   (return stype)))))))
[6]2937   
[7950]2938    (setf (array-ctype-specialized-element-type type) specialized-type
2939          (array-ctype-typecode type) (unless (eq specialized-type *wild-type*)
2940                                        (ctype-subtype specialized-type)))
[6]2941    type))
2942
2943
2944;;;; Member types.
2945
2946;;; The Member-Type represents uses of the MEMBER type specifier.  We bother
2947;;; with this at this level because MEMBER types are fairly important and union
2948;;; and intersection are well defined.
2949
[318]2950(defun %make-member-ctype (members)
[6]2951  (%istruct 'member-ctype
2952            (type-class-or-lose 'member)
2953            t
2954            members))
2955
[318]2956(defun make-member-ctype (&key members)
2957  (let* ((singlep (subsetp '(-0.0f0 0.0f0) members))
2958         (doublep (subsetp '(-0.0d0 0.0d0) members))
2959         (union-types
2960          (if singlep
2961            (if doublep
2962              (list *ctype-of-single-float-0* *ctype-of-double-float-0*)
2963              (list *ctype-of-single-float-0*))
2964            (if doublep
[2530]2965              (list *ctype-of-double-float-0*)))))
[318]2966    (if union-types
2967      (progn
2968        (if singlep
2969          (setq members (set-difference '(-0.0f0 0.0f0) members)))
2970        (if doublep
2971          (setq members (set-difference '(-0.d00 0.0d0) members)))
2972        (make-union-ctype (if (null members)
2973                            union-types
2974                            (cons (%make-member-ctype members) union-types))))
2975      (%make-member-ctype members))))
2976       
2977
[6]2978(defun member-ctype-p (x) (istruct-typep x 'member-ctype))
2979(setf (type-predicate 'member-ctype) 'member-ctype-p)
2980
2981(define-type-method (member :unparse) (type)
[279]2982  (if (type= type (specifier-type 'standard-char))
2983    'standard-char
2984    (let ((members (member-ctype-members type)))
2985      (if (equal members '(nil))
[6]2986        'null
[279]2987        `(member ,@members)))))
[6]2988
2989(define-type-method (member :simple-subtypep) (type1 type2)
2990  (values (subsetp (member-ctype-members type1) (member-ctype-members type2))
2991            t))
2992
2993
2994(define-type-method (member :complex-subtypep-arg1) (type1 type2)
[279]2995  (every/type (swapped-args-fun #'ctypep)
2996              type2
2997              (member-ctype-members type1)))
[6]2998
2999;;; We punt if the odd type is enumerable and intersects with the member type.
3000;;; If not enumerable, then it is definitely not a subtype of the member type.
3001;;;
3002(define-type-method (member :complex-subtypep-arg2) (type1 type2)
3003  (cond ((not (ctype-enumerable type1)) (values nil t))
[279]3004          ((types-intersect type1 type2)
3005           (invoke-complex-subtypep-arg1-method type1 type2))
[6]3006          (t
3007           (values nil t))))
3008
3009(define-type-method (member :simple-intersection) (type1 type2)
3010  (let ((mem1 (member-ctype-members type1))
[279]3011        (mem2 (member-ctype-members type2)))
[6]3012    (values (cond ((subsetp mem1 mem2) type1)
[279]3013                  ((subsetp mem2 mem1) type2)
3014                  (t
3015                   (let ((res (intersection mem1 mem2)))
3016                     (if res
3017                       (make-member-ctype :members res)
3018                       *empty-type*))))
3019            t)))
[6]3020
3021(define-type-method (member :complex-intersection) (type1 type2)
3022  (block PUNT
[279]3023    (collect ((members))
[6]3024      (let ((mem2 (member-ctype-members type2)))
[279]3025        (dolist (member mem2)
3026          (multiple-value-bind (val win) (ctypep member type1)
3027            (unless win
3028              (return-from punt nil))
3029            (when val (members member))))
3030        (cond ((subsetp mem2 (members)) type2)
3031              ((null (members)) *empty-type*)
3032              (t
3033               (make-member-ctype :members (members))))))))
[6]3034
3035;;; We don't need a :COMPLEX-UNION, since the only interesting case is a union
3036;;; type, and the member/union interaction is handled by the union type
3037;;; method.
3038(define-type-method (member :simple-union) (type1 type2)
3039  (let ((mem1 (member-ctype-members type1))
[279]3040        (mem2 (member-ctype-members type2)))
[6]3041    (cond ((subsetp mem1 mem2) type2)
[279]3042          ((subsetp mem2 mem1) type1)
3043          (t
3044           (make-member-ctype :members (union mem1 mem2))))))
[6]3045
3046
3047(define-type-method (member :simple-=) (type1 type2)
3048  (let ((mem1 (member-ctype-members type1))
[279]3049        (mem2 (member-ctype-members type2)))
[6]3050    (values (and (subsetp mem1 mem2) (subsetp mem2 mem1))
[279]3051            t)))
[6]3052
3053(define-type-method (member :complex-=) (type1 type2)
3054  (if (ctype-enumerable type1)
3055    (multiple-value-bind (val win)
3056                               (csubtypep type2 type1)
3057        (if (or val (not win))
3058        (values nil nil)
3059        (values nil t)))
3060    (values nil t)))
3061
3062(def-type-translator member (&rest members)
[279]3063  (if members
3064    (collect ((non-numbers) (numbers))
3065      (dolist (m (remove-duplicates members))
3066        (if (and (numberp m)
3067                 (not (and (floatp m) (zerop m))))
3068          (numbers (ctype-of m))
3069          (non-numbers m)))
3070      (apply #'type-union
3071             (if (non-numbers)
3072               (make-member-ctype :members (non-numbers))
3073               *empty-type*)
3074             (numbers)))
3075    *empty-type*))
[6]3076
[279]3077
[6]3078
3079;;;; Union types:
3080
3081;;; The Union-Type represents uses of the OR type specifier which can't be
3082;;; canonicalized to something simpler.  Canonical form:
3083;;;
3084;;; 1] There is never more than one Member-Type component.
3085;;; 2] There are never any Union-Type components.
3086;;;
3087
3088(defun make-union-ctype (types)
3089  (declare (list types))
3090  (%istruct 'union-ctype
3091            (type-class-or-lose 'union)
3092            (every #'(lambda (x) (ctype-enumerable x)) types)
3093            types))
3094
3095(defun union-ctype-p (x) (istruct-typep x 'union-ctype))
3096(setf (type-predicate 'union-ctype) 'union-ctype-p)
3097
3098
3099;;;    If List, then return that, otherwise the OR of the component types.
3100;;;
3101(define-type-method (union :unparse) (type)
3102  (declare (type ctype type))
[279]3103    (cond
3104      ((type= type (specifier-type 'list)) 'list)
3105      ((type= type (specifier-type 'float)) 'float)
3106      ((type= type (specifier-type 'real)) 'real)
3107      ((type= type (specifier-type 'sequence)) 'sequence)
3108      ((type= type (specifier-type 'bignum)) 'bignum)
3109      (t `(or ,@(mapcar #'type-specifier (union-ctype-types type))))))
[6]3110
3111
3112
3113(define-type-method (union :simple-=) (type1 type2)
[279]3114  (multiple-value-bind (subtype certain?)
3115      (csubtypep type1 type2)
3116    (if subtype
3117      (csubtypep type2 type1)
3118      (if certain?
3119        (values nil t)
3120        (multiple-value-bind (subtype certain?)
3121            (csubtypep type2 type1)
3122          (declare (ignore subtype))
3123          (values nil certain?))))))
[6]3124
3125
[279]3126(define-type-method (union :complex-=) (type1 type2)
3127  (declare (ignore type1))
3128  (if (some #'type-might-contain-other-types-p 
3129            (union-ctype-types type2))
3130    (values nil nil)
3131    (values nil t)))
3132
3133
3134(defun union-simple-subtypep (type1 type2)
3135  (every/type (swapped-args-fun #'union-complex-subtypep-arg2)
3136              type2
3137              (union-ctype-types type1)))
3138
[6]3139(define-type-method (union :simple-subtypep) (type1 type2)
[279]3140  (union-simple-subtypep type1 type2))
[6]3141
[279]3142(defun union-complex-subtypep-arg1 (type1 type2)
3143  (every/type (swapped-args-fun #'csubtypep)
3144              type2
3145              (union-ctype-types type1)))
[6]3146
3147(define-type-method (union :complex-subtypep-arg1) (type1 type2)
[279]3148  (union-complex-subtypep-arg1 type1 type2))
[6]3149
[279]3150(defun union-complex-subtypep-arg2 (type1 type2)
3151  (multiple-value-bind (sub-value sub-certain?)
3152      (progn
3153        (assert (union-ctype-p type2))
3154        (assert (not (union-ctype-p type1)))
3155        (type= type1
3156               (apply #'type-union
3157                      (mapcar (lambda (x) (type-intersection type1 x))
3158                              (union-ctype-types type2)))))
3159    (if sub-certain?
3160      (values sub-value sub-certain?)
3161      (invoke-complex-subtypep-arg1-method type1 type2))))
3162
[6]3163(define-type-method (union :complex-subtypep-arg2) (type1 type2)
[279]3164  (union-complex-subtypep-arg2 type1 type2))
[6]3165
[279]3166(define-type-method (union :simple-intersection :complex-intersection)
3167    (type1 type2)
3168  (assert (union-ctype-p type2))
3169  (cond ((and (union-ctype-p type1)
3170              (union-simple-subtypep type1 type2)) type1)
3171        ((and (union-ctype-p type1)
3172              (union-simple-subtypep type2 type1)) type2)
3173        ((and (not (union-ctype-p type1))
3174              (union-complex-subtypep-arg2 type1 type2))
3175         type1)
3176        ((and (not (union-ctype-p type1))
3177              (union-complex-subtypep-arg1 type2 type1))
3178         type2)
3179        (t 
3180         (let ((accumulator *empty-type*))
3181           (dolist (t2 (union-ctype-types type2) accumulator)
3182             (setf accumulator
3183                   (type-union accumulator
3184                               (type-intersection type1 t2))))))))
[6]3185
3186
[279]3187
[9892]3188(def-type-translator or (&rest type-specifiers &environment env)
[279]3189  (apply #'type-union
[9892]3190         (mapcar #'(lambda (spec) (specifier-type spec env)) type-specifiers)))
[279]3191
3192
3193;;; Intersection types
3194(defun make-intersection-ctype (enumerable types)
3195  (%istruct 'intersection-ctype
3196            (type-class-or-lose 'intersection)
3197            enumerable
3198            types))
3199
3200(defun intersection-ctype-p (x)
3201  (istruct-typep x 'intersection-ctype))
3202(setf (type-predicate 'intersection-ctype) 'intersection-ctype-p)
3203
3204(define-type-method (intersection :unparse) (type)
3205  (declare (type ctype type))
3206  (or (find type '(ratio keyword) :key #'specifier-type :test #'type=)
3207      `(and ,@(mapcar #'type-specifier (intersection-ctype-types type)))))
3208
3209;;; shared machinery for type equality: true if every type in the set
3210;;; TYPES1 matches a type in the set TYPES2 and vice versa
3211(defun type=-set (types1 types2)
3212  (flet (;; true if every type in the set X matches a type in the set Y
3213         (type<=-set (x y)
3214           (declare (type list x y))
3215           (every (lambda (xelement)
3216                    (position xelement y :test #'type=))
3217                  x)))
3218    (values (and (type<=-set types1 types2)
3219                 (type<=-set types2