tests/print.impure.lisp

   1 ;;;; miscellaneous tests of printing stuff
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   6 ;;;; While most of SBCL is derived from the CMU CL system, the test
   7 ;;;; files (like this one) were written from scratch after the fork
   8 ;;;; from CMU CL.
   9 ;;;;
  10 ;;;; This software is in the public domain and is provided with
  11 ;;;; absolutely no warranty. See the COPYING and CREDITS files for
  12 ;;;; more information.
  13
  14 (load "assertoid.lisp")
  15 (use-package "ASSERTOID")
  16
  17 ;;; We should be able to output X readably (at least when *READ-EVAL*).
  18 (defun assert-readable-output (x)
  19   (assert (eql x
  20                (let ((*read-eval* t))
  21                  (read-from-string (with-output-to-string (s)
  22                                      (write x :stream s :readably t)))))))
  23
  24 ;;; Even when *READ-EVAL* is NIL, we should be able to output some
  25 ;;; (not necessarily readable) representation without signalling an
  26 ;;; error.
  27 (defun assert-unreadable-output (x)
  28   (let ((*read-eval* nil))
  29     (with-output-to-string (s) (write x :stream s :readably nil))))
  30
  31 (defun assert-output (x)
  32   (assert-readable-output x)
  33   (assert-unreadable-output x))
  34
  35 ;;; Nathan Froyd reported that sbcl-0.6.11.34 screwed up output of
  36 ;;; floating point infinities.
  37 (dolist (x (list short-float-positive-infinity short-float-negative-infinity
  38                  single-float-positive-infinity single-float-negative-infinity
  39                  double-float-positive-infinity double-float-negative-infinity
  40                  long-float-positive-infinity long-float-negative-infinity))
  41   (assert-output x))
  42
  43 ;;; Eric Marsden reported that this would blow up in CMU CL (even
  44 ;;; though ANSI says that the mismatch between ~F expected type and
  45 ;;; provided string type is supposed to be handled without signalling
  46 ;;; an error) and provided a fix which was ported to sbcl-0.6.12.35.
  47 (assert (null (format t "~F" "foo")))
  48
  49 ;;; This was a bug in SBCL until 0.6.12.40 (originally reported as a
  50 ;;; CMU CL bug by Erik Naggum on comp.lang.lisp).
  51 (loop for base from 2 to 36
  52       with *print-radix* = t
  53       do (let ((*print-base* base))
  54            (assert (string= "#*101" (format nil "~S" #*101)))))
  55
  56 ;;; bug in sbcl-0.7.1.25, reported by DB sbcl-devel 2002-02-25
  57 (assert (string= "0.5" (format nil "~2D" 0.5)))
  58
  59 ;;; we want malformed format strings to cause errors rather than have
  60 ;;; some DWIM "functionality".
  61 (assert (raises-error? (format nil "~:2T")))
  62
  63 ;;; bug reported, with fix, by Robert Strandh, sbcl-devel 2002-03-09,
  64 ;;; fixed in sbcl-0.7.1.36:
  65 (assert (string= (format nil "~2,3,8,'0$" 1234567.3d0) "1234567.30"))
  66
  67 ;;; checks that other FORMAT-DOLLAR output remains sane after the
  68 ;;; 0.7.1.36 change
  69 (assert (string= (format nil "~$" 0) "0.00"))
  70 (assert (string= (format nil "~$" 4) "4.00"))
  71 (assert (string= (format nil "~$" -4.0) "-4.00"))
  72 (assert (string= (format nil "~2,7,11$" -4.0) "-0000004.00"))
  73 (assert (string= (format nil "~2,7,11,' $" 1.1) " 0000001.10"))
  74 (assert (string= (format nil "~1,7,11,' $" 1.1) "  0000001.1"))
  75 (assert (string= (format nil "~1,3,8,' $" 7.3) "   007.3"))
  76 (assert (string= (format nil "~2,3,8,'0$" 7.3) "00007.30"))
  77
  78 ;;; Check for symbol lookup in ~/ / directive -- double-colon was
  79 ;;; broken in 0.7.1.36 and earlier
  80 (defun print-foo (stream arg colonp atsignp &rest params)
  81   (declare (ignore colonp atsignp params))
  82   (format stream "~d" arg))
  83
  84 (assert (string= (format nil "~/print-foo/" 2) "2"))
  85 (assert (string= (format nil "~/cl-user:print-foo/" 2) "2"))
  86 (assert (string= (format nil "~/cl-user::print-foo/" 2) "2"))
  87 (assert (raises-error? (format nil "~/cl-user:::print-foo/" 2)))
  88 (assert (raises-error? (format nil "~/cl-user:a:print-foo/" 2)))
  89 (assert (raises-error? (format nil "~/a:cl-user:print-foo/" 2)))
  90 (assert (raises-error? (format nil "~/cl-user:print-foo:print-foo/" 2)))
  91
  92 ;;; better make sure that we get this one right, too
  93 (defun print-foo\:print-foo (stream arg colonp atsignp &rest params)
  94   (declare (ignore colonp atsignp params))
  95   (format stream "~d" arg))
  96
  97 (assert (string= (format nil "~/cl-user:print-foo:print-foo/" 2) "2"))
  98 (assert (string= (format nil "~/cl-user::print-foo:print-foo/" 2) "2"))
  99
 100 ;;; Check for error detection of illegal directives in a~<..~> justify
 101 ;;; block (see ANSI section 22.3.5.2)
 102 (assert (raises-error? (format nil "~<~W~>" 'foo)))
 103 (assert (raises-error? (format nil "~<~<~A~:>~>" '(foo))))
 104 (assert (string= (format nil "~<~<~A~>~>" 'foo) "FOO"))
 105
 106 ;;; Check that arrays that we print while *PRINT-READABLY* is true are
 107 ;;; in fact generating similar objects.
 108 (assert (equal (array-dimensions
 109                 (read-from-string
 110                  (with-output-to-string (s)
 111                    (let ((*print-readably* t))
 112                      (print (make-array '(1 2 0)) s)))))
 113                '(1 2 0)))
 114
 115 (dolist (array (list (make-array '(1 0 1))
 116                      (make-array 0 :element-type nil)
 117                      (make-array 1 :element-type 'base-char)
 118                      (make-array 1 :element-type 'character)))
 119   (assert (multiple-value-bind (result error)
 120               (ignore-errors (read-from-string
 121                               (with-output-to-string (s)
 122                                 (let ((*print-readably* t))
 123                                   (print array s)))))
 124             ;; it might not be readably-printable
 125             (or (typep error 'print-not-readable)
 126                 (and
 127                  ;; or else it had better have the same dimensions
 128                  (equal (array-dimensions result) (array-dimensions array))
 129                  ;; and the same element-type
 130                  (equal (array-element-type result) (array-element-type array)))))))
 131
 132 ;;; before 0.8.0.66 it signalled UNBOUND-VARIABLE
 133 (write #(1 2 3) :pretty nil :readably t)
 134
 135 ;;; another UNBOUND-VARIABLE, this time due to a bug in FORMATTER
 136 ;;; expanders.
 137 (funcall (formatter "~@<~A~:*~A~:>") nil 3)
 138
 139 ;;; the PPC floating point backend was at one point sufficiently
 140 ;;; broken that this looped infinitely or caused segmentation
 141 ;;; violations through stack corruption.
 142 (print 0.0001)
 143
 144 ;;; In sbcl-0.8.7, the ~W format directive interpreter implemented the
 145 ;;; sense of the colon and at-sign modifiers exactly backwards.
 146 ;;;
 147 ;;; (Yes, the test for this *is* substantially hairier than the fix;
 148 ;;; wanna make something of it?)
 149 (cl:in-package :cl-user)
 150 (defstruct wexerciser-0-8-7)
 151 (defun wexercise-0-8-7-interpreted (wformat)
 152   (format t wformat (make-wexerciser-0-8-7)))
 153 (defmacro define-compiled-wexercise-0-8-7 (wexercise wformat)
 154   `(defun ,wexercise ()
 155     (declare (optimize (speed 3) (space 1)))
 156     (format t ,wformat (make-wexerciser-0-8-7))
 157     (values)))
 158 (define-compiled-wexercise-0-8-7 wexercise-0-8-7-compiled-without-atsign "~W")
 159 (define-compiled-wexercise-0-8-7 wexercise-0-8-7-compiled-with-atsign "~@W")
 160 (defmethod print-object :before ((wexerciser-0-8-7 wexerciser-0-8-7) stream)
 161   (unless (and *print-level* *print-length*)
 162     (error "gotcha coming")))
 163 (let ((*print-level* 11)
 164       (*print-length* 12))
 165   (wexercise-0-8-7-interpreted "~W")
 166   (wexercise-0-8-7-compiled-without-atsign))
 167 (remove-method #'print-object
 168                (find-method #'print-object
 169                             '(:before)
 170                             (mapcar #'find-class '(wexerciser-0-8-7 t))))
 171 (defmethod print-object :before ((wexerciser-0-8-7 wexerciser-0-8-7) stream)
 172   (when (or *print-level* *print-length*)
 173     (error "gotcha going")))
 174 (let ((*print-level* 11)
 175       (*print-length* 12))
 176   (wexercise-0-8-7-interpreted "~@W")
 177   (wexercise-0-8-7-compiled-with-atsign))
 178 \f
 179 ;;; WRITE-TO-STRING was erroneously DEFKNOWNed as FOLDABLE
 180 ;;;
 181 ;;; This bug from PFD
 182 (defpackage "SCRATCH-WRITE-TO-STRING" (:use))
 183 (with-standard-io-syntax
 184   (let* ((*package* (find-package "SCRATCH-WRITE-TO-STRING"))
 185          (answer (write-to-string 'scratch-write-to-string::x :readably nil)))
 186     (assert (string= answer "X"))))
 187 ;;; and a couple from Bruno Haible
 188 (defun my-pprint-reverse (out list)
 189   (write-char #\( out)
 190   (when (setq list (reverse list))
 191     (loop
 192      (write (pop list) :stream out)
 193      (when (endp list) (return))
 194      (write-char #\Space out)))
 195   (write-char #\) out))
 196 (with-standard-io-syntax
 197   (let ((*print-pprint-dispatch* (copy-pprint-dispatch)))
 198     (set-pprint-dispatch '(cons (member foo)) 'my-pprint-reverse 0)
 199     (let ((answer (write-to-string '(foo bar :boo 1) :pretty t :escape t)))
 200       (assert (string= answer "(1 :BOO BAR FOO)")))))
 201 (defun my-pprint-logical (out list)
 202   (pprint-logical-block (out list :prefix "(" :suffix ")")
 203     (when list
 204       (loop
 205        (write-char #\? out)
 206        (write (pprint-pop) :stream out)
 207        (write-char #\? out)
 208        (pprint-exit-if-list-exhausted)
 209        (write-char #\Space out)))))
 210 (with-standard-io-syntax
 211   (let ((*print-pprint-dispatch* (copy-pprint-dispatch)))
 212     (set-pprint-dispatch '(cons (member bar)) 'my-pprint-logical 0)
 213     (let ((answer (write-to-string '(bar foo :boo 1) :pretty t :escape t)))
 214       (assert (string= answer "(?BAR? ?FOO? ?:BOO? ?1?)")))))
 215
 216 ;;; FORMAT string compile-time checker failure, reported by Thomas
 217 ;;; F. Burdick
 218 (multiple-value-bind (f w-p f-p)
 219     (compile nil '(lambda () (format nil "~{")))
 220   (assert (and w-p f-p))
 221   (assert (nth-value 1 (ignore-errors (funcall f)))))
 222
 223 ;;; floating point print/read consistency
 224 (let ((x (/ -9.349640046247849d-21 -9.381494249123696d-11)))
 225   (let ((y (read-from-string (write-to-string x :readably t))))
 226     (assert (eql x y))))
 227
 228 (let ((x1 (float -5496527/100000000000000000))
 229       (x2 (float -54965272/1000000000000000000)))
 230   (assert (or (equal (multiple-value-list (integer-decode-float x1))
 231                      (multiple-value-list (integer-decode-float x2)))
 232               (string/= (prin1-to-string x1) (prin1-to-string x2)))))
 233
 234 ;;; readable printing of arrays with *print-radix* t
 235 (let ((*print-radix* t)
 236       (*print-readably* t)
 237       (*print-pretty* nil))
 238   (let ((output (with-output-to-string (s)
 239                   (write #2a((t t) (nil nil)) :stream s))))
 240     (assert (equalp (read-from-string output) #2a((t t) (nil nil))))))
 241
 242 ;;; NIL parameters to "interpreted" FORMAT directives
 243 (assert (string= (format nil "~v%" nil) (string #\Newline)))
 244
 245 ;;; PRINC-TO-STRING should bind print-readably
 246 (let ((*print-readably* t))
 247   (assert (string= (princ-to-string #\7)
 248                    (write-to-string #\7 :escape nil :readably nil))))
 249
 250 ;;; in FORMAT, ~^ inside ~:{ should go to the next case, not break
 251 ;;; iteration, even if one argument is just a one-element list.
 252 (assert (string= (format nil "~:{~A~^~}" '((A) (C D))) "AC"))
 253
 254 ;;; errors should be raised if pprint and justification are mixed
 255 ;;; injudiciously...
 256 (dolist (x (list "~<~:;~>~_" "~<~:;~>~I" "~<~:;~>~W"
 257                  "~<~:;~>~:T" "~<~:;~>~<~:>" "~_~<~:;~>"
 258                  "~I~<~:;~>" "~W~<~:;~>" "~:T~<~:;~>" "~<~:>~<~:;~>"))
 259   (assert (raises-error? (format nil x nil)))
 260   (assert (raises-error? (format nil (eval `(formatter ,x)) nil))))
 261 ;;; ...but not in judicious cases.
 262 (dolist (x (list "~<~;~>~_" "~<~;~>~I" "~<~;~>~W"
 263                  "~<~;~>~:T" "~<~;~>~<~>" "~_~<~;~>"
 264                  "~I~<~;~>" "~W~<~;~>" "~:T~<~;~>" "~<~>~<~;~>"
 265                  "~<~:;~>~T" "~T~<~:;~>"))
 266   (assert (format nil x nil))
 267   (assert (format nil (eval `(formatter ,x)) nil)))
 268
 269 ;;; bug 350: bignum printing so memory-hungry that heap runs out
 270 ;;; -- just don't stall here forever on a slow box
 271 (handler-case
 272     (with-timeout 10
 273       (print (ash 1 1000000)))
 274   (timeout ()
 275     (print 'timeout!)))
 276
 277 ;;; bug 371: bignum print/read inconsistency
 278 (defvar *bug-371* -7043009959286724629649270926654940933664689003233793014518979272497911394287216967075767325693021717277238746020477538876750544587281879084559996466844417586093291189295867052594478662802691926547232838591510540917276694295393715934079679531035912244103731582711556740654671309980075069010778644542022/670550434139267031632063192770201289106737062379324644110801846820471752716238484923370056920388400273070254958650831435834503195629325418985020030706879602898158806736813101434594805676212779217311897830937606064579213895527844045511878668289820732425014254579493444623868748969110751636786165152601)
 279 (let ((*print-base* 5)
 280       (*read-base* 5)
 281       (*print-radix* nil))
 282   (assert (= *bug-371* (read-from-string (prin1-to-string *bug-371*)))))
 283
 284 ;;; a spot of random-testing for rational printing
 285 (defvar *seed-state* (make-random-state))
 286 (print *seed-state*) ; so that we can reproduce errors
 287 (let ((seed (make-random-state *seed-state*)))
 288   (loop repeat 42
 289      do (let ((n (random (ash 1 1000) seed))
 290               (d (random (ash 1 1000) seed)))
 291           (when (zerop (random 2 seed))
 292             (setf n (- n)))
 293           (let ((r (/ n d)))
 294             (loop for base from 2 to 36
 295                do (let ((*print-base* base)
 296                         (*read-base* base)
 297                         (*print-radix* nil))
 298                     (assert (= r (read-from-string (prin1-to-string r))))
 299                     (if (= 36 base)
 300                         (decf *read-base*)
 301                         (incf *read-base*))
 302                     (assert (not (eql r (read-from-string (prin1-to-string r)))))
 303                     (let ((*print-radix* t))
 304                       (assert (= r (read-from-string
 305                                     (princ-to-string r)))))))))
 306        (write-char #\.)
 307        (finish-output)))
 308
 309 ;;;; Bugs, found by PFD
 310 ;;; NIL parameter for ~^ means `not supplied'
 311 (loop for (format arg result) in
 312       '(("~:{~D~v^~D~}" ((3 1 4) (1 0 2) (7 nil) (5 nil 6)) "341756")
 313         ("~:{~1,2,v^~A~}" ((nil 0) (3 1) (0 2)) "02"))
 314       do (assert (string= (funcall #'format nil format arg) result))
 315       do (assert (string= (with-output-to-string (s)
 316                             (funcall (eval `(formatter ,format)) s arg))
 317                           result)))
 318
 319 ;;; NIL first parameter for ~R is equivalent to no parameter.
 320 (assert (string= (format nil "~VR" nil 5) "five"))
 321 (assert (string= (format nil (formatter "~VR") nil 6) "six"))
 322
 323 ;;; CSR inserted a bug into Burger & Dybvig's float printer.  Caught
 324 ;;; by Raymond Toy
 325 (assert (string= (format nil "~E" 1d23) "1.d+23"))
 326
 327 ;;; Fixed-format bugs from CLISP's test suite (reported by Bruno
 328 ;;; Haible, bug 317)
 329 (assert (string= (format nil "~1F" 10) "10."))
 330 (assert (string= (format nil "~0F" 10) "10."))
 331 (assert (string= (format nil "~2F" 1234567.1) "1234567."))
 332
 333 ;;; here's one that seems to fail most places.  I think this is right,
 334 ;;; and most of the other answers I've seen are definitely wrong.
 335 (assert (string= (format nil "~G" 1d23) "100000000000000000000000.    "))
 336
 337 ;;; Adam Warner's test case
 338 (assert (string= (format nil "~@F" 1.23) "+1.23"))
 339
 340
 341 ;;; New (2005-11-08, also known as CSR House day) float format test
 342 ;;; cases.  Simon Alexander, Raymond Toy, and others
 343 (assert (string= (format nil "~9,4,,-7E" pi) ".00000003d+8"))
 344 (assert (string= (format nil "~9,4,,-5E" pi) ".000003d+6"))
 345 (assert (string= (format nil "~5,4,,7E" pi) "3141600.d-6"))
 346 (assert (string= (format nil "~11,4,,3E" pi) "  314.16d-2"))
 347 (assert (string= (format nil "~11,4,,5E" pi) "  31416.d-4"))
 348 (assert (string= (format nil "~11,4,,0E" pi) "  0.3142d+1"))
 349 (assert (string= (format nil "~9,,,-1E" pi) ".03142d+2"))
 350 (assert (string= (format nil "~,,,-2E" pi) "0.003141592653589793d+3"))
 351 (assert (string= (format nil "~,,,2E" pi) "31.41592653589793d-1"))
 352 (assert (string= (format nil "~E" pi) "3.141592653589793d+0"))
 353 (assert (string= (format nil "~9,5,,-1E" pi) ".03142d+2"))
 354 (assert (string= (format nil "~11,5,,-1E" pi) " 0.03142d+2"))
 355 (assert (string= (format nil "~G" pi) "3.141592653589793    "))
 356 (assert (string= (format nil "~9,5G" pi) "3.1416    "))
 357 (assert (string= (format nil "|~13,6,2,7E|" pi) "| 3141593.d-06|"))
 358 (assert (string= (format nil "~9,3,2,0,'%E" pi) "0.314d+01"))
 359 (assert (string= (format nil "~9,0,6f" pi) " 3141593."))
 360 (assert (string= (format nil "~6,2,1,'*F" pi) " 31.42"))
 361 (assert (string= (format nil "~6,2,1,'*F" (* 100 pi)) "******"))
 362 (assert (string= (format nil "~9,3,2,-2,'%@E" pi) "+.003d+03"))
 363 (assert (string= (format nil "~10,3,2,-2,'%@E" pi) "+0.003d+03"))
 364 (assert (string= (format nil "~15,3,2,-2,'%,'=@E" pi) "=====+0.003d+03"))
 365 (assert (string= (format nil "~9,3,2,-2,'%E" pi) "0.003d+03"))
 366 (assert (string= (format nil "~8,3,2,-2,'%@E" pi) "%%%%%%%%"))
 367
 368 (assert (string= (format nil "~g" 1e0) "1.    "))
 369 (assert (string= (format nil "~g" 1.2d40) "12000000000000000000000000000000000000000.    "))
 370
 371 (assert (string= (format nil "~e" 0) "0.0e+0"))
 372 (assert (string= (format nil "~e" 0d0) "0.0d+0"))
 373 (assert (string= (format nil "~9,,4e" 0d0) "0.0d+0000"))
 374
 375 (let ((table (make-hash-table)))
 376   (setf (gethash 1 table) t)
 377   (assert
 378    (raises-error? (with-standard-io-syntax
 379                     (let ((*read-eval* nil)
 380                           (*print-readably* t))
 381                       (with-output-to-string (*standard-output*)
 382                         (prin1 table))))
 383                   print-not-readable)))
 384
 385 ;; Test that we can print characters readably regardless of the external format
 386 ;; of the stream.
 387
 388 (defun test-readable-character (character external-format)
 389   (let ((file "print.impure.tmp"))
 390     (unwind-protect
 391          (progn
 392            (with-open-file (stream file
 393                                    :direction :output
 394                                    :external-format external-format
 395                                    :if-exists :supersede)
 396              (write character :stream stream :readably t))
 397            (with-open-file (stream file
 398                                    :direction :input
 399                                    :external-format external-format
 400                                    :if-does-not-exist :error)
 401              (assert (char= (read stream) character))))
 402       (ignore-errors
 403         (delete-file file)))))
 404
 405 #+sb-unicode
 406 (with-test (:name (:print-readable :character :utf-8))
 407   (test-readable-character (code-char #xfffe) :utf-8))
 408
 409 #+sb-unicode
 410 (with-test (:name (:print-readable :character :iso-8859-1))
 411   (test-readable-character (code-char #xfffe) :iso-8859-1))
 412
 413 (assert (string= (eval '(format nil "~:C" #\a)) "a"))
 414 (assert (string= (format nil (formatter "~:C") #\a) "a"))
 415
 416 ;;; This used to trigger an AVER instead.
 417 (assert (raises-error? (format t "~>") sb-format:format-error))
 418
 419 ;;; readably printing hash-tables, check for circularity
 420 (let ((x (cons 1 2))
 421       (h (make-hash-table))
 422       (*print-readably* t)
 423       (*print-circle* t)
 424       (*read-eval* t))
 425   (setf (gethash x h) h)
 426   (destructuring-bind (x2 . h2) (read-from-string (write-to-string (cons x h)))
 427     (assert (equal x x2))
 428     (assert (eq h2 (gethash x2 h2)))))
 429
 430 ;;; an off-by-one error in the ~R format directive until 1.0.15.20
 431 ;;; prevented printing cardinals and ordinals between (expt 10 63) and
 432 ;;; (1- (expt 10 66))
 433 (assert (string= (format nil "~R" (expt 10 63)) "one vigintillion"))
 434 (assert (string= (format nil "~:R" (expt 10 63)) "one vigintillionth"))
 435
 436 ;;; too-clever cacheing for PRINT-OBJECT resulted in a bogus method
 437 ;;; for printing RESTART objects.  Check also CONTROL-STACK-EXHAUSTED
 438 ;;; and HEAP-EXHAUSTED-ERROR.
 439 (let ((result (with-output-to-string (*standard-output*)
 440                 (princ (find-restart 'abort)))))
 441   (assert (string/= result "#<" :end1 2)))
 442 (let ((result (with-output-to-string (*standard-output*)
 443                 (princ (make-condition 'sb-kernel::control-stack-exhausted)))))
 444   (assert (string/= result "#<" :end1 2)))
 445 (let ((result (with-output-to-string (*standard-output*)
 446                 (princ (make-condition 'sb-kernel::heap-exhausted-error)))))
 447   (assert (string/= result "#<" :end1 2)))
 448
 449 ;;; success