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

Last change on this file since 9250 was 9250, checked in by gb, 11 years ago

Don't cache UNKNOWN-CTYPEs.

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