src/code/coerce.lisp

   1 ;;;; COERCE and related code
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   6 ;;;; This software is derived from the CMU CL system, which was
   7 ;;;; written at Carnegie Mellon University and released into the
   8 ;;;; public domain. The software is in the public domain and is
   9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  10 ;;;; files for more information.
  11
  12 (in-package "SB!IMPL")
  13
  14 (macrolet ((def (name result access src-type &optional typep)
  15              `(defun ,name (object ,@(if typep '(type) ()))
  16                 (do* ((index 0 (1+ index))
  17                       (length (length (the ,(ecase src-type
  18                                               (:list 'list)
  19                                               (:vector 'vector))
  20                                            object)))
  21                       (result ,result)
  22                       (in-object object))
  23                      ((= index length) result)
  24                   (declare (fixnum length index))
  25                   (setf (,access result index)
  26                         ,(ecase src-type
  27                            (:list '(pop in-object))
  28                            (:vector '(aref in-object index))))))))
  29
  30   (def list-to-vector* (make-sequence type length)
  31     aref :list t)
  32
  33   (def vector-to-vector* (make-sequence type length)
  34     aref :vector t))
  35
  36 (defun vector-to-list* (object)
  37   (let ((result (list nil))
  38         (length (length object)))
  39     (declare (fixnum length))
  40     (do ((index 0 (1+ index))
  41          (splice result (cdr splice)))
  42         ((= index length) (cdr result))
  43       (declare (fixnum index))
  44       (rplacd splice (list (aref object index))))))
  45
  46 (defvar *offending-datum*); FIXME: Remove after debugging COERCE.
  47
  48 ;;; These are used both by the full DEFUN function and by various
  49 ;;; optimization transforms in the constant-OUTPUT-TYPE-SPEC case.
  50 ;;;
  51 ;;; Most of them are INLINE so that they can be optimized when the
  52 ;;; argument type is known. It might be better to do this with
  53 ;;; DEFTRANSFORMs, though.
  54 (declaim (inline coerce-to-list))
  55 (declaim (inline coerce-to-vector))
  56 (defun coerce-to-fun (object)
  57   ;; (Unlike the other COERCE-TO-FOOs, this one isn't inline, because
  58   ;; it's so big and because optimizing away the outer ETYPECASE
  59   ;; doesn't seem to buy us that much anyway.)
  60   (etypecase object
  61     (symbol
  62      ;; ANSI lets us return ordinary errors (non-TYPE-ERRORs) here.
  63      (cond ((macro-function object)
  64             (error "~S names a macro." object))
  65            ((special-operator-p object)
  66             (error "~S is a special operator." object))
  67            (t (fdefinition object))))
  68     (list
  69      (case (first object)
  70        ((setf)
  71         (fdefinition object))
  72        ((lambda instance-lambda)
  73         ;; FIXME: If we go to a compiler-only implementation, this can
  74         ;; become COMPILE instead of EVAL, which seems nicer to me.
  75         (eval `(function ,object)))
  76        (t
  77         (error 'simple-type-error
  78                :datum object
  79                :expected-type '(or symbol
  80                                    ;; KLUDGE: ANSI wants us to
  81                                    ;; return a TYPE-ERROR here, and
  82                                    ;; a TYPE-ERROR is supposed to
  83                                    ;; describe the expected type,
  84                                    ;; but it's not obvious how to
  85                                    ;; describe the coerceable cons
  86                                    ;; types, so we punt and just say
  87                                    ;; CONS. -- WHN 20000503
  88                                    cons)
  89                :format-control "~S can't be coerced to a function."
  90                :format-arguments (list object)))))))
  91
  92 (defun coerce-to-list (object)
  93   (etypecase object
  94     (vector (vector-to-list* object))))
  95
  96 (defun coerce-to-vector (object output-type-spec)
  97   (etypecase object
  98     (list (list-to-vector* object output-type-spec))
  99     (vector (vector-to-vector* object output-type-spec))))
 100
 101 ;;; old working version
 102 (defun coerce (object output-type-spec)
 103   #!+sb-doc
 104   "Coerce the Object to an object of type Output-Type-Spec."
 105   (flet ((coerce-error ()
 106            (/show0 "entering COERCE-ERROR")
 107            (error 'simple-type-error
 108                   :format-control "~S can't be converted to type ~S."
 109                   :format-arguments (list object output-type-spec))))
 110     (let ((type (specifier-type output-type-spec)))
 111       (cond
 112         ((%typep object output-type-spec)
 113          object)
 114         ((eq type *empty-type*)
 115          (coerce-error))
 116         ((csubtypep type (specifier-type 'character))
 117          (character object))
 118         ((csubtypep type (specifier-type 'function))
 119          (when (and (legal-fun-name-p object)
 120                     (not (fboundp object)))
 121            (error 'simple-type-error
 122                   :datum object
 123                   ;; FIXME: SATISFIES FBOUNDP is a kinda bizarre broken
 124                   ;; type specifier, since the set of values it describes
 125                   ;; isn't in general constant in time. Maybe we could
 126                   ;; find a better way of expressing this error? (Maybe
 127                   ;; with the UNDEFINED-FUNCTION condition?)
 128                   :expected-type '(satisfies fboundp)
 129                :format-control "~S isn't fbound."
 130                :format-arguments (list object)))
 131          (when (and (symbolp object)
 132                     (sb!xc:macro-function object))
 133            (error 'simple-type-error
 134                   :datum object
 135                   :expected-type '(not (satisfies sb!xc:macro-function))
 136                   :format-control "~S is a macro."
 137                   :format-arguments (list object)))
 138          (when (and (symbolp object)
 139                     (special-operator-p object))
 140            (error 'simple-type-error
 141                   :datum object
 142                   :expected-type '(not (satisfies special-operator-p))
 143                   :format-control "~S is a special operator."
 144                   :format-arguments (list object)))
 145          (eval `#',object))
 146         ((numberp object)
 147          (cond
 148            ((csubtypep type (specifier-type 'single-float))
 149             (let ((res (%single-float object)))
 150               (unless (typep res output-type-spec)
 151                 (coerce-error))
 152               res))
 153            ((csubtypep type (specifier-type 'double-float))
 154             (let ((res (%double-float object)))
 155               (unless (typep res output-type-spec)
 156                 (coerce-error))
 157               res))
 158            #!+long-float
 159            ((csubtypep type (specifier-type 'long-float))
 160             (let ((res (%long-float object)))
 161               (unless (typep res output-type-spec)
 162                 (coerce-error))
 163               res))
 164            ((csubtypep type (specifier-type 'float))
 165             (let ((res (%single-float object)))
 166               (unless (typep res output-type-spec)
 167                 (coerce-error))
 168               res))
 169            (t
 170             (let ((res
 171                    (cond
 172                      ((csubtypep type (specifier-type '(complex single-float)))
 173                       (complex (%single-float (realpart object))
 174                                (%single-float (imagpart object))))
 175                      ((csubtypep type (specifier-type '(complex double-float)))
 176                       (complex (%double-float (realpart object))
 177                                (%double-float (imagpart object))))
 178                      #!+long-float
 179                      ((csubtypep type (specifier-type '(complex long-float)))
 180                       (complex (%long-float (realpart object))
 181                                (%long-float (imagpart object))))
 182                      ((csubtypep type (specifier-type '(complex float)))
 183                       (complex (%single-float (realpart object))
 184                                (%single-float (imagpart object))))
 185                      ((and (typep object 'rational)
 186                            (csubtypep type (specifier-type '(complex float))))
 187                       ;; Perhaps somewhat surprisingly, ANSI specifies
 188                       ;; that (COERCE FOO 'FLOAT) is a SINGLE-FLOAT,
 189                       ;; not dispatching on
 190                       ;; *READ-DEFAULT-FLOAT-FORMAT*.  By analogy, we
 191                       ;; do the same for complex numbers. -- CSR,
 192                       ;; 2002-08-06
 193                       (complex (%single-float object)))
 194                      ((csubtypep type (specifier-type 'complex))
 195                       (complex object))
 196                      (t
 197                       (coerce-error)))))
 198               ;; If RES has the wrong type, that means that rule of
 199               ;; canonical representation for complex rationals was
 200               ;; invoked. According to the Hyperspec, (coerce 7/2
 201               ;; 'complex) returns 7/2. Thus, if the object was a
 202               ;; rational, there is no error here.
 203               (unless (or (typep res output-type-spec)
 204                           (rationalp object))
 205                 (coerce-error))
 206               res))))
 207         ((csubtypep type (specifier-type 'list))
 208          (if (vectorp object)
 209              (cond
 210                ((type= type (specifier-type 'list))
 211                 (vector-to-list* object))
 212                ((type= type (specifier-type 'null))
 213                 (if (= (length object) 0)
 214                     'nil
 215                     (sequence-type-length-mismatch-error type
 216                                                          (length object))))
 217                ((cons-type-p type)
 218                 (multiple-value-bind (min exactp)
 219                     (sb!kernel::cons-type-length-info type)
 220                   (let ((length (length object)))
 221                     (if exactp
 222                         (unless (= length min)
 223                           (sequence-type-length-mismatch-error type length))
 224                         (unless (>= length min)
 225                           (sequence-type-length-mismatch-error type length)))
 226                     (vector-to-list* object))))
 227                (t (sequence-type-too-hairy (type-specifier type))))
 228              (coerce-error)))
 229         ((csubtypep type (specifier-type 'vector))
 230          (typecase object
 231            ;; FOO-TO-VECTOR* go through MAKE-SEQUENCE, so length
 232            ;; errors are caught there. -- CSR, 2002-10-18
 233            (list (list-to-vector* object output-type-spec))
 234            (vector (vector-to-vector* object output-type-spec))
 235            (t
 236             (coerce-error))))
 237         (t
 238          (coerce-error))))))
 239
 240 ;;; new version, which seems as though it should be better, but which
 241 ;;; does not yet work
 242 #+nil
 243 (defun coerce (object output-type-spec)
 244   #!+sb-doc
 245   "Coerces the Object to an object of type Output-Type-Spec."
 246   (flet ((coerce-error ()
 247            (error 'simple-type-error
 248                   :format-control "~S can't be converted to type ~S."
 249                   :format-arguments (list object output-type-spec)))
 250          (check-result (result)
 251            #!+high-security (aver (typep result output-type-spec))
 252            result))
 253     (let ((type (specifier-type output-type-spec)))
 254       (cond
 255         ((%typep object output-type-spec)
 256          object)
 257         ((eq type *empty-type*)
 258          (coerce-error))
 259         ((csubtypep type (specifier-type 'character))
 260          (character object))
 261         ((csubtypep type (specifier-type 'function))
 262          (coerce-to-fun object))
 263         ((numberp object)
 264          (let ((res
 265                 (cond
 266                   ((csubtypep type (specifier-type 'single-float))
 267                    (%single-float object))
 268                   ((csubtypep type (specifier-type 'double-float))
 269                    (%double-float object))
 270                   #!+long-float
 271                   ((csubtypep type (specifier-type 'long-float))
 272                    (%long-float object))
 273                   ((csubtypep type (specifier-type 'float))
 274                    (%single-float object))
 275                   ((csubtypep type (specifier-type '(complex single-float)))
 276                    (complex (%single-float (realpart object))
 277                             (%single-float (imagpart object))))
 278                   ((csubtypep type (specifier-type '(complex double-float)))
 279                    (complex (%double-float (realpart object))
 280                             (%double-float (imagpart object))))
 281                   #!+long-float
 282                   ((csubtypep type (specifier-type '(complex long-float)))
 283                    (complex (%long-float (realpart object))
 284                             (%long-float (imagpart object))))
 285                   ((csubtypep type (specifier-type 'complex))
 286                    (complex object))
 287                   (t
 288                    (coerce-error)))))
 289            ;; If RES has the wrong type, that means that rule of
 290            ;; canonical representation for complex rationals was
 291            ;; invoked. According to the ANSI spec, (COERCE 7/2
 292            ;; 'COMPLEX) returns 7/2. Thus, if the object was a
 293            ;; rational, there is no error here.
 294            (unless (or (typep res output-type-spec) (rationalp object))
 295              (coerce-error))
 296            res))
 297         ((csubtypep type (specifier-type 'list))
 298          (coerce-to-list object))
 299         ((csubtypep type (specifier-type 'string))
 300          (check-result (coerce-to-simple-string object)))
 301         ((csubtypep type (specifier-type 'bit-vector))
 302          (check-result (coerce-to-bit-vector object)))
 303         ((csubtypep type (specifier-type 'vector))
 304          (check-result (coerce-to-vector object output-type-spec)))
 305         (t
 306          (coerce-error))))))