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

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

Make specifier-type accept (and ignore for now) an optional env arg. Also, make calls to compile-named-function use keyword args

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 146.7 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 &optional env)
1470  (declare (ignore env))
1471  (let ((res (values-specifier-type x)))
1472    (when (values-ctype-p res)
1473      (signal-program-error "VALUES type illegal in this context:~%  ~S" x))
1474    res))
1475
1476(defun single-value-specifier-type (x)
1477  (let ((res (specifier-type x)))
1478    (if (eq res *wild-type*)
1479        *universal-type*
1480        res)))
1481
1482(defun standardized-type-specifier (spec)
1483  (type-specifier (specifier-type spec)))
1484
1485(defun modified-numeric-type (base
1486                              &key
1487                              (class      (numeric-ctype-class      base))
1488                              (format     (numeric-ctype-format     base))
1489                              (complexp   (numeric-ctype-complexp   base))
1490                              (low        (numeric-ctype-low        base))
1491                              (high       (numeric-ctype-high       base))
1492                              (enumerable (ctype-enumerable base)))
1493  (make-numeric-ctype :class class
1494                     :format format
1495                     :complexp complexp
1496                     :low low
1497                     :high high
1498                     :enumerable enumerable))
1499
1500;;; Precompute-Types  --  Interface
1501;;;
1502;;;    Take a list of type specifiers, compute the translation and define it as
1503;;; a builtin type.
1504;;;
1505 
1506(defun precompute-types (specs)
1507  (dolist (spec specs)
1508    (let ((res (specifier-type spec)))
1509      (when (numeric-ctype-p res)
1510        (let ((pred (make-numeric-ctype-predicate res)))
1511          (when pred (setf (numeric-ctype-predicate res) pred))))
1512      (unless (unknown-ctype-p res)
1513          (setf (info-type-builtin spec) res)
1514          (setf (info-type-kind spec) :primitive)))))
1515
1516;;;; Builtin types.
1517
1518;;; The NAMED-TYPE is used to represent *, T and NIL.  These types must be
1519;;; super or sub types of all types, not just classes and * & NIL aren't
1520;;; classes anyway, so it wouldn't make much sense to make them built-in
1521;;; classes.
1522;;;
1523
1524(defun define-named-ctype (name)
1525  (let* ((ctype (%istruct 'named-ctype
1526                          (type-class-or-lose 'named)
1527                          nil
1528                          name)))
1529    (setf (info-type-kind name) :builtin
1530          (info-type-builtin name) ctype)))
1531
1532
1533(defvar *wild-type* (define-named-ctype '*))
1534(defvar *empty-type* (define-named-ctype nil))
1535(defvar *universal-type* (define-named-ctype t))
1536
1537(defun named-ctype-p (x)
1538  (istruct-typep x 'named-ctype))
1539
1540(setf (type-predicate 'named-ctype) 'named-ctype-p)
1541
1542(define-type-method (named :simple-=) (type1 type2)
1543  (values (eq type1 type2) t))
1544
1545(define-type-method (named :complex-=) (type1 type2)
1546  (cond
1547    ((and (eq type2 *empty-type*)
1548          (intersection-ctype-p type1)
1549          ;; not allowed to be unsure on these... FIXME: keep the list
1550          ;; of CL types that are intersection types once and only
1551          ;; once.
1552          (not (or (type= type1 (specifier-type 'ratio))
1553                   (type= type1 (specifier-type 'keyword)))))
1554     ;; things like (AND (EQL 0) (SATISFIES ODDP)) or (AND FUNCTION
1555     ;; STREAM) can get here.  In general, we can't really tell
1556     ;; whether these are equal to NIL or not, so
1557     (values nil nil))
1558    ((type-might-contain-other-types-p type1)
1559     (invoke-complex-=-other-method type1 type2))
1560    (t (values nil t))))
1561
1562
1563(define-type-method (named :simple-subtypep) (type1 type2)
1564  (values (or (eq type1 *empty-type*) (eq type2 *wild-type*)) t))
1565
1566(define-type-method (named :complex-subtypep-arg1) (type1 type2)
1567  (cond ((eq type1 *empty-type*)
1568         t)
1569        (;; When TYPE2 might be the universal type in disguise
1570         (type-might-contain-other-types-p type2)
1571         ;; Now that the UNION and HAIRY COMPLEX-SUBTYPEP-ARG2 methods
1572         ;; can delegate to us (more or less as CALL-NEXT-METHOD) when
1573         ;; they're uncertain, we can't just barf on COMPOUND-TYPE and
1574         ;; HAIRY-TYPEs as we used to. Instead we deal with the
1575         ;; problem (where at least part of the problem is cases like
1576         ;;   (SUBTYPEP T '(SATISFIES FOO))
1577         ;; or
1578         ;;   (SUBTYPEP T '(AND (SATISFIES FOO) (SATISFIES BAR)))
1579         ;; where the second type is a hairy type like SATISFIES, or
1580         ;; is a compound type which might contain a hairy type) by
1581         ;; returning uncertainty.
1582         (values nil nil))
1583        (t
1584         ;; By elimination, TYPE1 is the universal type.
1585         (assert (or (eq type1 *wild-type*) (eq type1 *universal-type*)))
1586         ;; This case would have been picked off by the SIMPLE-SUBTYPEP
1587         ;; method, and so shouldn't appear here.
1588         (assert (not (eq type2 *universal-type*)))
1589         ;; Since TYPE2 is not EQ *UNIVERSAL-TYPE* and is not the
1590         ;; universal type in disguise, TYPE2 is not a superset of TYPE1.
1591         (values nil t))))
1592
1593
1594(define-type-method (named :complex-subtypep-arg2) (type1 type2)
1595  (assert (not (eq type2 *wild-type*))) ; * isn't really a type.
1596  (cond ((eq type2 *universal-type*)
1597         (values t t))
1598        ((type-might-contain-other-types-p type1)
1599         ;; those types can be *EMPTY-TYPE* or *UNIVERSAL-TYPE* in
1600         ;; disguise.  So we'd better delegate.
1601         (invoke-complex-subtypep-arg1-method type1 type2))
1602        (t
1603         ;; FIXME: This seems to rely on there only being 2 or 3
1604         ;; NAMED-TYPE values, and the exclusion of various
1605         ;; possibilities above. It would be good to explain it and/or
1606         ;; rewrite it so that it's clearer.
1607         (values (not (eq type2 *empty-type*)) t))))
1608
1609
1610(define-type-method (named :complex-intersection) (type1 type2)
1611  (hierarchical-intersection2 type1 type2))
1612
1613(define-type-method (named :unparse) (x)
1614  (named-ctype-name x))
1615
1616
1617;;;; Hairy and unknown types:
1618
1619;;; The Hairy-Type represents anything too wierd to be described
1620;;; reasonably or to be useful, such as SATISFIES.  We just remember
1621;;; the original type spec.
1622;;;
1623
1624(defun make-hairy-ctype (&key specifier (enumerable t))
1625  (%istruct 'hairy-ctype
1626            (type-class-or-lose 'hairy)
1627            enumerable
1628            specifier))
1629
1630(defun hairy-ctype-p (x)
1631  (istruct-typep x 'hairy-ctype))
1632
1633(setf (type-predicate 'hairy-ctype) 'hairy-ctype-p)
1634
1635(define-type-method (hairy :unparse) (x) (hairy-ctype-specifier x))
1636
1637(define-type-method (hairy :simple-subtypep) (type1 type2)
1638  (let ((hairy-spec1 (hairy-ctype-specifier type1))
1639        (hairy-spec2 (hairy-ctype-specifier type2)))
1640    (cond ((equal-but-no-car-recursion hairy-spec1 hairy-spec2)
1641           (values t t))
1642          (t
1643           (values nil nil)))))
1644
1645(define-type-method (hairy :complex-subtypep-arg2) (type1 type2)
1646  (invoke-complex-subtypep-arg1-method type1 type2))
1647
1648(define-type-method (hairy :complex-subtypep-arg1) (type1 type2)
1649  (declare (ignore type1 type2))
1650  (values nil nil))
1651
1652(define-type-method (hairy :complex-=) (type1 type2)
1653  (if (and (unknown-ctype-p type2)
1654           (let* ((specifier2 (unknown-ctype-specifier type2))
1655                  (name2 (if (consp specifier2)
1656                           (car specifier2)
1657                           specifier2)))
1658             (info-type-kind name2)))
1659      (let ((type2 (specifier-type (unknown-ctype-specifier type2))))
1660        (if (unknown-ctype-p type2)
1661            (values nil nil)
1662            (type= type1 type2)))
1663  (values nil nil)))
1664
1665(define-type-method (hairy :simple-intersection :complex-intersection)
1666                    (type1 type2)
1667  (if (type= type1 type2)
1668    type1
1669    nil))
1670
1671
1672(define-type-method (hairy :simple-union) 
1673    (type1 type2)
1674  (if (type= type1 type2)
1675      type1
1676      nil))
1677
1678(define-type-method (hairy :simple-=) (type1 type2)
1679  (if (equal-but-no-car-recursion (hairy-ctype-specifier type1)
1680                                  (hairy-ctype-specifier type2))
1681      (values t t)
1682      (values nil nil)))
1683
1684
1685
1686(def-type-translator satisfies (&whole x fun)
1687  (unless (symbolp fun)
1688    (report-bad-arg fun 'symbol))
1689  (make-hairy-ctype :specifier x))
1690
1691
1692;;; Negation Ctypes
1693(defun make-negation-ctype (&key type (enumerable t))
1694  (%istruct 'negation-ctype
1695            (type-class-or-lose 'negation)
1696            enumerable
1697            type))
1698
1699(defun negation-ctype-p (x)
1700  (istruct-typep x 'negation-ctype))
1701
1702(setf (type-predicate 'negation-ctype) 'negation-ctype-p)
1703
1704
1705(define-type-method (negation :unparse) (x)
1706  `(not ,(type-specifier (negation-ctype-type x))))
1707
1708(define-type-method (negation :simple-subtypep) (type1 type2)
1709  (csubtypep (negation-ctype-type type2) (negation-ctype-type type1)))
1710
1711(define-type-method (negation :complex-subtypep-arg2) (type1 type2)
1712  (let* ((complement-type2 (negation-ctype-type type2))
1713         (intersection2 (type-intersection type1 complement-type2)))
1714    (if intersection2
1715        ;; FIXME: if uncertain, maybe try arg1?
1716        (type= intersection2 *empty-type*)
1717        (invoke-complex-subtypep-arg1-method type1 type2))))
1718
1719(define-type-method (negation :complex-subtypep-arg1) (type1 type2)
1720  (block nil
1721    ;; (Several logical truths in this block are true as long as
1722    ;; b/=T. As of sbcl-0.7.1.28, it seems impossible to construct a
1723    ;; case with b=T where we actually reach this type method, but
1724    ;; we'll test for and exclude this case anyway, since future
1725    ;; maintenance might make it possible for it to end up in this
1726    ;; code.)
1727    (multiple-value-bind (equal certain)
1728        (type= type2 *universal-type*)
1729      (unless certain
1730        (return (values nil nil)))
1731      (when equal
1732        (return (values t t))))
1733    (let ((complement-type1 (negation-ctype-type type1)))
1734      ;; Do the special cases first, in order to give us a chance if
1735      ;; subtype/supertype relationships are hairy.
1736      (multiple-value-bind (equal certain) 
1737          (type= complement-type1 type2)
1738        ;; If a = b, ~a is not a subtype of b (unless b=T, which was
1739        ;; excluded above).
1740        (unless certain
1741          (return (values nil nil)))
1742        (when equal
1743          (return (values nil t))))
1744      ;; KLUDGE: ANSI requires that the SUBTYPEP result between any
1745      ;; two built-in atomic type specifiers never be uncertain. This
1746      ;; is hard to do cleanly for the built-in types whose
1747      ;; definitions include (NOT FOO), i.e. CONS and RATIO. However,
1748      ;; we can do it with this hack, which uses our global knowledge
1749      ;; that our implementation of the type system uses disjoint
1750      ;; implementation types to represent disjoint sets (except when
1751      ;; types are contained in other types).  (This is a KLUDGE
1752      ;; because it's fragile. Various changes in internal
1753      ;; representation in the type system could make it start
1754      ;; confidently returning incorrect results.) -- WHN 2002-03-08
1755      (unless (or (type-might-contain-other-types-p complement-type1)
1756                  (type-might-contain-other-types-p type2))
1757        ;; Because of the way our types which don't contain other
1758        ;; types are disjoint subsets of the space of possible values,
1759        ;; (SUBTYPEP '(NOT AA) 'B)=NIL when AA and B are simple (and B
1760        ;; is not T, as checked above).
1761        (return (values nil t)))
1762      ;; The old (TYPE= TYPE1 TYPE2) branch would never be taken, as
1763      ;; TYPE1 and TYPE2 will only be equal if they're both NOT types,
1764      ;; and then the :SIMPLE-SUBTYPEP method would be used instead.
1765      ;; But a CSUBTYPEP relationship might still hold:
1766      (multiple-value-bind (equal certain)
1767          (csubtypep complement-type1 type2)
1768        ;; If a is a subtype of b, ~a is not a subtype of b (unless
1769        ;; b=T, which was excluded above).
1770        (unless certain
1771          (return (values nil nil)))
1772        (when equal
1773          (return (values nil t))))
1774      (multiple-value-bind (equal certain)
1775          (csubtypep type2 complement-type1)
1776        ;; If b is a subtype of a, ~a is not a subtype of b.  (FIXME:
1777        ;; That's not true if a=T. Do we know at this point that a is
1778        ;; not T?)
1779        (unless certain
1780          (return (values nil nil)))
1781        (when equal
1782          (return (values nil t))))
1783      ;; old CSR comment ca. 0.7.2, now obsoleted by the SIMPLE-CTYPE?
1784      ;; KLUDGE case above: Other cases here would rely on being able
1785      ;; to catch all possible cases, which the fragility of this type
1786      ;; system doesn't inspire me; for instance, if a is type= to ~b,
1787      ;; then we want T, T; if this is not the case and the types are
1788      ;; disjoint (have an intersection of *empty-type*) then we want
1789      ;; NIL, T; else if the union of a and b is the *universal-type*
1790      ;; then we want T, T. So currently we still claim to be unsure
1791      ;; about e.g. (subtypep '(not fixnum) 'single-float).
1792      ;;
1793      ;; OTOH we might still get here:
1794      (values nil nil))))
1795
1796(define-type-method (negation :complex-=) (type1 type2)
1797  ;; (NOT FOO) isn't equivalent to anything that's not a negation
1798  ;; type, except possibly a type that might contain it in disguise.
1799  (declare (ignore type2))
1800  (if (type-might-contain-other-types-p type1)
1801      (values nil nil)
1802      (values nil t)))
1803
1804(define-type-method (negation :simple-intersection) (type1 type2)
1805  (let ((not1 (negation-ctype-type type1))
1806        (not2 (negation-ctype-type type2)))
1807    (cond
1808      ((csubtypep not1 not2) type2)
1809      ((csubtypep not2 not1) type1)
1810      ;; Why no analagous clause to the disjoint in the SIMPLE-UNION2
1811      ;; method, below?  The clause would read
1812      ;;
1813      ;; ((EQ (TYPE-UNION NOT1 NOT2) *UNIVERSAL-TYPE*) *EMPTY-TYPE*)
1814      ;;
1815      ;; but with proper canonicalization of negation types, there's
1816      ;; no way of constructing two negation types with union of their
1817      ;; negations being the universal type.
1818      (t
1819       nil))))
1820
1821(define-type-method (negation :complex-intersection) (type1 type2)
1822  (cond
1823    ((csubtypep type1 (negation-ctype-type type2)) *empty-type*)
1824    ((eq (type-intersection type1 (negation-ctype-type type2)) *empty-type*)
1825     type1)
1826    (t nil)))
1827
1828(define-type-method (negation :simple-union) (type1 type2)
1829  (let ((not1 (negation-ctype-type type1))
1830        (not2 (negation-ctype-type type2)))
1831    (cond
1832      ((csubtypep not1 not2) type1)
1833      ((csubtypep not2 not1) type2)
1834      ((eq (type-intersection not1 not2) *empty-type*)
1835       *universal-type*)
1836      (t nil))))
1837
1838(define-type-method (negation :complex-union) (type1 type2)
1839  (cond
1840    ((csubtypep (negation-ctype-type type2) type1) *universal-type*)
1841    ((eq (type-intersection type1 (negation-ctype-type type2)) *empty-type*)
1842     type2)
1843    (t nil)))
1844
1845(define-type-method (negation :simple-=) (type1 type2)
1846  (type= (negation-ctype-type type1) (negation-ctype-type type2)))
1847
1848(def-type-translator not (typespec)
1849  (let* ((not-type (specifier-type typespec))
1850         (spec (type-specifier not-type)))
1851    (cond
1852      ;; canonicalize (NOT (NOT FOO))
1853      ((and (listp spec) (eq (car spec) 'not))
1854       (specifier-type (cadr spec)))
1855      ;; canonicalize (NOT NIL) and (NOT T)
1856      ((eq not-type *empty-type*) *universal-type*)
1857      ((eq not-type *universal-type*) *empty-type*)
1858      ((and (numeric-ctype-p not-type)
1859            (null (numeric-ctype-low not-type))
1860            (null (numeric-ctype-high not-type)))
1861       (make-negation-ctype :type not-type))
1862      ((numeric-ctype-p not-type)
1863       (type-union
1864        (make-negation-ctype
1865         :type (modified-numeric-type not-type :low nil :high nil))
1866        (cond
1867          ((null (numeric-ctype-low not-type))
1868           (modified-numeric-type
1869            not-type
1870            :low (let ((h (numeric-ctype-high not-type)))
1871                   (if (consp h) (car h) (list h)))
1872            :high nil))
1873          ((null (numeric-ctype-high not-type))
1874           (modified-numeric-type
1875            not-type
1876            :low nil
1877            :high (let ((l (numeric-ctype-low not-type)))
1878                    (if (consp l) (car l) (list l)))))
1879          (t (type-union
1880              (modified-numeric-type
1881               not-type
1882               :low nil
1883               :high (let ((l (numeric-ctype-low not-type)))
1884                       (if (consp l) (car l) (list l))))
1885              (modified-numeric-type
1886               not-type
1887               :low (let ((h (numeric-ctype-high not-type)))
1888                      (if (consp h) (car h) (list h)))
1889               :high nil))))))
1890      ((intersection-ctype-p not-type)
1891       (apply #'type-union
1892              (mapcar #'(lambda (x)
1893                          (specifier-type `(not ,(type-specifier x))))
1894                      (intersection-ctype-types not-type))))
1895      ((union-ctype-p not-type)
1896       (apply #'type-intersection
1897              (mapcar #'(lambda (x)
1898                          (specifier-type `(not ,(type-specifier x))))
1899                      (union-ctype-types not-type))))
1900      ((member-ctype-p not-type)
1901       (let ((members (member-ctype-members not-type)))
1902         (if (some #'floatp members)
1903           (let (floats)
1904             (dolist (pair '((0.0f0 . -0.0f0) (0.0d0 . -0.0d0)))
1905               (when (member (car pair) members)
1906                 (assert (not (member (cdr pair) members)))
1907                 (push (cdr pair) floats)
1908                 (setf members (remove (car pair) members)))
1909               (when (member (cdr pair) members)
1910                 (assert (not (member (car pair) members)))
1911                 (push (car pair) floats)
1912                 (setf members (remove (cdr pair) members))))
1913             (apply #'type-intersection
1914                    (if (null members)
1915                      *universal-type*
1916                      (make-negation-ctype
1917                       :type (make-member-ctype :members members)))
1918                    (mapcar
1919                     (lambda (x)
1920                       (let ((type (ctype-of x)))
1921                         (type-union
1922                          (make-negation-ctype
1923                           :type (modified-numeric-type type
1924                                                          :low nil :high nil))
1925                            (modified-numeric-type type
1926                                                   :low nil :high (list x))
1927                            (make-member-ctype :members (list x))
1928                            (modified-numeric-type type
1929                                                   :low (list x) :high nil))))
1930                     floats)))
1931             (make-negation-ctype :type not-type))))
1932      ((and (cons-ctype-p not-type)
1933            (eq (cons-ctype-car-ctype not-type) *universal-type*)
1934            (eq (cons-ctype-cdr-ctype not-type) *universal-type*))
1935       (make-negation-ctype :type not-type))
1936      ((cons-ctype-p not-type)
1937       (type-union
1938        (make-negation-ctype :type (specifier-type 'cons))
1939        (cond
1940          ((and (not (eq (cons-ctype-car-ctype not-type) *universal-type*))
1941                (not (eq (cons-ctype-cdr-ctype not-type) *universal-type*)))
1942           (type-union
1943            (make-cons-ctype
1944             (specifier-type `(not ,(type-specifier
1945                                     (cons-ctype-car-ctype not-type))))
1946             *universal-type*)
1947            (make-cons-ctype
1948             *universal-type*
1949             (specifier-type `(not ,(type-specifier
1950                                     (cons-ctype-cdr-ctype not-type)))))))
1951          ((not (eq (cons-ctype-car-ctype not-type) *universal-type*))
1952           (make-cons-ctype
1953            (specifier-type `(not ,(type-specifier
1954                                    (cons-ctype-car-ctype not-type))))
1955            *universal-type*))
1956          ((not (eq (cons-ctype-cdr-ctype not-type) *universal-type*))
1957           (make-cons-ctype
1958            *universal-type*
1959            (specifier-type `(not ,(type-specifier
1960                                    (cons-ctype-cdr-ctype not-type))))))
1961          (t (error "Weird CONS type ~S" not-type)))))
1962      (t (make-negation-ctype :type not-type)))))
1963
1964
1965;;;; Numeric types.
1966
1967;;; A list of all the float formats, in order of decreasing precision.
1968;;;
1969(eval-when (:compile-toplevel :load-toplevel :execute)
1970  (defconstant float-formats
1971    '(long-float double-float single-float short-float)))
1972
1973;;; The type of a float format.
1974;;;
1975(deftype float-format () `(member ,@float-formats))
1976
1977(defun type-bound-number (x)
1978  (if (consp x)
1979      (destructuring-bind (result) x result)
1980      x))
1981
1982(defun make-numeric-ctype (&key class 
1983                                format
1984                                (complexp :real)
1985                                low
1986                                high
1987                                enumerable
1988                                predicate)
1989  ;; if interval is empty
1990  (if (and low
1991           high
1992           (if (or (consp low) (consp high)) ; if either bound is exclusive
1993             (>= (type-bound-number low) (type-bound-number high))
1994             (> low high)))
1995    *empty-type*
1996    (multiple-value-bind (canonical-low canonical-high)
1997        (case class
1998          (integer
1999           ;; INTEGER types always have their LOW and HIGH bounds
2000           ;; represented as inclusive, not exclusive values.
2001           (values (if (consp low)
2002                     (1+ (type-bound-number low))
2003                     low)
2004                   (if (consp high)
2005                     (1- (type-bound-number high))
2006                     high)))
2007          (t 
2008           ;; no canonicalization necessary
2009           (values low high)))
2010      (when (and (eq class 'rational)
2011                 (integerp canonical-low)
2012                 (integerp canonical-high)
2013                 (= canonical-low canonical-high))
2014        (setf class 'integer))
2015      (%istruct 'numeric-ctype
2016                (type-class-or-lose 'number)
2017                enumerable
2018                class
2019                format
2020                complexp
2021                canonical-low
2022                canonical-high
2023                predicate))))
2024   
2025
2026(defun make-numeric-ctype-predicate (ctype)
2027  (let ((class (numeric-ctype-class ctype))
2028        (lo (numeric-ctype-low ctype))
2029        (hi (numeric-ctype-high ctype)))
2030    (if (eq class 'integer)
2031      (if (and hi
2032               lo
2033               (<= hi target::target-most-positive-fixnum)
2034               (>= lo target::target-most-negative-fixnum))     
2035        #'(lambda (n)
2036            (and (fixnump n)
2037                 (locally (declare (fixnum n hi lo))
2038                   (and (%i>= n lo)
2039                        (%i<= n hi)))))))))
2040
2041(defun numeric-ctype-p (x)
2042  (istruct-typep x 'numeric-ctype))
2043
2044(setf (type-predicate 'numeric-ctype) 'numeric-ctype-p)
2045
2046(define-type-method (number :simple-=) (type1 type2)
2047  (values
2048   (and (eq (numeric-ctype-class type1) (numeric-ctype-class type2))
2049        (eq (numeric-ctype-format type1) (numeric-ctype-format type2))
2050        (eq (numeric-ctype-complexp type1) (numeric-ctype-complexp type2))
2051        (equalp (numeric-ctype-low type1) (numeric-ctype-low type2))
2052        (equalp (numeric-ctype-high type1) (numeric-ctype-high type2)))
2053   t))
2054
2055(define-type-method (number :unparse) (type)
2056  (let* ((complexp (numeric-ctype-complexp type))
2057         (low (numeric-ctype-low type))
2058         (high (numeric-ctype-high type))
2059         (base (case (numeric-ctype-class type)
2060                 (integer 'integer)
2061                 (rational 'rational)
2062                 (float (or (numeric-ctype-format type) 'float))
2063                 (t 'real))))
2064    (let ((base+bounds
2065           (cond ((and (eq base 'integer) high low)
2066                  (let ((high-count (logcount high))
2067                        (high-length (integer-length high)))
2068                    (cond ((= low 0)
2069                           (cond ((= high 0) '(integer 0 0))
2070                                 ((= high 1) 'bit)
2071                                 ((and (= high-count high-length)
2072                                       (plusp high-length))
2073                                  `(unsigned-byte ,high-length))
2074                                 (t
2075                                  `(mod ,(1+ high)))))
2076                          ((and (= low target::target-most-negative-fixnum)
2077                                (= high target::target-most-positive-fixnum))
2078                           'fixnum)
2079                          ((and (= low (lognot high))
2080                                (= high-count high-length)
2081                                (> high-count 0))
2082                           `(signed-byte ,(1+ high-length)))
2083                          (t
2084                           `(integer ,low ,high)))))
2085                 (high `(,base ,(or low '*) ,high))
2086                 (low
2087                  (if (and (eq base 'integer) (= low 0))
2088                      'unsigned-byte
2089                      `(,base ,low)))
2090                 (t base))))
2091      (ecase complexp
2092        (:real
2093         base+bounds)
2094        (:complex
2095         (if (eq base+bounds 'real)
2096             'complex
2097             `(complex ,base+bounds)))
2098        ((nil)
2099         (assert (eq base+bounds 'real))
2100         'number)))))
2101
2102;;; Numeric-Bound-Test  --  Internal
2103;;;
2104;;;    Return true if X is "less than or equal" to Y, taking open bounds into
2105;;; consideration.  Closed is the predicate used to test the bound on a closed
2106;;; interval (e.g. <=), and Open is the predicate used on open bounds (e.g. <).
2107;;; Y is considered to be the outside bound, in the sense that if it is
2108;;; infinite (NIL), then the test suceeds, whereas if X is infinite, then the
2109;;; test fails (unless Y is also infinite).
2110;;;
2111;;;    This is for comparing bounds of the same kind, e.g. upper and upper.
2112;;; Use Numeric-Bound-Test* for different kinds of bounds.
2113;;;
2114(defmacro numeric-bound-test (x y closed open)
2115  `(cond ((not ,y) t)
2116           ((not ,x) nil)
2117           ((consp ,x)
2118            (if (consp ,y)
2119              (,closed (car ,x) (car ,y))
2120              (,closed (car ,x) ,y)))
2121           (t
2122            (if (consp ,y)
2123              (,open ,x (car ,y))
2124              (,closed ,x ,y)))))
2125
2126;;; Numeric-Bound-Test*  --  Internal
2127;;;
2128;;;    Used to compare upper and lower bounds.  This is different from the
2129;;; same-bound case:
2130;;; -- Since X = NIL is -infinity, whereas y = NIL is +infinity, we return true
2131;;;    if *either* arg is NIL.
2132;;; -- an open inner bound is "greater" and also squeezes the interval, causing
2133;;;    us to use the Open test for those cases as well.
2134;;;
2135(defmacro numeric-bound-test* (x y closed open)
2136  `(cond ((not ,y) t)
2137         ((not ,x) t)
2138         ((consp ,x)
2139          (if (consp ,y)
2140              (,open (car ,x) (car ,y))
2141              (,open (car ,x) ,y)))
2142         (t
2143          (if (consp ,y)
2144              (,open ,x (car ,y))
2145              (,closed ,x ,y)))))
2146
2147;;; Numeric-Bound-Max  --  Internal
2148;;;
2149;;;    Return whichever of the numeric bounds X and Y is "maximal" according to
2150;;; the predicates Closed (e.g. >=) and Open (e.g. >).  This is only meaningful
2151;;; for maximizing like bounds, i.e. upper and upper.  If Max-P is true, then
2152;;; we return NIL if X or Y is NIL, otherwise we return the other arg.
2153;;;
2154(defmacro numeric-bound-max (x y closed open max-p)
2155  (once-only ((n-x x)
2156              (n-y y))
2157    `(cond
2158      ((not ,n-x) ,(if max-p nil n-y))
2159      ((not ,n-y) ,(if max-p nil n-x))
2160      ((consp ,n-x)
2161       (if (consp ,n-y)
2162         (if (,closed (car ,n-x) (car ,n-y)) ,n-x ,n-y)
2163         (if (,open (car ,n-x) ,n-y) ,n-x ,n-y)))
2164      (t
2165       (if (consp ,n-y)
2166         (if (,open (car ,n-y) ,n-x) ,n-y ,n-x)
2167         (if (,closed ,n-y ,n-x) ,n-y ,n-x))))))
2168
2169
2170(define-type-method (number :simple-subtypep) (type1 type2)
2171  (let ((class1 (numeric-ctype-class type1))
2172          (class2 (numeric-ctype-class type2))
2173          (complexp2 (numeric-ctype-complexp type2))
2174          (format2 (numeric-ctype-format type2))
2175          (low1 (numeric-ctype-low type1))
2176          (high1 (numeric-ctype-high type1))
2177          (low2 (numeric-ctype-low type2))
2178          (high2 (numeric-ctype-high type2)))
2179    ;;
2180    ;; If one is complex and the other isn't, they are disjoint.
2181    (cond ((not (or (eq (numeric-ctype-complexp type1) complexp2)
2182                        (null complexp2)))
2183             (values nil t))
2184            ;;
2185            ;; If the classes are specified and different, the types are
2186            ;; disjoint unless type2 is rational and type1 is integer.
2187            ((not (or (eq class1 class2) (null class2)
2188                        (and (eq class1 'integer) (eq class2 'rational))))
2189             (values nil t))
2190            ;;
2191            ;; If the float formats are specified and different, the types
2192            ;; are disjoint.
2193            ((not (or (eq (numeric-ctype-format type1) format2)
2194                        (null format2)))
2195             (values nil t))
2196            ;;
2197            ;; Check the bounds.
2198            ((and (numeric-bound-test low1 low2 >= >)
2199                    (numeric-bound-test high1 high2 <= <))
2200             (values t t))
2201            (t
2202             (values nil t)))))
2203
2204;(define-superclasses number (generic-number))
2205
2206;;; NUMERIC-TYPES-ADJACENT  --  Internal
2207;;;
2208;;;    If the high bound of Low is adjacent to the low bound of High, then
2209;;; return T, otherwise NIL.
2210;;;
2211(defun numeric-types-adjacent (low high)
2212  (let ((low-bound (numeric-ctype-high low))
2213        (high-bound (numeric-ctype-low high)))
2214    (cond ((not (and low-bound high-bound)) nil)
2215            ((consp low-bound)
2216             (eql (car low-bound) high-bound))
2217            ((consp high-bound)
2218             (eql (car high-bound) low-bound))
2219            ((and (eq (numeric-ctype-class low) 'integer)
2220                    (eq (numeric-ctype-class high) 'integer))
2221             (eql (1+ low-bound) high-bound))
2222            (t
2223             nil))))
2224
2225;;;
2226;;; Return a numeric type that is a supertype for both type1 and type2.
2227;;;
2228(define-type-method (number :simple-union) (type1 type2)
2229  (declare (type numeric-ctype type1 type2))
2230  (cond ((csubtypep type1 type2) type2)
2231        ((csubtypep type2 type1) type1)
2232        (t
2233         (let ((class1 (numeric-ctype-class type1))
2234               (format1 (numeric-ctype-format type1))
2235               (complexp1 (numeric-ctype-complexp type1))
2236               (class2 (numeric-ctype-class type2))
2237               (format2 (numeric-ctype-format type2))
2238               (complexp2 (numeric-ctype-complexp type2)))
2239           (cond
2240             ((and (eq class1 class2)
2241                   (eq format1 format2)
2242                   (eq complexp1 complexp2)
2243                   (or (numeric-types-intersect type1 type2)
2244                       (numeric-types-adjacent type1 type2)
2245                       (numeric-types-adjacent type2 type1)))
2246              (make-numeric-ctype
2247               :class class1
2248               :format format1
2249               :complexp complexp1
2250               :low (numeric-bound-max (numeric-ctype-low type1)
2251                                       (numeric-ctype-low type2)
2252                                       <= < t)
2253               :high (numeric-bound-max (numeric-ctype-high type1)
2254                                        (numeric-ctype-high type2)
2255                                        >= > t)))
2256             ;; FIXME: These two clauses are almost identical, and the
2257             ;; consequents are in fact identical in every respect.
2258             ((and (eq class1 'rational)
2259                   (eq class2 'integer)
2260                   (eq format1 format2)
2261                   (eq complexp1 complexp2)
2262                   (integerp (numeric-ctype-low type2))
2263                   (integerp (numeric-ctype-high type2))
2264                   (= (numeric-ctype-low type2) (numeric-ctype-high type2))
2265                   (or (numeric-types-adjacent type1 type2)
2266                       (numeric-types-adjacent type2 type1)))
2267              (make-numeric-ctype
2268               :class 'rational
2269               :format format1
2270               :complexp complexp1
2271               :low (numeric-bound-max (numeric-ctype-low type1)
2272                                       (numeric-ctype-low type2)
2273                                       <= < t)
2274               :high (numeric-bound-max (numeric-ctype-high type1)
2275                                        (numeric-ctype-high type2)
2276                                        >= > t)))
2277             ((and (eq class1 'integer)
2278                   (eq class2 'rational)
2279                   (eq format1 format2)
2280                   (eq complexp1 complexp2)
2281                   (integerp (numeric-ctype-low type1))
2282                   (integerp (numeric-ctype-high type1))
2283                   (= (numeric-ctype-low type1) (numeric-ctype-high type1))
2284                   (or (numeric-types-adjacent type1 type2)
2285                       (numeric-types-adjacent type2 type1)))
2286              (make-numeric-ctype
2287               :class 'rational
2288               :format format1
2289               :complexp complexp1
2290               :low (numeric-bound-max (numeric-ctype-low type1)
2291                                       (numeric-ctype-low type2)
2292                                       <= < t)
2293               :high (numeric-bound-max (numeric-ctype-high type1)
2294                                        (numeric-ctype-high type2)
2295                                        >= > t)))
2296             (t nil))))))
2297
2298(setf (info-type-kind 'number) :primitive
2299      (info-type-builtin 'number) (make-numeric-ctype :complexp nil))
2300
2301(def-type-translator complex (&optional spec)
2302  (if (eq spec '*)
2303      (make-numeric-ctype :complexp :complex)
2304      (labels ((not-numeric ()
2305                 (error "Component type for Complex is not numeric: ~S." spec))
2306               (not-real ()
2307                 (error "Component type for Complex is not a subtype of real: ~S." spec))
2308               (complex1 (component-type)
2309                 (unless (numeric-ctype-p component-type)
2310                   (not-numeric))
2311                 (when (eq (numeric-ctype-complexp component-type) :complex)
2312                   (not-real))
2313                 (let ((res (copy-uvector component-type)))
2314                   (setf (numeric-ctype-complexp res) :complex)
2315                   (setf (numeric-ctype-predicate res) nil) ; <<
2316                   res))
2317               (do-complex (ctype)
2318                 (cond
2319                   ((eq ctype *empty-type*) *empty-type*)
2320                   ((eq ctype *universal-type*) (not-real))
2321                   ((numeric-ctype-p ctype) (complex1 ctype))
2322                   ((union-ctype-p ctype)
2323                    (apply #'type-union
2324                           (mapcar #'do-complex (union-ctype-types ctype))))
2325                   ((member-ctype-p ctype)
2326                    (apply #'type-union
2327                           (mapcar (lambda (x) (do-complex (ctype-of x)))
2328                                   (member-ctype-members ctype))))
2329                   ((and (intersection-ctype-p ctype)
2330                         ;; just enough to handle simple types like RATIO.
2331                         (let ((numbers (remove-if-not
2332                                         #'numeric-ctype-p
2333                                         (intersection-ctype-types ctype))))
2334                           (and (car numbers)
2335                                (null (cdr numbers))
2336                                (eq (numeric-ctype-complexp (car numbers)) :real)
2337                                (complex1 (car numbers))))))
2338                   (t                   ; punt on harder stuff for now
2339                    (not-real)))))
2340        (let ((ctype (specifier-type spec)))
2341          (do-complex ctype)))))
2342
2343;;; Check-Bound  --  Internal
2344;;;
2345;;;    Check that X is a well-formed numeric bound of the specified Type.
2346;;; If X is *, return NIL, otherwise return the bound.
2347;;;
2348(defmacro check-bound (x type)
2349  `(cond ((eq ,x '*) nil)
2350           ((or (typep ,x ',type)
2351                (and (consp ,x) (typep (car ,x) ',type) (null (cdr ,x))))
2352            ,x)
2353           (t
2354            (error "Bound is not *, a ~A or a list of a ~A: ~S" ',type ',type ,x))))
2355
2356(def-type-translator integer (&optional low high)
2357  (let* ((l (check-bound low integer))
2358         (lb (if (consp l) (1+ (car l)) l))
2359         (h (check-bound high integer))
2360         (hb (if (consp h) (1- (car h)) h)))
2361    (if (and hb lb (< hb lb))
2362      *empty-type*
2363      (make-numeric-ctype :class 'integer  :complexp :real
2364                          :enumerable (not (null (and l h)))
2365                          :low lb
2366                          :high hb))))
2367
2368(deftype mod (n)
2369  (unless (and (integerp n) (> n 0))
2370    (error "Bad N specified for MOD type specifier: ~S." n))
2371  `(integer 0 ,(1- n)))
2372
2373
2374(defmacro def-bounded-type (type class format)
2375  `(def-type-translator ,type (&optional low high)
2376     (let ((lb (check-bound low ,type))
2377             (hb (check-bound high ,type)))
2378       (unless (numeric-bound-test* lb hb <= <)
2379           (error "Lower bound ~S is not less than upper bound ~S." low high))
2380       (make-numeric-ctype :class ',class :format ',format :low lb :high hb))))
2381
2382(def-bounded-type rational rational nil)
2383
2384(defun coerce-bound (bound type inner-coerce-bound-fun)
2385  (declare (type function inner-coerce-bound-fun))
2386  (cond ((eql bound '*)
2387         bound)
2388        ((consp bound)
2389         (destructuring-bind (inner-bound) bound
2390           (list (funcall inner-coerce-bound-fun inner-bound type))))
2391        (t
2392         (funcall inner-coerce-bound-fun bound type))))
2393
2394(defun inner-coerce-real-bound (bound type)
2395  (ecase type
2396    (rational (rationalize bound))
2397    (float (if (floatp bound)
2398               bound
2399               ;; Coerce to the widest float format available, to
2400               ;; avoid unnecessary loss of precision:
2401               (coerce bound 'long-float)))))
2402
2403(defun coerced-real-bound (bound type)
2404  (coerce-bound bound type #'inner-coerce-real-bound))
2405
2406(defun coerced-float-bound (bound type)
2407  (coerce-bound bound type #'coerce))
2408
2409(def-type-translator real (&optional (low '*) (high '*))
2410  (specifier-type `(or (float ,(coerced-real-bound  low 'float)
2411                              ,(coerced-real-bound high 'float))
2412                       (rational ,(coerced-real-bound  low 'rational)
2413                                 ,(coerced-real-bound high 'rational)))))
2414
2415(def-type-translator float (&optional (low '*) (high '*))
2416  (specifier-type 
2417   `(or (single-float ,(coerced-float-bound  low 'single-float)
2418                      ,(coerced-float-bound high 'single-float))
2419        (double-float ,(coerced-float-bound  low 'double-float)
2420                      ,(coerced-float-bound high 'double-float)))))
2421
2422(def-bounded-type float float nil)
2423(def-bounded-type real nil nil)
2424
2425(defmacro define-float-format (f)
2426  `(def-bounded-type ,f float ,f))
2427
2428(define-float-format short-float)
2429(define-float-format single-float)
2430(define-float-format double-float)
2431(define-float-format long-float)
2432
2433(defun numeric-types-intersect (type1 type2)
2434  (declare (type numeric-ctype type1 type2))
2435  (let* ((class1 (numeric-ctype-class type1))
2436         (class2 (numeric-ctype-class type2))
2437         (complexp1 (numeric-ctype-complexp type1))
2438         (complexp2 (numeric-ctype-complexp type2))
2439         (format1 (numeric-ctype-format type1))
2440         (format2 (numeric-ctype-format type2))
2441         (low1 (numeric-ctype-low type1))
2442         (high1 (numeric-ctype-high type1))
2443         (low2 (numeric-ctype-low type2))
2444         (high2 (numeric-ctype-high type2)))
2445    ;;
2446    ;; If one is complex and the other isn't, then they are disjoint.
2447    (cond ((not (or (eq complexp1 complexp2)
2448                    (null complexp1) (null complexp2)))
2449           nil)
2450          ;;
2451          ;; If either type is a float, then the other must either be specified
2452          ;; to be a float or unspecified.  Otherwise, they are disjoint.
2453          ((and (eq class1 'float) (not (member class2 '(float nil)))) nil)
2454          ((and (eq class2 'float) (not (member class1 '(float nil)))) nil)
2455          ;;
2456          ;; If the float formats are specified and different, the types
2457          ;; are disjoint.
2458          ((not (or (eq format1 format2) (null format1) (null format2)))
2459           nil)
2460          (t
2461           ;;
2462           ;; Check the bounds.  This is a bit odd because we must always have
2463           ;; the outer bound of the interval as the second arg.
2464           (if (numeric-bound-test high1 high2 <= <)
2465             (or (and (numeric-bound-test low1 low2 >= >)
2466                      (numeric-bound-test* low1 high2 <= <))
2467                 (and (numeric-bound-test low2 low1 >= >)
2468                      (numeric-bound-test* low2 high1 <= <)))
2469             (or (and (numeric-bound-test* low2 high1 <= <)
2470                      (numeric-bound-test low2 low1 >= >))
2471                 (and (numeric-bound-test high2 high1 <= <)
2472                      (numeric-bound-test* high2 low1 >= >))))))))
2473
2474;;; Round-Numeric-Bound  --  Internal
2475;;;
2476;;;    Take the numeric bound X and convert it into something that can be used
2477;;; as a bound in a numeric type with the specified Class and Format.  If up-p
2478;;; is true, then we round up as needed, otherwise we round down.  Up-p true
2479;;; implies that X is a lower bound, i.e. (N) > N.
2480;;;
2481;;; This is used by Numeric-Type-Intersection to mash the bound into the
2482;;; appropriate type number.  X may only be a float when Class is Float.
2483;;;
2484;;; ### Note: it is possible for the coercion to a float to overflow or
2485;;; underflow.  This happens when the bound doesn't fit in the specified
2486;;; format.  In this case, we should really return the appropriate
2487;;; {Most | Least}-{Positive | Negative}-XXX-Float float of desired format.
2488;;; But these conditions aren't currently signalled in any useful way.
2489;;;
2490;;; Also, when converting an open rational bound into a float we should
2491;;; probably convert it to a closed bound of the closest float in the specified
2492;;; format.  In general, open float bounds are fucked.
2493;;;
2494(defun round-numeric-bound (x class format up-p)
2495  (if x
2496    (let ((cx (if (consp x) (car x) x)))
2497        (ecase class
2498          ((nil rational) x)
2499          (integer
2500           (if (and (consp x) (integerp cx))
2501             (if up-p (1+ cx) (1- cx))
2502             (if up-p (ceiling cx) (floor cx))))
2503          (float
2504           (let ((res (if format (coerce cx format) (float cx))))
2505             (if (consp x) (list res) res)))))
2506    nil))
2507
2508;;; Number :Simple-Intersection type method  --  Internal
2509;;;
2510;;;    Handle the case of Type-Intersection on two numeric types.  We use
2511;;; Types-Intersect to throw out the case of types with no intersection.  If an
2512;;; attribute in Type1 is unspecified, then we use Type2's attribute, which
2513;;; must be at least as restrictive.  If the types intersect, then the only
2514;;; attributes that can be specified and different are the class and the
2515;;; bounds.
2516;;;
2517;;;    When the class differs, we use the more restrictive class.  The only
2518;;; interesting case is rational/integer, since rational includes integer.
2519;;;
2520;;;    We make the result lower (upper) bound the maximum (minimum) of the
2521;;; argument lower (upper) bounds.  We convert the bounds into the
2522;;; appropriate numeric type before maximizing.  This avoids possible confusion
2523;;; due to mixed-type comparisons (but I think the result is the same).
2524;;;
2525(define-type-method (number :simple-intersection) (type1 type2)
2526  (declare (type numeric-type type1 type2))
2527  (if (numeric-types-intersect type1 type2)
2528    (let* ((class1 (numeric-ctype-class type1))
2529           (class2 (numeric-ctype-class type2))
2530           (class (ecase class1
2531                    ((nil) class2)
2532                    ((integer float) class1)
2533                    (rational (if (eq class2 'integer) 'integer 'rational))))
2534           (format (or (numeric-ctype-format type1)
2535                       (numeric-ctype-format type2))))
2536      (make-numeric-ctype
2537       :class class
2538       :format format
2539       :complexp (or (numeric-ctype-complexp type1)
2540                     (numeric-ctype-complexp type2))
2541       :low (numeric-bound-max
2542             (round-numeric-bound (numeric-ctype-low type1)
2543                                  class format t)
2544             (round-numeric-bound (numeric-ctype-low type2)
2545                                  class format t)
2546             > >= nil)
2547       :high (numeric-bound-max
2548              (round-numeric-bound (numeric-ctype-high type1)
2549                                   class format nil)
2550              (round-numeric-bound (numeric-ctype-high type2)
2551                                   class format nil)
2552              < <= nil)))
2553    *empty-type*))
2554
2555;;; Float-Format-Max  --  Interface
2556;;;
2557;;;    Given two float formats, return the one with more precision.  If either
2558;;; one is null, return NIL.
2559;;;
2560(defun float-format-max (f1 f2)
2561  (when (and f1 f2)
2562    (dolist (f float-formats (error "Bad float format: ~S." f1))
2563      (when (or (eq f f1) (eq f f2))
2564          (return f)))))
2565
2566
2567;;; Numeric-Contagion  --  Interface
2568;;;
2569;;;    Return the result of an operation on Type1 and Type2 according to the
2570;;; rules of numeric contagion.  This is always NUMBER, some float format
2571;;; (possibly complex) or RATIONAL.  Due to rational canonicalization, there
2572;;; isn't much we can do here with integers or rational complex numbers.
2573;;;
2574;;;    If either argument is not a Numeric-Type, then return NUMBER.  This is
2575;;; useful mainly for allowing types that are technically numbers, but not a
2576;;; Numeric-Type.
2577;;;
2578(defun numeric-contagion (type1 type2)
2579  (if (and (numeric-ctype-p type1) (numeric-ctype-p type2))
2580    (let ((class1 (numeric-ctype-class type1))
2581            (class2 (numeric-ctype-class type2))
2582            (format1 (numeric-ctype-format type1))
2583            (format2 (numeric-ctype-format type2))
2584            (complexp1 (numeric-ctype-complexp type1))
2585            (complexp2 (numeric-ctype-complexp type2)))
2586        (cond ((or (null complexp1)
2587                   (null complexp2))
2588               (specifier-type 'number))
2589              ((eq class1 'float)
2590               (make-numeric-ctype
2591                  :class 'float
2592                  :format (ecase class2
2593                              (float (float-format-max format1 format2))
2594                              ((integer rational) format1)
2595                              ((nil)
2596                               ;; A double-float with any real number is a
2597                               ;; double-float.
2598                               (if (eq format1 'double-float)
2599                                 'double-float
2600                                 nil)))
2601                  :complexp (if (or (eq complexp1 :complex)
2602                                    (eq complexp2 :complex))
2603                              :complex
2604                              :real)))
2605              ((eq class2 'float) (numeric-contagion type2 type1))
2606              ((and (eq complexp1 :real) (eq complexp2 :real))
2607               (make-numeric-ctype
2608                  :class (and class1 class2 'rational)
2609                  :complexp :real))
2610              (t
2611               (specifier-type 'number))))
2612    (specifier-type 'number)))
2613
2614
2615
2616
2617;;;; Array types:
2618
2619;;; The Array-Type is used to represent all array types, including things such
2620;;; as SIMPLE-STRING.
2621;;;
2622
2623(defun make-array-ctype (&key
2624                         (dimensions '*)
2625                         (complexp '*)
2626                         element-type
2627                         (specialized-element-type *wild-type*))
2628  (%istruct 'array-ctype
2629            (type-class-or-lose 'array)
2630            nil
2631            dimensions
2632            complexp
2633            element-type
2634            specialized-element-type
2635            (unless (eq specialized-element-type *wild-type*)
2636              (ctype-subtype specialized-element-type))))
2637
2638(defun array-ctype-p (x) (istruct-typep x 'array-ctype))
2639(setf (type-predicate 'array-ctype) 'array-ctype-p)
2640
2641;;; Specialized-Element-Type-Maybe  --  Internal
2642;;;
2643;;;      What this does depends on the setting of the
2644;;; *use-implementation-types* switch.  If true, return the specialized element
2645;;; type, otherwise return the original element type.
2646;;;
2647(defun specialized-element-type-maybe (type)
2648  (declare (type array-ctype type))
2649  (if *use-implementation-types*
2650    (array-ctype-specialized-element-type type)
2651    (array-ctype-element-type type)))
2652
2653(define-type-method (array :simple-=) (type1 type2)
2654  (if (or (unknown-ctype-p (array-ctype-element-type type1))
2655          (unknown-ctype-p (array-ctype-element-type type2)))
2656    (multiple-value-bind (equalp certainp)
2657        (type= (array-ctype-element-type type1)
2658               (array-ctype-element-type type2))
2659      (assert (not (and (not equalp) certainp)))
2660      (values equalp certainp))
2661    (values (and (equal (array-ctype-dimensions type1)
2662                        (array-ctype-dimensions type2))
2663                 (eq (array-ctype-complexp type1)
2664                     (array-ctype-complexp type2))
2665                 (type= (specialized-element-type-maybe type1)
2666                        (specialized-element-type-maybe type2)))
2667            t)))
2668
2669(define-type-method (array :unparse) (type)
2670  (let ((dims (array-ctype-dimensions type))
2671          (eltype (type-specifier (array-ctype-element-type type)))
2672          (complexp (array-ctype-complexp type)))
2673    (cond ((eq dims '*)
2674             (if (eq eltype '*)
2675               (if complexp 'array 'simple-array)
2676               (if complexp `(array ,eltype) `(simple-array ,eltype))))
2677            ((= (length dims) 1) 
2678             (if complexp
2679               (if (eq (car dims) '*)
2680                   (case eltype
2681                     (bit 'bit-vector)
2682                     ((character base-char) 'base-string)
2683                     (* 'vector)
2684                     (t `(vector ,eltype)))
2685                   (case eltype
2686                     (bit `(bit-vector ,(car dims)))
2687                     ((character base-char) `(base-string ,(car dims)))
2688                     (t `(vector ,eltype ,(car dims)))))
2689               (if (eq (car dims) '*)
2690                   (case eltype
2691                     (bit 'simple-bit-vector)
2692                     ((base-char character) 'simple-base-string)
2693                     ((t) 'simple-vector)
2694                     (t `(simple-array ,eltype (*))))
2695                   (case eltype
2696                     (bit `(simple-bit-vector ,(car dims)))
2697                     ((base-char character) `(simple-base-string ,(car dims)))
2698                     ((t) `(simple-vector ,(car dims)))
2699                     (t `(simple-array ,eltype ,dims))))))
2700            (t
2701             (if complexp
2702               `(array ,eltype ,dims)
2703               `(simple-array ,eltype ,dims))))))
2704
2705(define-type-method (array :simple-subtypep) (type1 type2)
2706  (let ((dims1 (array-ctype-dimensions type1))
2707        (dims2 (array-ctype-dimensions type2))
2708        (complexp2 (array-ctype-complexp type2)))
2709    (cond (;; not subtypep unless dimensions are compatible
2710           (not (or (eq dims2 '*)
2711                    (and (not (eq dims1 '*))
2712                         (= (length (the list dims1))
2713                            (length (the list dims2)))
2714                         (every (lambda (x y)
2715                                  (or (eq y '*) (eql x y)))
2716                                (the list dims1)
2717                                (the list dims2)))))
2718           (values nil t))
2719          ;; not subtypep unless complexness is compatible
2720          ((not (or (eq complexp2 :maybe)
2721                    (eq (array-ctype-complexp type1) complexp2)))
2722           (values nil t))
2723          ;; Since we didn't fail any of the tests above, we win
2724          ;; if the TYPE2 element type is wild.
2725          ((eq (array-ctype-element-type type2) *wild-type*)
2726           (values t t))
2727          (;; Since we didn't match any of the special cases above, we
2728           ;; can't give a good answer unless both the element types
2729           ;; have been defined.
2730           (or (unknown-ctype-p (array-ctype-element-type type1))
2731               (unknown-ctype-p (array-ctype-element-type type2)))
2732           (values nil nil))
2733          (;; Otherwise, the subtype relationship holds iff the
2734           ;; types are equal, and they're equal iff the specialized
2735           ;; element types are identical.
2736           t
2737           (values (type= (specialized-element-type-maybe type1)
2738                          (specialized-element-type-maybe type2))
2739                   t)))))
2740
2741; (define-superclasses array (string string) (vector vector) (array))
2742
2743
2744(defun array-types-intersect (type1 type2)
2745  (declare (type array-ctype type1 type2))
2746  (let ((dims1 (array-ctype-dimensions type1))
2747        (dims2 (array-ctype-dimensions type2))
2748        (complexp1 (array-ctype-complexp type1))
2749        (complexp2 (array-ctype-complexp type2)))
2750    ;; See whether dimensions are compatible.
2751    (cond ((not (or (eq dims1 '*) (eq dims2 '*)
2752                    (and (= (length dims1) (length dims2))
2753                         (every (lambda (x y)
2754                                  (or (eq x '*) (eq y '*) (= x y)))
2755                                dims1 dims2))))
2756           (values nil t))
2757          ;; See whether complexpness is compatible.
2758          ((not (or (eq complexp1 :maybe)
2759                    (eq complexp2 :maybe)
2760                    (eq complexp1 complexp2)))
2761           (values nil t))
2762          ((or (eq (array-ctype-specialized-element-type type1) *wild-type*)
2763               (eq (array-ctype-specialized-element-type type2) *wild-type*)
2764               (type= (specialized-element-type-maybe type1)
2765                      (specialized-element-type-maybe type2)))
2766           (values t t))
2767          (t
2768           (values nil t)))))
2769
2770(define-type-method (array :simple-intersection) (type1 type2)
2771  (declare (type array-ctype type1 type2))
2772  (if (array-types-intersect type1 type2)
2773    (let ((dims1 (array-ctype-dimensions type1))
2774          (dims2 (array-ctype-dimensions type2))
2775          (complexp1 (array-ctype-complexp type1))
2776          (complexp2 (array-ctype-complexp type2))
2777          (eltype1 (array-ctype-element-type type1))
2778          (eltype2 (array-ctype-element-type type2)))
2779      (specialize-array-type
2780       (make-array-ctype
2781        :dimensions (cond ((eq dims1 '*) dims2)
2782                          ((eq dims2 '*) dims1)
2783                          (t
2784                           (mapcar #'(lambda (x y) (if (eq x '*) y x))
2785                                   dims1 dims2)))
2786        :complexp (if (eq complexp1 :maybe) complexp2 complexp1)
2787        :element-type (cond
2788                        ((eq eltype1 *wild-type*) eltype2)
2789                        ((eq eltype2 *wild-type*) eltype1)
2790                        (t (type-intersection eltype1 eltype2))))))
2791      *empty-type*))
2792
2793;;; Check-Array-Dimensions  --  Internal
2794;;;
2795;;;    Check a supplied dimension list to determine if it is legal.
2796;;;
2797(defun check-array-dimensions (dims)
2798  (typecase dims
2799    ((member *) dims)
2800    (integer
2801     (when (minusp dims)
2802       (signal-program-error "Arrays can't have a negative number of dimensions: ~D." dims))
2803     (when (>= dims array-rank-limit)
2804       (signal-program-error "Array type has too many dimensions: ~S." dims))
2805     (make-list dims :initial-element '*))
2806    (list
2807     (when (>= (length dims) array-rank-limit)
2808       (signal-program-error "Array type has too many dimensions: ~S." dims))
2809     (dolist (dim dims)
2810       (unless (eq dim '*)
2811           (unless (and (integerp dim)
2812                          (>= dim 0) (< dim array-dimension-limit))
2813             (signal-program-error "Bad dimension in array type: ~S." dim))))
2814     dims)
2815    (t
2816     (signal-program-error "Array dimensions is not a list, integer or *:~%  ~S"
2817                           dims))))
2818
2819(def-type-translator array (&optional element-type dimensions)
2820  (specialize-array-type
2821   (make-array-ctype :dimensions (check-array-dimensions dimensions)
2822                     :complexp :maybe
2823                     :element-type (specifier-type element-type))))
2824
2825(def-type-translator simple-array (&optional element-type dimensions)
2826  (specialize-array-type
2827   (make-array-ctype :dimensions (check-array-dimensions dimensions)
2828                         :element-type (specifier-type element-type)
2829                         :complexp nil)))
2830
2831;;; Order matters here.
2832(defparameter specialized-array-element-types
2833  '(nil bit (unsigned-byte 8) (signed-byte 8) (unsigned-byte 16)
2834    (signed-byte 16) (unsigned-byte 32) #+32-bit-target fixnum (signed-byte 32)
2835    #+64-bit-target (unsigned-byte 64)
2836    #+64-bit-target fixnum
2837    #+64-bit-target (signed-byte 64)
2838    character  short-float double-float))
2839
2840(defun specialize-array-type (type)
2841  (let* ((eltype (array-ctype-element-type type))
2842         (specialized-type (if (eq eltype *wild-type*)
2843                             *wild-type*
2844                             (dolist (stype-name specialized-array-element-types
2845                                      *universal-type*)
2846                               (let ((stype (specifier-type stype-name)))
2847                                 (when (csubtypep eltype stype)
2848                                   (return stype)))))))
2849   
2850    (setf (array-ctype-specialized-element-type type) specialized-type
2851          (array-ctype-typecode type) (unless (eq specialized-type *wild-type*)
2852                                        (ctype-subtype specialized-type)))
2853    type))
2854
2855
2856;;;; Member types.
2857
2858;;; The Member-Type represents uses of the MEMBER type specifier.  We bother
2859;;; with this at this level because MEMBER types are fairly important and union
2860;;; and intersection are well defined.
2861
2862(defun %make-member-ctype (members)
2863  (%istruct 'member-ctype
2864            (type-class-or-lose 'member)
2865            t
2866            members))
2867
2868(defun make-member-ctype (&key members)
2869  (let* ((singlep (subsetp '(-0.0f0 0.0f0) members))
2870         (doublep (subsetp '(-0.0d0 0.0d0) members))
2871         (union-types
2872          (if singlep
2873            (if doublep
2874              (list *ctype-of-single-float-0* *ctype-of-double-float-0*)
2875              (list *ctype-of-single-float-0*))
2876            (if doublep
2877              (list *ctype-of-double-float-0*)))))
2878    (if union-types
2879      (progn
2880        (if singlep
2881          (setq members (set-difference '(-0.0f0 0.0f0) members)))
2882        (if doublep
2883          (setq members (set-difference '(-0.d00 0.0d0) members)))
2884        (make-union-ctype (if (null members)
2885                            union-types
2886                            (cons (%make-member-ctype members) union-types))))
2887      (%make-member-ctype members))))
2888       
2889
2890(defun member-ctype-p (x) (istruct-typep x 'member-ctype))
2891(setf (type-predicate 'member-ctype) 'member-ctype-p)
2892
2893(define-type-method (member :unparse) (type)
2894  (if (type= type (specifier-type 'standard-char))
2895    'standard-char
2896    (let ((members (member-ctype-members type)))
2897      (if (equal members '(nil))
2898        'null
2899        `(member ,@members)))))
2900
2901(define-type-method (member :simple-subtypep) (type1 type2)
2902  (values (subsetp (member-ctype-members type1) (member-ctype-members type2))
2903            t))
2904
2905
2906(define-type-method (member :complex-subtypep-arg1) (type1 type2)
2907  (every/type (swapped-args-fun #'ctypep)
2908              type2
2909              (member-ctype-members type1)))
2910
2911;;; We punt if the odd type is enumerable and intersects with the member type.
2912;;; If not enumerable, then it is definitely not a subtype of the member type.
2913;;;
2914(define-type-method (member :complex-subtypep-arg2) (type1 type2)
2915  (cond ((not (ctype-enumerable type1)) (values nil t))
2916          ((types-intersect type1 type2)
2917           (invoke-complex-subtypep-arg1-method type1 type2))
2918          (t
2919           (values nil t))))
2920
2921(define-type-method (member :simple-intersection) (type1 type2)
2922  (let ((mem1 (member-ctype-members type1))
2923        (mem2 (member-ctype-members type2)))
2924    (values (cond ((subsetp mem1 mem2) type1)
2925                  ((subsetp mem2 mem1) type2)
2926                  (t
2927                   (let ((res (intersection mem1 mem2)))
2928                     (if res
2929                       (make-member-ctype :members res)
2930                       *empty-type*))))
2931            t)))
2932
2933(define-type-method (member :complex-intersection) (type1 type2)
2934  (block PUNT
2935    (collect ((members))
2936      (let ((mem2 (member-ctype-members type2)))
2937        (dolist (member mem2)
2938          (multiple-value-bind (val win) (ctypep member type1)
2939            (unless win
2940              (return-from punt nil))
2941            (when val (members member))))
2942        (cond ((subsetp mem2 (members)) type2)
2943              ((null (members)) *empty-type*)
2944              (t
2945               (make-member-ctype :members (members))))))))
2946
2947;;; We don't need a :COMPLEX-UNION, since the only interesting case is a union
2948;;; type, and the member/union interaction is handled by the union type
2949;;; method.
2950(define-type-method (member :simple-union) (type1 type2)
2951  (let ((mem1 (member-ctype-members type1))
2952        (mem2 (member-ctype-members type2)))
2953    (cond ((subsetp mem1 mem2) type2)
2954          ((subsetp mem2 mem1) type1)
2955          (t
2956           (make-member-ctype :members (union mem1 mem2))))))
2957
2958
2959(define-type-method (member :simple-=) (type1 type2)
2960  (let ((mem1 (member-ctype-members type1))
2961        (mem2 (member-ctype-members type2)))
2962    (values (and (subsetp mem1 mem2) (subsetp mem2 mem1))
2963            t)))
2964
2965(define-type-method (member :complex-=) (type1 type2)
2966  (if (ctype-enumerable type1)
2967    (multiple-value-bind (val win)
2968                               (csubtypep type2 type1)
2969        (if (or val (not win))
2970        (values nil nil)
2971        (values nil t)))
2972    (values nil t)))
2973
2974(def-type-translator member (&rest members)
2975  (if members
2976    (collect ((non-numbers) (numbers))
2977      (dolist (m (remove-duplicates members))
2978        (if (and (numberp m)
2979                 (not (and (floatp m) (zerop m))))
2980          (numbers (ctype-of m))
2981          (non-numbers m)))
2982      (apply #'type-union
2983             (if (non-numbers)
2984               (make-member-ctype :members (non-numbers))
2985               *empty-type*)
2986             (numbers)))
2987    *empty-type*))
2988
2989
2990
2991;;;; Union types:
2992
2993;;; The Union-Type represents uses of the OR type specifier which can't be
2994;;; canonicalized to something simpler.  Canonical form:
2995;;;
2996;;; 1] There is never more than one Member-Type component.
2997;;; 2] There are never any Union-Type components.
2998;;;
2999
3000(defun make-union-ctype (types)
3001  (declare (list types))
3002  (%istruct 'union-ctype
3003            (type-class-or-lose 'union)
3004            (every #'(lambda (x) (ctype-enumerable x)) types)
3005            types))
3006
3007(defun union-ctype-p (x) (istruct-typep x 'union-ctype))
3008(setf (type-predicate 'union-ctype) 'union-ctype-p)
3009
3010
3011;;;    If List, then return that, otherwise the OR of the component types.
3012;;;
3013(define-type-method (union :unparse) (type)
3014  (declare (type ctype type))
3015    (cond
3016      ((type= type (specifier-type 'list)) 'list)
3017      ((type= type (specifier-type 'float)) 'float)
3018      ((type= type (specifier-type 'real)) 'real)
3019      ((type= type (specifier-type 'sequence)) 'sequence)
3020      ((type= type (specifier-type 'bignum)) 'bignum)
3021      (t `(or ,@(mapcar #'type-specifier (union-ctype-types type))))))
3022
3023
3024
3025(define-type-method (union :simple-=) (type1 type2)
3026  (multiple-value-bind (subtype certain?)
3027      (csubtypep type1 type2)
3028    (if subtype
3029      (csubtypep type2 type1)
3030      (if certain?
3031        (values nil t)
3032        (multiple-value-bind (subtype certain?)
3033            (csubtypep type2 type1)
3034          (declare (ignore subtype))
3035          (values nil certain?))))))
3036
3037
3038(define-type-method (union :complex-=) (type1 type2)
3039  (declare (ignore type1))
3040  (if (some #'type-might-contain-other-types-p 
3041            (union-ctype-types type2))
3042    (values nil nil)
3043    (values nil t)))
3044
3045
3046(defun union-simple-subtypep (type1 type2)
3047  (every/type (swapped-args-fun #'union-complex-subtypep-arg2)
3048              type2
3049              (union-ctype-types type1)))
3050
3051(define-type-method (union :simple-subtypep) (type1 type2)
3052  (union-simple-subtypep type1 type2))
3053
3054(defun union-complex-subtypep-arg1 (type1 type2)
3055  (every/type (swapped-args-fun #'csubtypep)
3056              type2
3057              (union-ctype-types type1)))
3058
3059(define-type-method (union :complex-subtypep-arg1) (type1 type2)
3060  (union-complex-subtypep-arg1 type1 type2))
3061
3062(defun union-complex-subtypep-arg2 (type1 type2)
3063  (multiple-value-bind (sub-value sub-certain?)
3064      (progn
3065        (assert (union-ctype-p type2))
3066        (assert (not (union-ctype-p type1)))
3067        (type= type1
3068               (apply #'type-union
3069                      (mapcar (lambda (x) (type-intersection type1 x))
3070                              (union-ctype-types type2)))))
3071    (if sub-certain?
3072      (values sub-value sub-certain?)
3073      (invoke-complex-subtypep-arg1-method type1 type2))))
3074
3075(define-type-method (union :complex-subtypep-arg2) (type1 type2)
3076  (union-complex-subtypep-arg2 type1 type2))
3077
3078(define-type-method (union :simple-intersection :complex-intersection)
3079    (type1 type2)
3080  (assert (union-ctype-p type2))
3081  (cond ((and (union-ctype-p type1)
3082              (union-simple-subtypep type1 type2)) type1)
3083        ((and (union-ctype-p type1)
3084              (union-simple-subtypep type2 type1)) type2)
3085        ((and (not (union-ctype-p type1))
3086              (union-complex-subtypep-arg2 type1 type2))
3087         type1)
3088        ((and (not (union-ctype-p type1))
3089              (union-complex-subtypep-arg1 type2 type1))
3090         type2)
3091        (t 
3092         (let ((accumulator *empty-type*))
3093           (dolist (t2 (union-ctype-types type2) accumulator)
3094             (setf accumulator
3095                   (type-union accumulator
3096                               (type-intersection type1 t2))))))))
3097
3098
3099
3100(def-type-translator or (&rest type-specifiers)
3101  (apply #'type-union
3102         (mapcar #'specifier-type type-specifiers)))
3103
3104
3105;;; Intersection types
3106(defun make-intersection-ctype (enumerable types)
3107  (%istruct 'intersection-ctype
3108            (type-class-or-lose 'intersection)
3109            enumerable
3110            types))
3111
3112(defun intersection-ctype-p (x)
3113  (istruct-typep x 'intersection-ctype))
3114(setf (type-predicate 'intersection-ctype) 'intersection-ctype-p)
3115
3116(define-type-method (intersection :unparse) (type)
3117  (declare (type ctype type))
3118  (or (find type '(ratio keyword) :key #'specifier-type :test #'type=)
3119      `(and ,@(mapcar #'type-specifier (intersection-ctype-types type)))))
3120
3121;;; shared machinery for type equality: true if every type in the set
3122;;; TYPES1 matches a type in the set TYPES2 and vice versa
3123(defun type=-set (types1 types2)
3124  (flet (;; true if every type in the set X matches a type in the set Y
3125         (type<=-set (x y)
3126           (declare (type list x y))
3127           (every (lambda (xelement)
3128                    (position xelement y :test #'type=))
3129                  x)))
3130    (values (and (type<=-set types1 types2)
3131                 (type<=-set types2 types1))
3132            t)))
3133
3134(define-type-method (intersection :simple-=) (type1 type2)
3135  (type=-set (intersection-ctype-types type1)
3136             (intersection-ctype-types type2)))
3137
3138(defun %intersection-complex-subtypep-arg1 (type1 type2)
3139  (type= type1 (type-intersection type1 type2)))
3140
3141(defun %intersection-simple-subtypep (type1 type2)
3142  (every/type #'%intersection-complex-subtypep-arg1
3143              type1
3144              (intersection-ctype-types type2)))
3145
3146(define-type-method (intersection :simple-subtypep) (type1 type2)
3147  (%intersection-simple-subtypep type1 type2))
3148 
3149(define-type-method (intersection :complex-subtypep-arg1) (type1 type2)
3150  (%intersection-complex-subtypep-arg1 type1 type2))
3151
3152(defun %intersection-complex-subtypep-arg2 (type1 type2)
3153  (every/type #'csubtypep type1 (intersection-ctype-types type2)))
3154
3155(define-type-method (intersection :complex-subtypep-arg2) (type1 type2)
3156  (%intersection-complex-subtypep-arg2 type1 type2))
3157
3158(define-type-method (intersection :simple-union :complex-union)
3159    (type1 type2)
3160  (assert (intersection-ctype-p type2))
3161  (cond ((and (intersection-ctype-p type1)
3162              (%intersection-simple-subtypep type1 type2)) type2)
3163        ((and (intersection-ctype-p type1)
3164              (%intersection-simple-subtypep type2 type1)) type1)
3165        ((and (not (intersection-ctype-p type1))
3166              (%intersection-complex-subtypep-arg2 type1 type2))
3167         type2)
3168        ((and (not (intersection-ctype-p type1))
3169              (%intersection-complex-subtypep-arg1 type2 type1))
3170         type1)
3171        ((and (csubtypep type2 (specifier-type 'ratio))
3172              (numeric-ctype-p type1)
3173              (csubtypep type1 (specifier-type 'integer))
3174              (csubtypep type2
3175                         (make-numeric-ctype
3176                          :class 'rational
3177                          :complexp nil
3178                          :low (if (null (numeric-ctype-low type1))
3179                                 nil
3180                                 (list (1- (numeric-ctype-low type1))))
3181                          :high (if (null (numeric-ctype-high type1))
3182                                  nil
3183                                  (list (1+ (numeric-ctype-high type1)))))))
3184         (type-union type1
3185                     (apply #'type-intersection
3186                            (remove (specifier-type '(not integer))
3187                                    (intersection-ctype-types type2)
3188                                    :test #'type=))))
3189        (t
3190         (let ((accumulator *universal-type*))
3191           (do ((t2s (intersection-ctype-types type2) (cdr t2s)))
3192               ((null t2s) accumulator)
3193             (let ((union (type-union type1 (car t2s))))
3194               (when (union-ctype-p union)
3195                 (if (and (eq accumulator *universal-type*)
3196                          (null (cdr t2s)))
3197                     (return union)
3198                     (return nil)))
3199               (setf accumulator
3200                     (type-intersection accumulator union))))))))
3201
3202(def-type-translator and (&rest type-specifiers)
3203  (apply #'type-intersection
3204         (mapcar #'specifier-type
3205                 type-specifiers)))
3206
3207;;; cons-ctype
3208(defun wild-ctype-to-universal-ctype (c)
3209  (if (type= c *wild-type*)
3210    *universal-type*
3211    c))
3212
3213(defun make-cons-ctype (car-ctype-value cdr-ctype-value)
3214  (if (or (eq car-ctype-value *empty-type*)
3215          (eq cdr-ctype-value *empty-type*))
3216    *empty-type*
3217    (%istruct 'cons-ctype
3218              (type-class-or-lose 'cons)
3219              nil
3220              (wild-ctype-to-universal-ctype car-ctype-value)
3221              (wild-ctype-to-universal-ctype cdr-ctype-value))))
3222
3223(defun cons-ctype-p (x)
3224  (istruct-typep x 'cons-ctype))
3225
3226(setf (type-predicate 'cons-ctype) 'cons-ctype-p)
3227 
3228(def-type-translator cons (&optional (car-type-spec '*) (cdr-type-spec '*))
3229  (make-cons-ctype (specifier-type car-type-spec)
3230                   (specifier-type cdr-type-spec)))
3231
3232(define-type-method (cons :unparse) (type)
3233  (let* ((car-spec (type-specifier (cons-ctype-car-ctype type)))
3234         (cdr-spec (type-specifier (cons-ctype-cdr-ctype type))))
3235    (if (and (member car-spec '(t *))
3236             (member cdr-spec '(t *)))
3237      'cons
3238      `(cons ,car-spec ,cdr-spec))))
3239
3240(define-type-method (cons :simple-=) (type1 type2)
3241  (declare (cons-ctype type1 type2))
3242  (and (type= (cons-ctype-car-ctype type1) (cons-ctype-car-ctype type2))
3243       (type= (cons-ctype-cdr-ctype type1) (cons-ctype-cdr-ctype type2))))
3244
3245(define-type-method (cons :simple-subtypep) (type1 type2)
3246  (declare (cons-ctype type1 type2))
3247  (multiple-value-bind (val-car win-car)
3248      (csubtypep (cons-ctype-car-ctype type1) (cons-ctype-car-ctype type2))
3249    (multiple-value-bind (val-cdr win-cdr)
3250        (csubtypep (cons-ctype-cdr-ctype type1) (cons-ctype-cdr-ctype type2))
3251      (if (and val-car val-cdr)
3252        (values t (and win-car win-cdr))
3253        (values nil (or win-car win-cdr))))))
3254
3255(define-type-method (cons :simple-union) (type1 type2)
3256  (declare (type cons-ctype type1 type2))
3257  (let ((car-type1 (cons-ctype-car-ctype type1))
3258        (car-type2 (cons-ctype-car-ctype type2))
3259        (cdr-type1 (cons-ctype-cdr-ctype type1))
3260        (cdr-type2 (cons-ctype-cdr-ctype type2))
3261        (car-not1)
3262        (car-not2))
3263    (macrolet ((frob-car (car1 car2 cdr1 cdr2
3264                          &optional (not1 nil not1p))
3265                 `(type-union
3266                   (make-cons-ctype ,car1 (type-union ,cdr1 ,cdr2))
3267                   (make-cons-ctype
3268                    (type-intersection
3269                     ,car2
3270                     ,(if not1p
3271                          not1
3272                          `(specifier-type
3273                            `(not ,(type-specifier ,car1))))) 
3274                    ,cdr2))))
3275      (cond ((type= car-type1 car-type2)
3276             (make-cons-ctype car-type1
3277                              (type-union cdr-type1 cdr-type2)))
3278            ((type= cdr-type1 cdr-type2)
3279             (make-cons-ctype (type-union car-type1 car-type2)
3280                              cdr-type1))
3281            ((csubtypep car-type1 car-type2)
3282             (frob-car car-type1 car-type2 cdr-type1 cdr-type2))
3283            ((csubtypep car-type2 car-type1)
3284             (frob-car car-type2 car-type1 cdr-type2 cdr-type1))
3285            ;; more general case of the above, but harder to compute
3286            ((progn
3287               (setf car-not1 (specifier-type
3288                               `(not ,(type-specifier car-type1))))
3289               (not (csubtypep car-type2 car-not1)))
3290             (frob-car car-type1 car-type2 cdr-type1 cdr-type2 car-not1))
3291            ((progn
3292               (setf car-not2 (specifier-type
3293                               `(not ,(type-specifier car-type2))))
3294               (not (csubtypep car-type1 car-not2)))
3295             (frob-car car-type2 car-type1 cdr-type2 cdr-type1 car-not2))))))
3296           
3297(define-type-method (cons :simple-intersection) (type1 type2)
3298  (declare (type cons-type type1 type2))
3299  (let ((car-int2 (type-intersection2 (cons-ctype-car-ctype type1)
3300                                      (cons-ctype-car-ctype type2)))
3301        (cdr-int2 (type-intersection2 (cons-ctype-cdr-ctype type1)
3302                                      (cons-ctype-cdr-ctype type2))))
3303    (cond ((and car-int2 cdr-int2)
3304           (make-cons-ctype car-int2 cdr-int2))
3305          (car-int2
3306           (make-cons-ctype car-int2
3307                            (type-intersection (cons-ctype-cdr-ctype type1)
3308                                               (cons-ctype-cdr-ctype type2))))
3309          (cdr-int2
3310           (make-cons-ctype (type-intersection (cons-ctype-car-ctype type1)
3311                                               (cons-ctype-car-ctype type2))
3312                            cdr-int2)))))
3313
3314
3315;;; An UNKNOWN-TYPE is a type not known to the type system (not yet defined).
3316;;; We make this distinction since we don't want to complain about types that
3317;;; are hairy but defined.
3318;;;
3319
3320(defun make-unknown-ctype (&key specifier (enumerable t))
3321  (%istruct 'unknown-ctype
3322            (type-class-or-lose 'hairy)
3323            enumerable
3324            specifier))
3325
3326(defun unknown-ctype-p (x)
3327  (istruct-typep x 'unknown-ctype))
3328
3329(setf (type-predicate 'unknown-ctype) 'unknown-ctype-p)
3330
3331
3332
3333
3334
3335;;;; foreign-type types
3336
3337
3338(defun %make-foreign-ctype (foreign-type)
3339  (%istruct 'foreign-ctype
3340            (type-class-or-lose 'foreign)
3341            nil
3342            foreign-type))
3343
3344(defun foreign-ctype-p (x) (istruct-typep x 'foreign-ctype))
3345(setf (type-predicate 'foreign-ctype) 'foreign-ctype-p)
3346
3347(define-type-method (foreign :unparse) (type)
3348  `(foreign ,(unparse-foreign-type (foreign-ctype-foreign-type type))))
3349
3350(define-type-method (foreign :simple-subtypep) (type1 type2)
3351  (values (foreign-subtype-p (foreign-ctype-foreign-type type1)
3352                                   (foreign-ctype-foreign-type type2))
3353            t))
3354
3355;(define-superclasses foreign (foreign-value))
3356
3357(define-type-method (foreign :simple-=) (type1 type2)
3358  (let ((foreign-type-1 (foreign-ctype-foreign-type type1))
3359          (foreign-type-2 (foreign-ctype-foreign-type type2)))
3360    (values (or (eq foreign-type-1 foreign-type-2)
3361                    (foreign-type-= foreign-type-1 foreign-type-2))
3362              t)))
3363
3364(def-type-translator foreign (&optional (foreign-type nil))
3365  (typecase foreign-type
3366    (null
3367     (make-foreign-ctype))
3368    (foreign-type
3369     (make-foreign-ctype foreign-type))
3370    (t
3371     (make-foreign-ctype (parse-foreign-type foreign-type)))))
3372
3373(defun make-foreign-ctype (&optional foreign-type)
3374  (if foreign-type
3375      (let ((lisp-rep-type (compute-lisp-rep-type foreign-type)))
3376        (if lisp-rep-type
3377            (specifier-type lisp-rep-type)
3378            (%make-foreign-ctype foreign-type)))
3379      *universal-type*))
3380
3381
3382;;; CLASS-CTYPES are supposed to help integrate CLOS and the CMU type system.
3383;;; They mostly just contain a backpointer to the CLOS class; the CPL is then
3384;;;  used to resolve type relationships.
3385
3386(defun class-ctype-p (x) (istruct-typep x 'class-ctype))
3387(setf (type-predicate 'class-ctype) 'class-ctype-p)
3388
3389(defun args-ctype-p (x) (and (eql (typecode x) target::subtag-istruct)
3390                             (member (%svref x 0)
3391                                     '(args-ctype values-ctype function-ctype))))
3392
3393(defun function-ctype-p (x) (istruct-typep x 'function-ctype))
3394(defun valuec-ctype-p (x) (istruct-typep x 'values-ctype))
3395
3396(setf (type-predicate 'args-ctype) 'args-ctype-p
3397      (type-predicate 'function-ctype) 'function-ctype-p
3398      (type-predicate 'values-ctype) 'values-ctype-p)
3399
3400
3401;;; Simple methods for TYPE= and SUBTYPEP should never be called when the two
3402;;; classes are equal, since there are EQ checks in those operations.
3403;;;
3404(define-type-method (class :simple-=) (type1 type2)
3405  (assert (not (eq type1 type2)))
3406  (values nil t))
3407
3408(define-type-method (class :simple-subtypep) (type1 type2)
3409  (assert (not (eq type1 type2)))
3410  (let* ((class1 (if (class-ctype-p type1) (class-ctype-class type1)))
3411         (class2 (if (class-ctype-p type2) (class-ctype-class type2))))
3412    (if (and class1 class2)
3413      (if (memq class2 (class-direct-superclasses class1))
3414        (values t t)
3415        (if (class-has-a-forward-referenced-superclass-p class1)
3416          (values nil nil)
3417          (let ((supers (%inited-class-cpl class1)))
3418            (if (memq class2 supers)
3419              (values t t)
3420              (values nil t)))))
3421      (values nil t))))
3422
3423(defun find-class-intersection (c1 c2)
3424  (labels ((walk-subclasses (class f)
3425             (dolist (sub (class-direct-subclasses class))
3426               (walk-subclasses sub f))
3427             (funcall f class)))
3428    (let* ((intersection nil))
3429      (walk-subclasses c1 #'(lambda (c)
3430                              (when (subclassp c c2)
3431                                (pushnew (%class.ctype c) intersection))))
3432      (when intersection
3433        (%type-union intersection)))))
3434
3435(define-type-method (class :simple-intersection) (type1 type2)
3436  (assert (not (eq type1 type2)))
3437  (let* ((class1 (if (class-ctype-p type1) (class-ctype-class type1)))
3438         (class2 (if (class-ctype-p type2) (class-ctype-class type2))))
3439    (if (and class1 class2)
3440      (cond ((subclassp class1 class2)
3441             type1)
3442            ((subclassp class2 class1)
3443             type2)
3444            ;;; In the STANDARD-CLASS case where neither's
3445            ;;; a subclass of the other, there may be
3446            ;;; one or mor classes that're a subclass of both.  We
3447            ;;; -could- try to find all such classes, but
3448            ;;; punt instead.
3449            (t (or (find-class-intersection class1 class2)
3450                 *empty-type*)))
3451      nil)))
3452
3453(define-type-method (class :complex-subtypep-arg2) (type1 class2)
3454  (if (and (intersection-ctype-p type1)
3455           (> (count-if #'class-ctype-p (intersection-ctype-types type1)) 1))
3456      (values nil nil)
3457      (invoke-complex-subtypep-arg1-method type1 class2 nil t)))
3458
3459(define-type-method (class :complex-subtypep-arg1) (type1 type2)
3460  (if (and (function-ctype-p type2)
3461           (eq type1 (specifier-type 'function))
3462           (function-ctype-wild-args type2)
3463           (eq *wild-type* (function-ctype-returns type2)))
3464      (values t t)
3465      (values nil t)))
3466
3467(define-type-method (class :unparse) (type)
3468  (class-name (class-ctype-class type)))
3469
3470
3471;;; TYPE-DIFFERENCE  --  Interface
3472;;;
3473;;;    Return the type that describes all objects that are in X but not in Y.
3474;;; If we can't determine this type, then return NIL.
3475;;;
3476;;;    For now, we only are clever dealing with union and member types.  If
3477;;; either type is not a union type, then we pretend that it is a union of just
3478;;; one type.  What we do is remove from X all the types that are a subtype any
3479;;; type in Y.  If any type in X intersects with a type in Y but is not a
3480;;; subtype, then we give up.
3481;;;
3482;;;    We must also special-case any member type that appears in the union.  We
3483;;; remove from X's members all objects that are TYPEP to Y.  If Y has any
3484;;; members, we must be careful that none of those members are CTYPEP to any
3485;;; of Y's non-member types.  We give up in this case, since to compute that
3486;;; difference we would have to break the type from X into some collection of
3487;;; types that represents the type without that particular element.  This seems
3488;;; too hairy to be worthwhile, given its low utility.
3489;;;
3490(defun type-difference (x y)
3491  (let ((x-types (if (union-ctype-p x) (union-ctype-types x) (list x)))
3492        (y-types (if (union-ctype-p y) (union-ctype-types y) (list y))))
3493    (collect ((res))
3494      (dolist (x-type x-types)
3495        (if (member-ctype-p x-type)
3496            (collect ((members))
3497              (dolist (mem (member-ctype-members x-type))
3498                (multiple-value-bind (val win) (ctypep mem y)
3499                  (unless win (return-from type-difference nil))
3500                  (unless val
3501                    (members mem))))
3502              (when (members)
3503                (res (make-member-ctype :members (members)))))
3504            (dolist (y-type y-types (res x-type))
3505              (multiple-value-bind (val win) (csubtypep x-type y-type)
3506                (unless win (return-from type-difference nil))
3507                (when val (return))
3508                (when (types-intersect x-type y-type)
3509                  (return-from type-difference nil))))))
3510      (let ((y-mem (find-if #'member-ctype-p y-types)))
3511        (when y-mem
3512          (let ((members (member-ctype-members y-mem)))
3513            (dolist (x-type x-types)
3514              (unless (member-ctype-p x-type)
3515                (dolist (member members)
3516                  (multiple-value-bind (val win) (ctypep member x-type)
3517                    (when (or (not win) val)
3518                      (return-from type-difference nil)))))))))
3519      (apply #'type-union (res)))))
3520
3521;;; CTypep  --  Interface
3522;;;
3523;;;    If Type is a type that we can do a compile-time test on, then return the
3524;;; whether the object is of that type as the first value and second value
3525;;; true.  Otherwise return NIL, NIL.
3526;;;
3527;;; We give up on unknown types, pick off FUNCTION and UNION types.  For
3528;;; structure types, we require that the type be defined in both the current
3529;;; and compiler environments, and that the INCLUDES be the same.
3530;;;
3531(defun ctypep (obj type)
3532  (declare (type ctype type))
3533  (etypecase type
3534    ((or numeric-ctype named-ctype member-ctype array-ctype cons-ctype)
3535     (values (%typep obj type) t))
3536    (class-ctype
3537     (values (not (null (class-typep  obj (class-ctype-class type)))) t)
3538)
3539    (union-ctype
3540     (any/type #'ctypep obj (union-ctype-types type)))
3541    (intersection-ctype
3542     (every/type #'ctypep obj (intersection-ctype-types type)))
3543    (function-ctype
3544     (values (functionp obj) t))
3545    (unknown-ctype
3546     (values nil nil))
3547    (foreign-ctype
3548     (values (foreign-typep obj (foreign-ctype-foreign-type type)) t))
3549    (negation-ctype
3550     (multiple-value-bind (res win)
3551         (ctypep obj (negation-ctype-type type))
3552       (if win
3553           (values (not res) t)
3554           (values nil nil))))
3555    (hairy-ctype
3556     ;; Now the tricky stuff.
3557     (let* ((hairy-spec (hairy-ctype-specifier type))
3558            (symbol (if (consp hairy-spec) (car hairy-spec) hairy-spec)))
3559       (ecase symbol
3560         (and                           ; how would this get there ?
3561          (if (atom hairy-spec)
3562            (values t t)
3563            (dolist (spec (cdr hairy-spec) (values t t))
3564              (multiple-value-bind (res win)
3565                  (ctypep obj (specifier-type spec))
3566                (unless win (return (values nil nil)))
3567                (unless res (return (values nil t)))))))
3568           (not                         ; how would this get there ?
3569            (multiple-value-bind
3570              (res win)
3571                (ctypep obj (specifier-type (cadr hairy-spec)))
3572              (if win
3573                (values (not res) t)
3574                (values nil nil))))
3575           (satisfies
3576            (let ((fun (second hairy-spec)))
3577              (cond ((and (symbolp fun) (fboundp fun))
3578                     (values (not (null (ignore-errors (funcall fun obj)))) t))
3579                    (t
3580                     (values nil nil))))))))))
3581
3582;;; %TYPEP -- internal.
3583;;;
3584;;; The actual typep engine.  The compiler only generates calls to this
3585;;; function when it can't figure out anything more intelligent to do.
3586;;;
3587; lose 1 function call -MAYBE
3588(defun %typep (object specifier)
3589  (%%typep object
3590           (if (typep specifier 'ctype)
3591             specifier
3592             (specifier-type specifier))))
3593
3594(eval-when (:compile-toplevel)
3595  (declaim (inline numeric-%%typep
3596                   array-%%typep
3597                   member-%%typep
3598                   cons-%%typep)))
3599
3600(defun numeric-%%typep (object type)
3601  (let ((pred (numeric-ctype-predicate type)))
3602    (if pred
3603      (funcall pred object)
3604      (and (numberp object)
3605           (let ((num (if (complexp object) (realpart object) object)))
3606             (ecase (numeric-ctype-class type)
3607               (integer (integerp num))
3608               (rational (rationalp num))
3609               (float
3610                (ecase (numeric-ctype-format type)
3611                  (single-float (typep num 'single-float))
3612                  (double-float (typep num 'double-float))
3613                  ((nil) (floatp num))))
3614               ((nil) t)))
3615           (flet ((bound-test (val)
3616                    (let ((low (numeric-ctype-low type))
3617                          (high (numeric-ctype-high type)))
3618                      (and (cond ((null low) t)
3619                                 ((listp low) (> val (car low)))
3620                                 (t (>= val low)))
3621                           (cond ((null high) t)
3622                                 ((listp high) (< val (car high)))
3623                                 (t (<= val high)))))))
3624             (ecase (numeric-ctype-complexp type)
3625               ((nil) t)
3626               (:complex
3627                (and (complexp object)
3628                     (bound-test (realpart object))
3629                     (bound-test (imagpart object))))
3630               (:real
3631                (and (not (complexp object))
3632                     (bound-test object)))))))))
3633
3634(defun array-%%typep (object type)
3635  (let* ((typecode (typecode object)))
3636    (declare (type (unsigned-byte 8) typecode))
3637    (and (>= typecode target::subtag-arrayH)
3638         (ecase (array-ctype-complexp type)
3639           ((t) (not (simple-array-p object)))
3640           ((nil) (simple-array-p object))
3641           ((* :maybe) t))
3642         (let* ((ctype-dimensions (array-ctype-dimensions type)))
3643           (or (eq ctype-dimensions '*)
3644               (if (eql typecode target::subtag-arrayH)
3645                   (let* ((rank (%svref object target::arrayH.rank-cell)))
3646                     (declare (fixnum rank))
3647                     (and (eql rank (length ctype-dimensions))
3648                          (do* ((i 0 (1+ i))
3649                                (dim target::arrayH.dim0-cell (1+ dim))
3650                                (want (array-ctype-dimensions type) (cdr want))
3651                                (got (%svref object dim) (%svref object dim)))
3652                               ((eql i rank) t)
3653                            (unless (or (eq (car want) '*)
3654                                        (eql (%car want) (the fixnum got)))
3655                              (return nil)))))
3656                   (and (null (cdr ctype-dimensions))
3657                        (or (eq (%car ctype-dimensions) '*)
3658                            (eql (%car ctype-dimensions)
3659                                 (if (eql typecode target::subtag-vectorH)
3660                                   (%svref object target::vectorH.physsize-cell)
3661                                   (uvsize object))))))))
3662         (or (eq (array-ctype-element-type type) *wild-type*)
3663             (eql (array-ctype-typecode type)
3664                  (if (> typecode target::subtag-vectorH)
3665                      typecode
3666                      (ldb target::arrayH.flags-cell-subtag-byte (the fixnum (%svref object target::arrayH.flags-cell)))))
3667             (type= (array-ctype-specialized-element-type type)
3668                    (specifier-type (array-element-type object)))))))
3669
3670
3671(defun member-%%typep (object type)
3672  (not (null (member object (member-ctype-members type)))))
3673
3674(defun cons-%%typep (object type) 
3675  (and (consp object)
3676       (%%typep (car object) (cons-ctype-car-ctype type))
3677       (%%typep (cdr object) (cons-ctype-cdr-ctype type)))) 
3678
3679
3680(defun %%typep (object type)
3681  ;(if (not (typep type 'ctype))(setq type (specifier-type type)))
3682  (locally (declare (type ctype type))
3683    (etypecase type
3684      (named-ctype
3685       (ecase (named-ctype-name type)
3686         ((* t) t)
3687         ((nil) nil)))
3688      (numeric-ctype
3689       (numeric-%%typep object type))
3690      (array-ctype
3691       (array-%%typep object type))
3692      (member-ctype
3693       (member-%%typep object type))
3694      (class-ctype
3695       (not (null (class-typep object (class-ctype-class type)))))
3696      (union-ctype
3697       (dolist (type (union-ctype-types type))
3698         (when (%%typep object type)
3699           (return t))))
3700      (intersection-ctype
3701       (dolist (type (intersection-ctype-types type) t)
3702         (unless (%%typep object type) (return nil))))
3703      (cons-ctype
3704       (cons-%%typep object type))
3705      (unknown-ctype
3706       ;; Parse it again to make sure it's really undefined.
3707       (let ((reparse (specifier-type (unknown-ctype-specifier type))))
3708         (if (typep reparse 'unknown-ctype)
3709           (error "Unknown type specifier: ~S"
3710                  (unknown-ctype-specifier reparse))
3711           (%%typep object reparse))))
3712      (negation-ctype
3713       (not (%%typep object (negation-ctype-type type))))
3714      (hairy-ctype
3715       ;; Now the tricky stuff.
3716       (let* ((hairy-spec (hairy-ctype-specifier type))
3717              (symbol (if (consp hairy-spec) (car hairy-spec) hairy-spec)))
3718         (ecase symbol
3719           (and
3720            (or (atom hairy-spec)
3721                (dolist (spec (cdr hairy-spec) t)
3722                  (unless (%%typep object (specifier-type spec))
3723                    (return nil)))))
3724           (not
3725            (unless (and (listp hairy-spec) (= (length hairy-spec) 2))
3726              (error "Invalid type specifier: ~S" hairy-spec))
3727            (not (%%typep object (specifier-type (cadr hairy-spec)))))
3728           (satisfies
3729            (unless (and (listp hairy-spec) (= (length hairy-spec) 2))
3730              (error "Invalid type specifier: ~S" hairy-spec))
3731            (let ((fn (cadr hairy-spec)))
3732              (if (funcall (typecase fn
3733                             (function fn)
3734                             (symbol (symbol-function fn))
3735                             (t
3736                              (coerce fn 'function)))
3737                           object)
3738                t
3739                nil))))))
3740      #|
3741    (foreign-ctype
3742     (foreign-typep object (foreign-ctype-foreign-type type)))
3743|#
3744      (function-ctype
3745       (error "Function types are not a legal argument to TYPEP:~%  ~S"
3746              (type-specifier type))))))
3747
3748
3749;;; Ctype-Of  --  Interface
3750;;;
3751;;;    Like Type-Of, only returns a Type structure instead of a type
3752;;; specifier.  We try to return the type most useful for type checking, rather
3753;;; than trying to come up with the one that the user might find most
3754;;; informative.
3755;;;
3756
3757(defun float-format-name (x)
3758  (declare (float x))
3759  (etypecase x
3760    (single-float "SINGLE-FLOAT")
3761    (double-float "DOUBLE-FLOAT")))
3762
3763(defun ctype-of-number (x)
3764  (let ((num (if (complexp x) (realpart x) x)))
3765    (multiple-value-bind (complexp low high)
3766        (if (complexp x)
3767            (let ((imag (imagpart x)))
3768              (values :complex (min num imag) (max num imag)))
3769            (values :real num num))
3770      (make-numeric-ctype :class (etypecase num
3771                                   (integer (if (complexp x)
3772                                                (if (integerp (imagpart x))
3773                                                    'integer
3774                                                    'rational)
3775                                                'integer))
3776                                   (rational 'rational)
3777                                   (float 'float))
3778                          :format (and (floatp num)
3779                                       (if (typep num 'double-float)
3780                                         'double-float
3781                                         'single-float))
3782                          :complexp complexp
3783                          :low low
3784                          :high high))))
3785
3786(defun ctype-of (x)
3787  (typecase x
3788    (function (specifier-type 'function)) ; GFs ..
3789    (symbol
3790     (make-member-ctype :members (list x)))
3791    (number (ctype-of-number x))
3792    (array
3793     (let ((etype (specifier-type (array-element-type x))))
3794       (make-array-ctype :dimensions (array-dimensions x)
3795                         :complexp (not (typep x 'simple-array))
3796                         :element-type etype
3797                         :specialized-element-type etype)))
3798    (t
3799     (%class.ctype (class-of x)))))
3800
3801(defvar *ctype-of-double-float-0* (ctype-of 0.0d0))
3802(defvar *ctype-of-single-float-0* (ctype-of 0.0f0))
3803
3804
3805
3806
3807; These DEFTYPES should only happen while initializing.
3808
3809(progn
3810(let-globally ((*type-system-initialized* nil))
3811
3812
3813(deftype bit () '(integer 0 1))
3814
3815(deftype eql (val) `(member ,val))
3816
3817(deftype signed-byte (&optional s)
3818  (cond ((eq s '*) 'integer)
3819          ((and (integerp s) (> s 0))
3820           (let ((bound (ash 1 (1- s))))
3821             `(integer ,(- bound) ,(1- bound))))
3822          (t
3823           (signal-program-error "Bad size specified for SIGNED-BYTE type specifier: ~S." s))))
3824 
3825(deftype unsigned-byte (&optional s)
3826  (cond ((eq s '*) '(integer 0))
3827        ((and (integerp s) (> s 0))
3828         `(integer 0 ,(1- (ash 1 s))))
3829        (t
3830         (error "Bad size specified for UNSIGNED-BYTE type specifier: ~S." s))))
3831
3832(deftype vector (&optional element-type size)
3833  `(array ,element-type (,size)))
3834
3835(deftype simple-vector (&optional size)
3836  `(simple-array t (,size)))
3837
3838(deftype base-string (&optional size)
3839  `(array base-char (,size)))
3840(deftype simple-base-string (&optional size)
3841  `(simple-array base-char (,size)))
3842
3843
3844
3845(deftype string (&optional size)
3846  `(array character (,size)))
3847
3848(deftype simple-string (&optional size)
3849  `(simple-array character (,size)))
3850
3851(deftype extended-string (&optional size)
3852  (declare (ignore size))
3853  'nil)
3854
3855(deftype simple-extended-string (&optional size)
3856  (declare (ignore size))
3857  'nil)
3858
3859(deftype bit-vector (&optional size)
3860  `(array bit (,size)))
3861
3862(deftype simple-bit-vector (&optional size)
3863  `(simple-array bit (,size)))
3864
3865; TYPE-OF sometimes returns random symbols that aren't really type specifiers.
3866
3867(deftype simple-unsigned-word-vector (&optional size)
3868  `(simple-array (unsigned-byte 16) (,size)))
3869
3870(deftype simple-unsigned-byte-vector (&optional size)
3871  `(simple-array (unsigned-byte 8) (,size)))
3872
3873(deftype simple-unsigned-long-vector (&optional size)
3874  `(simple-array (unsigned-byte 32) (,size)))
3875
3876(deftype simple-signed-word-vector (&optional size)
3877  `(simple-array (signed-byte 16) (,size)))
3878
3879(deftype simple-signed-byte-vector (&optional size)
3880  `(simple-array (signed-byte 8) (,size)))
3881
3882(deftype simple-signed-long-vector (&optional size)
3883  `(simple-array (signed-byte 32) (,size)))
3884
3885(deftype simple-double-float-vector (&optional size)
3886  `(simple-array double-float (,size)))
3887
3888(deftype simple-short-float-vector (&optional size)
3889  `(simple-array short-float (,size)))
3890
3891(deftype unsigned-word-vector (&optional size)
3892  `(vector (unsigned-byte 16) ,size))
3893
3894(deftype single-float-vector (&optional size)
3895  `(vector short-float ,size))
3896
3897(deftype unsigned-byte-vector (&optional size)
3898  `(vector (unsigned-byte 8) ,size))
3899
3900(deftype unsigned-long-vector (&optional size)
3901  `(vector (unsigned-byte 32) ,size))
3902
3903(deftype long-float-vector (&optional size)
3904  `(vector double-float ,size))
3905
3906(deftype long-vector (&optional size)
3907  `(vector (signed-byte 32) ,size))
3908
3909(deftype double-float-vector (&optional size)
3910  `(vector double-float ,size))
3911
3912(deftype byte-vector (&optional size)
3913  `(vector (signed-byte 8) ,size))
3914
3915(deftype general-vector (&optional size)
3916  `(vector t ,size))
3917
3918(deftype word-vector (&optional size)
3919  `(vector (signed-byte 16) ,size))
3920
3921(deftype short-float-vector (&optional size)
3922  `(vector single-float ,size))
3923
3924(deftype simple-1d-array (&optional size)
3925  `(simple-array * (,size)))
3926
3927(deftype simple-long-vector (&optional size)
3928  `(simple-array (signed-byte 32) (,size)))
3929
3930(deftype simple-word-vector (&optional size)
3931  `(simple-array (signed-byte 16) (,size)))
3932
3933(deftype simple-short-float-vector (&optional size)
3934  `(simple-array single-float (,size)))
3935
3936(deftype simple-byte-vector (&optional size)
3937  `(simple-array (signed-byte 8) (,size)))
3938
3939(deftype simple-double-float-vector (&optional size)
3940  `(simple-array double-float (,size)))
3941
3942(deftype simple-single-float-vector (&optional size)
3943  `(simple-array single-float (,size)))
3944
3945(deftype simple-fixnum-vector (&optional size)
3946  `(simple-array fixnum (,size)))
3947
3948#+64-bit-target
3949(deftype simple-doubleword-vector (&optional size)
3950  `(simple-array (signed-byte 64) (,size)))
3951
3952#+64-bit-target
3953(deftype simple-unsigned-doubleword-vector (&optional size)
3954  `(simple-array (unsigned-byte 64) (,size)))
3955
3956
3957(deftype short-float (&optional low high)
3958  `(single-float ,low ,high))
3959
3960(deftype long-float (&optional low high)
3961  `(double-float ,low ,high))
3962
3963;;; As empty a type as you're likely to find ...
3964(deftype extended-char ()
3965  "Type of CHARACTERs that aren't BASE-CHARs."
3966  nil)
3967)
3968
3969
3970(let* ((builtin-translations 
3971        `((array . array)
3972          (simple-array . simple-array)
3973          (cons . cons)
3974          (vector . vector)
3975          (null . (member nil))
3976          (list . (or cons null))
3977          (sequence . (or list vector))
3978          (simple-vector . simple-vector)
3979          (bit-vector . bit-vector)
3980          (simple-bit-vector . simple-bit-vector)
3981          (simple-string . simple-string)
3982          (simple-base-string . simple-base-string)
3983          (string . string)
3984          (base-string . base-string)
3985          (real . real)
3986          (complex . complex)
3987          (float . float)
3988          (double-float . double-float)
3989          (long-float . double-float)
3990          (single-float . single-float)
3991          (short-float . single-float)
3992
3993          (rational . rational)
3994          (integer . integer)
3995          (ratio . (and rational (not integer)))
3996          (fixnum . (integer ,target::target-most-negative-fixnum
3997                     ,target::target-most-positive-fixnum))
3998          (bignum . (or (integer * (,target::target-most-negative-fixnum))
3999                         (integer (,target::target-most-positive-fixnum) *)))
4000         
4001          )))
4002  (dolist (spec builtin-translations)
4003    (setf (info-type-kind (car spec)) :primitive
4004          (info-type-builtin (car spec)) (specifier-type (cdr spec)))))
4005
4006
4007
4008
4009
4010       
4011(precompute-types '((mod 2) (mod 4) (mod 16) (mod #x100) (mod #x10000)
4012                    #-cross-compiling
4013                    (mod #x100000000)
4014                    (unsigned-byte 1) 
4015                    (unsigned-byte 8) (unsigned-byte 16) (unsigned-byte 32)
4016                    (unsigned-byte 64)
4017                    (signed-byte 8) (signed-byte 16) (signed-byte 32)
4018                    (signed-byte 64)
4019                    (or function symbol)
4020                    ))
4021
4022
4023(precompute-types *cl-types*)
4024
4025;;; Treat CHARACTER and BASE-CHAR as equivalent.
4026(setf (info-type-builtin 'character) (info-type-builtin 'base-char))
4027;;; And EXTENDED-CHAR as empty.
4028(setf (info-type-builtin 'extended-char) *empty-type*)
4029
4030(defparameter *null-type* (specifier-type 'null))
4031
4032
4033(flet ((set-builtin-class-type-translation (thing)
4034         (let* ((class-name (if (atom thing) thing (car thing)))
4035                (spec (if (atom thing) thing (cadr thing)))
4036                (spectype (specifier-type spec)))
4037           (setf (class-ctype-translation
4038                  (%class.ctype (find-class class-name))) spectype))))
4039  (mapc #'set-builtin-class-type-translation
4040        '(
4041          ;; Root Of All Evil
4042          t
4043          ;; Numbers:
4044          number real ratio complex rational fixnum
4045          ;;  Integers:
4046          signed-byte  unsigned-byte bit bignum integer
4047          ;;  Floats
4048           float  double-float single-float
4049          ;; Arrays
4050          array
4051          ;;  Simple Arrays
4052          simple-array
4053          ;;  Vectors
4054          vector string base-string bit-vector
4055          unsigned-byte-vector unsigned-word-vector unsigned-long-vector
4056          byte-vector word-vector long-vector
4057          single-float-vector double-float-vector
4058          general-vector
4059          fixnum-vector
4060          #+64-bit-target
4061          doubleword-vector
4062          #+64-bit-target
4063          unsigned-doubleword-vector
4064          ;;   Simple 1-Dimensional Arrays
4065          simple-1d-array  simple-string simple-base-string simple-bit-vector
4066          simple-unsigned-byte-vector
4067          simple-unsigned-long-vector
4068          simple-unsigned-word-vector
4069          simple-byte-vector
4070          simple-word-vector
4071          simple-long-vector 
4072          simple-single-float-vector 
4073          simple-double-float-vector
4074          simple-vector
4075          simple-fixnum-vector
4076          #+64-bit-target
4077          simple-doubleword-vector
4078          #+64-bit-target
4079          simple-unsigned-doubleword-vector
4080          ;; Sequence types
4081          sequence list  cons null
4082         
4083 )
4084                                                         
4085        ))
4086)
4087;(setq *type-system-initialized* t)
4088
4089
4090
4091
4092; These deftypes help the CMUCL compiler; the type system doesn't depend on them.
4093
4094;;; Since OpenMCL's DEFTYPE tries to globally define the type
4095;;; at compile-time as well as load- and execute time, hide
4096;;; the definition of these "built-in" types.  (It'd be cleaner
4097;;; to make DEFTYPE do something saner at compile-time.)
4098(let* ()                                ; make the following be non-toplevel
4099(deftype boolean () '(member t nil))
4100
4101(deftype atom () '(not cons))
4102;;;
4103;;; A type specifier.
4104(deftype type-specifier () '(or list symbol class))
4105;;;
4106;;; An index into an array.   Also used for sequence index.
4107(deftype index () `(integer 0 (,array-dimension-limit)))
4108;;;
4109;;; Array rank, total size...
4110(deftype array-rank () `(integer 0 (,array-rank-limit)))
4111(deftype array-total-size () `(integer 0 (,array-total-size-limit)))
4112;;;
4113;;; Some thing legal in an evaluated context.
4114(deftype form () t)
4115;;;
4116;;; Maclisp compatibility...
4117(deftype stringlike () '(or string symbol))
4118(deftype stringable () '(or string symbol character))
4119;;;
4120;;; Save a little typing...
4121(deftype truth () '(member t))
4122;;;
4123;;; A thing legal in places where we want the name of a file.
4124(deftype filename () '(or string pathname))
4125;;;
4126;;; A legal arg to pathname functions.
4127(deftype pathnamelike () '(or string pathname stream))
4128;;;
4129;;; A thing returned by the irrational functions.  We assume that they never
4130;;; compute a rational result.
4131(deftype irrational () '(or float (complex float)))
4132;;;
4133;;; Character components:
4134(deftype char-code () `(integer 0 (,char-code-limit)))
4135;;;
4136;;; A consed sequence result.  If a vector, is a simple array.
4137(deftype consed-sequence () '(or list (simple-array * (*))))
4138;;;
4139;;; The :end arg to a sequence...
4140(deftype sequence-end () '(or null index))
4141;;;
4142;;; A valid argument to a stream function...
4143(deftype streamlike () '(or stream (member nil t)))
4144;;;
4145;;; A thing that can be passed to funcall & friends.
4146(deftype callable () '(or function symbol))
4147
4148;;; Until we decide if and how to wedge this into the type system, make it
4149;;; equivalent to t.
4150;;;
4151(deftype void () t)
4152;;;
4153;;; An index into an integer.
4154(deftype bit-index () `(integer 0 ,target::target-most-positive-fixnum))
4155;;;
4156;;; Offset argument to Ash (a signed bit index).
4157(deftype ash-index () 'fixnum)
4158
4159;;; Not sure how to do this without SATISFIES.
4160(deftype setf-function-name () `(satisfies setf-function-name-p))
4161
4162;;; Better than nothing, arguably.
4163(deftype function-name () `(or symbol setf-function-name))
4164
4165)                                       ; end of LET* sleaze
4166
4167(defun array-or-union-ctype-element-type (ctype)
4168  (if (typep ctype 'array-ctype)
4169    (type-specifier (array-ctype-element-type ctype))
4170    (if (typep ctype 'union-ctype)
4171      `(or ,@(mapcar #'array-or-union-ctype-element-type 
4172                     (union-ctype-types ctype))))))
4173
4174
4175(defvar *simple-predicate-function-prototype*
4176  #'(lambda (thing)
4177      (%%typep thing #.(specifier-type t))))
4178
4179(defun make-simple-type-predicate (function datum)
4180  #+ppc-target
4181  (gvector :function
4182           (uvref *simple-predicate-function-prototype* 0)
4183           datum
4184           function
4185           nil
4186           (dpb 1 $lfbits-numreq 0))
4187  #+x86-target
4188  (%clone-x86-function
4189   *simple-predicate-function-prototype*
4190   datum
4191   function
4192   nil
4193   (dpb 1 $lfbits-numreq 0)))
4194
4195(defun check-ctypep (thing ctype)
4196  (multiple-value-bind (win sure) (ctypep thing ctype)
4197    (or win (not sure))))
4198
4199
4200(defun generate-predicate-for-ctype (ctype)
4201  (typecase ctype
4202    (numeric-ctype
4203     (or (numeric-ctype-predicate ctype)
4204         (make-simple-type-predicate 'numeric-%%typep ctype)))
4205    (array-ctype
4206     (make-simple-type-predicate 'array-%%typep ctype))
4207    (member-ctype
4208     (make-simple-type-predicate 'member-%%typep ctype))
4209    (named-ctype
4210     (case (named-ctype-name ctype)
4211       ((* t) #'true)
4212       (t #'false)))
4213    (cons-ctype
4214     (make-simple-type-predicate 'cons-%%typep ctype))
4215    (function-ctype
4216     #'functionp)
4217    (class-ctype
4218     (make-simple-type-predicate 'class-cell-typep (find-class-cell (class-name (class-ctype-class ctype)) t)))
4219    (t
4220     (make-simple-type-predicate 'check-ctypep ctype))))
4221   
4222       
4223
4224   
4225
4226;;; Ensure that standard EFFECTIVE-SLOT-DEFINITIONs have a meaningful
4227;;; type predicate, if we can.
4228(defmethod shared-initialize :after ((spec effective-slot-definition)
4229                                     slot-names
4230                                     &key 
4231                                     &allow-other-keys)
4232  (declare (ignore slot-names))
4233  (let* ((type (slot-definition-type spec)))
4234    (setf (slot-value spec 'type-predicate)
4235          (or (and (typep type 'symbol)
4236                   (not (eq type 't))
4237                   (type-predicate type))
4238              (handler-case
4239                  (let* ((ctype (specifier-type type)))
4240                    (unless (eq ctype *universal-type*)
4241                      (generate-predicate-for-ctype ctype)))
4242                (parse-unknown-type (c)
4243                   (declare (ignore c))
4244                   #'(lambda (value)
4245                       ;; If the type's now known, install a new predicate.
4246                       (let* ((nowctype (specifier-type type)))
4247                         (unless (typep nowctype 'unknown-ctype)
4248                           (setf (slot-value spec 'type-predicate)
4249                                 (generate-predicate-for-ctype nowctype)))
4250                         (multiple-value-bind (win sure)
4251                             (ctypep value nowctype)
4252                           (or (not sure) win))))))))))
4253
Note: See TracBrowser for help on using the repository browser.