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

Last change on this file since 8854 was 8854, checked in by gz, 12 years ago

Patch from Hans to add :report to parse-unknown-type

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