tests/pprint.impure.lisp

   1 ;;;; test of the pretty-printer
   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 (in-package :cl-user)
  15
  16 ;;;; Assert that entries inserted into a dispatch table with equal priority
  17 ;;;; are order-preserving - unless they are of the form (CONS (EQL x)).
  18 ;;;; This is not a requirement in general, but is quite reasonable.
  19 (with-test (:name :pprint-dispatch-order-preserving)
  20   (let ((tbl (sb-pretty::make-pprint-dispatch-table)))
  21     (handler-bind ((warning #'muffle-warning)) ; nonexistent types
  22       (set-pprint-dispatch 'foo1 #'pprint-fill 5 tbl)
  23       (set-pprint-dispatch 'fool #'pprint-fill 0 tbl)
  24       (set-pprint-dispatch 'foo2 #'pprint-fill 5 tbl))
  25     (let ((entries (sb-pretty::pprint-dispatch-table-entries tbl)))
  26       (assert (equal (mapcar #'sb-pretty::pprint-dispatch-entry-type entries)
  27                      '(foo1 foo2 fool))))))
  28
  29 ;;;; tests for former BUG 99, where pretty-printing was pretty messed
  30 ;;;; up, e.g. PPRINT-LOGICAL-BLOCK - because of CHECK-FOR-CIRCULARITY
  31 ;;;; - didn't really work:
  32 ;;;;   "DESCRIBE interacts poorly with *PRINT-CIRCLE*, e.g. the output from
  33 ;;;;    (let ((*print-circle* t)) (describe (make-hash-table)))
  34 ;;;;  is weird, [...] #<HASH-TABLE :TEST EQL :COUNT 0 {90BBFC5}> is an . (EQL)
  35 ;;;; ..."
  36 ;;;; So, this was mainly a pretty printing problem.
  37
  38 ;;; Create a circular list.
  39 (eval-when (:compile-toplevel :load-toplevel :execute)
  40   (defparameter *circ-list* '(1 1))
  41   (prog1 nil
  42     (setf (cdr *circ-list*) *circ-list*)))
  43
  44 ;;; I think this test is bogus. PPRINT-LOGICAL-BLOCK needs to print
  45 ;;; the #1= and mark *CIRC-LIST* as having been printed for the first
  46 ;;; time. After that any attempt to print *CIRC-LIST* must result in
  47 ;;; in a #1# being printed. Thus the right output is (for once)
  48 ;;; #1=#1#. -- JES, 2005-06-05
  49 #+nil
  50 ;;; circular lists are still being printed correctly?
  51 (assert (equal
  52          (with-output-to-string (*standard-output*)
  53            (let ((*print-circle* t))
  54              (pprint-logical-block (*standard-output* *circ-list*)
  55                                  (format *standard-output* "~S" *circ-list*))))
  56          "#1=(1 . #1#)"))
  57
  58 ;;; test from CLHS
  59 (with-test (:name :pprint-clhs-example)
  60   (assert (equal
  61            (with-output-to-string (*standard-output*)
  62              (let ((a (list 1 2 3)))
  63                (setf (cdddr a) a)
  64                (let ((*print-circle* t))
  65                  (write a :stream *standard-output*))
  66                :done))
  67            "#1=(1 2 3 . #1#)")))
  68
  69 (with-test (:name (:pprint :bug-99))
  70   (assert (equal
  71            (with-output-to-string (*standard-output*)
  72              (let* ((*print-circle* t))
  73                (format *standard-output* "~@<~S ~_is ~S. This was not seen!~:>"
  74                        'eql 'eql)))
  75            "EQL is EQL. This was not seen!"))
  76
  77   (assert (equal
  78            (with-output-to-string (*standard-output*)
  79              (let* ((*print-circle* t))
  80                (format *standard-output*
  81                        "~@<~S ~_is ~S and ~S. This was not seen!~:>"
  82                        'eql 'eql 'eql)))
  83            "EQL is EQL and EQL. This was not seen!")))
  84
  85 ;;; the original test for BUG 99 (only interactive), no obvious
  86 ;;; way to make an automated test:
  87 ;;;  (LET ((*PRINT-CIRCLE* T)) (DESCRIBE (MAKE-HASH-TABLE)))
  88
  89 ;;; bug 263: :PREFIX, :PER-LINE-PREFIX and :SUFFIX arguments of
  90 ;;; PPRINT-LOGICAL-BLOCK may be complex strings
  91 (with-test (:name :pprint-logical-block-arguments-complex-strings)
  92   (let ((list '(1 2 3))
  93         (prefix (make-array 2
  94                             :element-type 'character
  95                             :displaced-to ";x"
  96                             :fill-pointer 1))
  97         (suffix (make-array 2
  98                             :element-type 'character
  99                             :displaced-to ">xy"
 100                             :displaced-index-offset 1
 101                             :fill-pointer 1)))
 102     (assert (equal (with-output-to-string (s)
 103                      (pprint-logical-block (s list
 104                                               :per-line-prefix prefix
 105                                               :suffix suffix)
 106                        (format s "~{~W~^~:@_~}" list)))
 107                    (format nil ";1~%~
 108                               ;2~%~
 109                               ;3x")))))
 110
 111 ;;; bug 141b: not enough care taken to disambiguate ,.FOO and ,@FOO
 112 ;;; from , .FOO and , @FOO
 113 (with-test (:name :pprint-backquote-magic)
 114   (assert (equal
 115            (with-output-to-string (s)
 116              (write '`(,  .foo) :stream s :pretty t :readably t))
 117            "`(, .FOO)"))
 118   (assert (equal
 119            (with-output-to-string (s)
 120              (write '`(,  @foo) :stream s :pretty t :readably t))
 121            "`(, @FOO)"))
 122   (assert (equal
 123            (with-output-to-string (s)
 124              (write '`(,  ?foo) :stream s :pretty t :readably t))
 125            "`(,?FOO)")))
 126
 127 ;;; bug reported by Paul Dietz on sbcl-devel: unquoted lambda lists
 128 ;;; were leaking the SB-IMPL::BACKQ-COMMA implementation.
 129 (with-test (:name :pprint-leaking-backq-comma)
 130   (assert (equal
 131            (with-output-to-string (s)
 132              (write '`(foo ,x) :stream s :pretty t :readably t))
 133            "`(FOO ,X)"))
 134   (assert (equal
 135            (with-output-to-string (s)
 136              (write '`(foo ,@x) :stream s :pretty t :readably t))
 137            "`(FOO ,@X)"))
 138   (assert (equal
 139            (with-output-to-string (s)
 140              (write '`(foo ,.x) :stream s :pretty t :readably t))
 141            "`(FOO ,.X)"))
 142   (assert (equal
 143            (with-output-to-string (s)
 144              (write '`(lambda ,x) :stream s :pretty t :readably t))
 145            "`(LAMBDA ,X)"))
 146   (assert (equal
 147            (with-output-to-string (s)
 148              (write '`(lambda ,@x) :stream s :pretty t :readably t))
 149            "`(LAMBDA ,@X)"))
 150   (assert (equal
 151            (with-output-to-string (s)
 152              (write '`(lambda ,.x) :stream s :pretty t :readably t))
 153            "`(LAMBDA ,.X)"))
 154   (assert (equal
 155            (with-output-to-string (s)
 156              (write '`(lambda (,x)) :stream s :pretty t :readably t))
 157            "`(LAMBDA (,X))")))
 158
 159 (defun unwhitespaceify (string)
 160   (let ((string (substitute #\Space #\Newline string)))
 161     ;; highly inefficient. this is not how you'd do this in real life.
 162     (loop (let ((p (search "  " string)))
 163             (when (not p) (return string))
 164             (setq string
 165                   (concatenate 'string
 166                                (subseq string 0 p)
 167                                (subseq string (1+ p))))))))
 168
 169 ;;; more backquote printing brokenness, fixed quasi-randomly by CSR.
 170 ;;; and fixed a little more by DPK.
 171 (with-test (:name :pprint-more-backquote-brokeness)
 172   (flet ((try (input expect)
 173            (assert (equalp (read-from-string expect) input))
 174            (let ((actual (unwhitespaceify (write-to-string input :pretty t))))
 175              (unless (equal actual expect)
 176              (error "Failed test for ~S. Got ~S~%"
 177                     expect actual)))))
 178     (try '``(foo ,@',@bar) "``(FOO ,@',@BAR)")
 179     (try '``(,,foo ,',foo foo) "``(,,FOO ,',FOO FOO)")
 180     (try '``(((,,foo) ,',foo) foo) "``(((,,FOO) ,',FOO) FOO)")
 181     (try '`#() "`#()")
 182     (try '`#(,bar) "`#(,BAR)")
 183     (try '`#(,(bar)) "`#(,(BAR))")
 184     (try '`#(,@bar) "`#(,@BAR)")
 185     (try '`#(,@(bar)) "`#(,@(BAR))")
 186     (try '`#(a ,b c) "`#(A ,B C)")
 187     (try '`#(,@A ,b c) "`#(,@A ,B C)")
 188     (try '`(,a . #(foo #() #(,bar) ,bar)) "`(,A . #(FOO #() #(,BAR) ,BAR))")
 189     (try '(let ((foo (x))) `(let (,foo) (setq ,foo (y)) (baz ,foo)))
 190            "(LET ((FOO (X))) `(LET (,FOO) (SETQ ,FOO (Y)) (BAZ ,FOO)))")
 191     (try '(let `((,a ,b)) :forms) "(LET `((,A ,B)) :FORMS)")
 192     (try '(lambda `(,x ,y) :forms) "(LAMBDA `(,X ,Y) :FORMS)")
 193     (try '(defun f `(,x ,y) :forms) "(DEFUN F `(,X ,Y) :FORMS)")))
 194
 195 \f
 196 ;;; SET-PPRINT-DISPATCH should accept function name arguments, and not
 197 ;;; rush to coerce them to functions.
 198 (set-pprint-dispatch '(cons (eql frob)) 'ppd-function-name)
 199 (defun ppd-function-name (s o)
 200   (print (length o) s))
 201
 202 (with-test (:name (:set-pprint-dispatch :no-function-coerce)))
 203 (let ((s (with-output-to-string (s)
 204            (pprint '(frob a b) s))))
 205   (assert (position #\3 s)))
 206 \f
 207 ;; Test that circularity detection works with pprint-logical-block
 208 ;; (including when called through pprint-dispatch).
 209 (with-test (:name :pprint-circular-detection)
 210   (let ((*print-pretty* t)
 211         (*print-circle* t)
 212         (*print-pprint-dispatch* (copy-pprint-dispatch)))
 213     (labels ((pprint-a (stream form &rest rest)
 214                (declare (ignore rest))
 215                (pprint-logical-block (stream form :prefix "<" :suffix ">")
 216                  (pprint-exit-if-list-exhausted)
 217                  (loop
 218                    (write (pprint-pop) :stream stream)
 219                    (pprint-exit-if-list-exhausted)
 220                    (write-char #\space stream)))))
 221       (set-pprint-dispatch '(cons (eql a)) #'pprint-a)
 222       (assert (string= "<A 1 2 3>"
 223                        (with-output-to-string (s)
 224                          (write '(a 1 2 3) :stream s))))
 225       (assert (string= "#1=<A 1 #1# #2=#(2) #2#>"
 226                        (with-output-to-string (s)
 227                          (write '#2=(a 1 #2# #5=#(2) #5#) :stream s))))
 228       (assert (string= "#1=(B #2=<A 1 #1# 2 3> #2#)"
 229                        (with-output-to-string (s)
 230                          (write '#3=(b #4=(a 1 #3# 2 3) #4#) :stream s)))))))
 231
 232 ;; Test that a circular improper list inside a logical block works.
 233 (with-test (:name :pprint-circular-improper-lists-inside-logical-blocks)
 234   (let ((*print-circle* t)
 235         (*print-pretty* t))
 236     (assert (string= "#1=(#2=(#2# . #3=(#1# . #3#)))"
 237                      (with-output-to-string (s)
 238                        (write '#1=(#2=(#2# . #3=(#1# . #3#))) :stream s))))))
 239
 240 ;;; Printing malformed defpackage forms without errors.
 241 (with-test (:name :pprint-defpackage)
 242   (let ((*standard-output* (make-broadcast-stream)))
 243     (pprint '(defpackage :foo nil))
 244     (pprint '(defpackage :foo 42))))
 245
 246 (with-test (:name :standard-pprint-dispatch-modified)
 247   (assert
 248    (eq :error
 249        (handler-case (with-standard-io-syntax
 250                        (set-pprint-dispatch 'symbol (constantly nil))
 251                        :no-error)
 252          (sb-int:standard-pprint-dispatch-table-modified-error ()
 253            :error)))))
 254
 255 (defun pprint-to-string (form)
 256   (let ((string (with-output-to-string (s) (pprint form s))))
 257     (assert (eql #\newline (char string 0)))
 258     (subseq string 1)))
 259 (with-test (:name :pprint-defmethod-lambda-list-function)
 260   (assert (equal "(DEFMETHOD FOO ((FUNCTION CONS)) FUNCTION)"
 261                  (pprint-to-string `(defmethod foo ((function cons)) function))))
 262   (assert (equal "(DEFMETHOD FOO :AFTER (FUNCTION CONS) FUNCTION)"
 263                  (pprint-to-string `(defmethod foo :after (function cons) function))))
 264   (assert (equal "(DEFMETHOD FOO :BEFORE ((FUNCTION (EQL #'FOO))) FUNCTION)"
 265                  (pprint-to-string `(DEFMETHOD FOO :BEFORE ((FUNCTION (EQL #'FOO))) FUNCTION)))))
 266
 267 (with-test (:name :pprint-lambda-list-quote)
 268   (assert (equal "(LAMBDA (&KEY (BAR 'BAZ)))"
 269                  (pprint-to-string '(lambda (&key (bar 'baz)))))))
 270
 271 (defclass frob () ())
 272
 273 (defmethod print-object ((obj frob) stream)
 274   (print-unreadable-object (obj stream :type nil :identity nil)
 275     (format stream "FRABOTZICATOR")))
 276
 277 ;;; SBCL < 1.0.38 printed #<\nFRABOTIZICATOR>
 278 (with-test (:name (:pprint-unreadable-object :no-ugliness-when-type=nil))
 279   (assert (equal "#<FRABOTZICATOR>"
 280                  (let ((*print-right-margin* 5)
 281                        (*print-pretty* t))
 282                    (format nil "~@<~S~:>" (make-instance 'frob))))))
 283
 284 (with-test (:name :pprint-logical-block-code-deletion-node
 285                   :skipped-on '(not :stack-allocatable-closures))
 286   (handler-case
 287       (compile nil
 288                `(lambda (words &key a b c)
 289                   (pprint-logical-block (nil words :per-line-prefix (or a b c))
 290                     (pprint-fill *standard-output* (sort (copy-seq words) #'string<) nil))))
 291     ((or sb-ext:compiler-note warning) (c)
 292       (error "~A" c))))
 293
 294 (with-test (:name :pprint-logical-block-multiple-per-line-prefix-eval)
 295   (funcall (compile nil
 296                     `(lambda ()
 297                        (let ((n 0))
 298                          (with-output-to-string (s)
 299                            (pprint-logical-block (s nil :per-line-prefix (if (eql 1 (incf n))
 300                                                                              "; "
 301                                                                              (error "oops")))
 302                              (pprint-newline :mandatory s)
 303                              (pprint-newline :mandatory s)))
 304                          n)))))
 305
 306 (with-test (:name :can-restore-orig-pprint-dispatch-table)
 307   (let* ((orig (pprint-dispatch 'some-symbol))
 308          (alt (lambda (&rest args) (apply orig args))))
 309     (set-pprint-dispatch 'symbol alt)
 310     (assert (eq alt (pprint-dispatch 'some-symbol)))
 311     (setf *print-pprint-dispatch* (copy-pprint-dispatch nil))
 312     (assert (eq orig (pprint-dispatch 'some-symbol)))
 313     (assert (not (eq alt orig)))))
 314
 315 (with-test (:name :pprint-improper-list)
 316   (let* ((max-length 10)
 317          (stream (make-broadcast-stream))
 318          (errors
 319            (loop for symbol being the symbol in :cl
 320                  nconc
 321                  (loop for i from 1 below max-length
 322                        for list = (cons symbol 10) then (cons symbol list)
 323                        when (nth-value 1 (ignore-errors (pprint list stream)))
 324                        collect (format nil "(~{~a ~}~a . 10)" (butlast list) symbol)))))
 325     (when errors
 326       (error "Can't PPRINT improper lists: ~a" errors))))
 327
 328 (with-test (:name :pprint-circular-backq-comma)
 329   ;; LP 1161218 reported by James M. Lawrence
 330   (let ((string (write-to-string '(let ((#1=#:var '(99)))
 331                                    `(progn ,@(identity #1#)))
 332                                  :circle t :pretty t)))
 333     (assert (not (search "#2#" string)))))
 334
 335 (with-test (:name :pprint-dotted-setf)
 336   (let ((*print-pretty* t))
 337     (equal (format nil "~a" '(setf . a))
 338            "(SETF . A)")))
 339
 340 (with-test (:name :literal-fun-nested-lists)
 341   (assert (search "EQUALP" (format nil "~:w" `((((((,#'equalp)))))))
 342                   :test #'char-equal)))
 343
 344 (defvar *a* (make-array 3 :fill-pointer 0))
 345 (with-test (:name :pprint-logical-block-eval-order)
 346   (flet ((vp (x) (vector-push x *a*)))
 347     (pprint-logical-block (nil (progn (vp 1) '(foo))
 348                                :suffix (progn (vp 2) "}")
 349                                :prefix (progn (vp 3) "{"))
 350       (write (pprint-pop))))
 351   (assert (equalp *a* #(1 2 3))))
 352
 353 ;; these warn, but "work" in as much as they don't kill the machinery
 354 (with-test (:name (:pprint-dispatch :set-ppd-unknown-type))
 355   (handler-bind ((warning #'muffle-warning))
 356     (assert-signal
 357      (set-pprint-dispatch 'frood
 358                           (lambda (stream obj)
 359                             (let ((*print-pretty* nil))
 360                               (format stream "[frood: ~D]" obj))))
 361      warning)
 362     ;; We expect multiple warnings since the type specifier references
 363     ;; multiple undefined things.
 364     (assert-signal
 365      (set-pprint-dispatch '(or weasel (and woodle (satisfies thing)))
 366                           (lambda (stream obj)
 367                             (format stream "hi ~A!" (type-of obj))))
 368      warning 2)
 369     (write-to-string (macroexpand '(setf (values a b) (floor x y)))
 370                      :pretty t)
 371     ;; yay, we're not dead
 372     ))
 373
 374 (with-test (:name (:pprint-dispatch :unknown-type-1a))
 375   (assert (string= (write-to-string (list 1 2 3 1006) :pretty t)
 376                    "(1 2 3 1006)")))
 377 (deftype frood () '(integer 1005 1006))
 378 (with-test (:name (:pprint-dispatch :unknown-type-1b))
 379   (assert (string= (write-to-string (list 1 2 3 1006) :pretty t)
 380                    "(1 2 3 [frood: 1006])")))
 381 (defstruct weasel)
 382 (with-test (:name (:pprint-dispatch :unknown-type-2a))
 383   ;; still can't use the dispatch entry because of the OR
 384   ;; even though WEASEL "could have" eagerly returned T.
 385   (assert (string= (write-to-string (make-weasel) :pretty t)
 386                    "#S(WEASEL)")))
 387 (defstruct woodle)
 388 (with-test (:name (:pprint-dispatch :unknown-type-2b))
 389   ;; still no, because #'THING is not boundp
 390   (assert (string= (write-to-string (make-weasel) :pretty t)
 391                    "#S(WEASEL)"))
 392   (defun thing (x) x)
 393   (assert (string= (write-to-string (make-weasel) :pretty t)
 394                    "hi WEASEL!")))
 395 \f
 396 (deftype known-cons ()
 397   '(cons (member known-cons other-known-cons other-other)))
 398 (with-test (:name (:pprint-dispatch :known-cons-type))
 399   (flet ((pprint-known-cons (stream obj)
 400            (format stream "#<KNOWN-CONS ~S>" (cdr obj))))
 401     (set-pprint-dispatch 'known-cons #'pprint-known-cons))
 402   (let ((hashtable (sb-pretty::pprint-dispatch-table-cons-entries
 403                     *print-pprint-dispatch*)))
 404     ;; First ensure that the CONS table was used
 405     (assert (gethash 'known-cons hashtable))
 406     ;; Check that dispatch entries are shared. In practice it is not "useful"
 407     ;; but it is a consequence of the general approach of allowing any MEMBER
 408     ;; type versus disallowing MEMBER types of more than one element.
 409     (assert (eq (gethash 'known-cons hashtable)
 410                 (gethash 'other-known-cons hashtable)))
 411     (assert (eq (gethash 'known-cons hashtable)
 412                 (gethash 'other-other hashtable))))
 413   (assert (string= (write-to-string (cons 'known-cons t) :pretty t)
 414                    "#<KNOWN-CONS T>"))
 415   (assert (string= (write-to-string (cons 'known-cons (cons 'known-cons t)) :pretty t)
 416                    "#<KNOWN-CONS #<KNOWN-CONS T>>")))
 417
 418 ;; force MACDADDY to be a closure over X.
 419 (let ((x 3)) (defmacro macdaddy (a b &body z) a b z `(who-cares ,x)) (incf x))
 420
 421 (with-test (:name :closure-macro-arglist)
 422   ;; assert correct test setup - MACDADDY is a closure if compiling,
 423   ;; or a funcallable-instance if not
 424   (assert (eq (sb-kernel:fun-subtype (macro-function 'macdaddy))
 425               #-interpreter sb-vm:closure-header-widetag
 426               #+interpreter sb-vm:funcallable-instance-header-widetag))
 427   ;; MACRO-INDENTATION used %simple-fun-arglist instead of %fun-arglist.
 428   ;; Depending on your luck it would either not return the right answer,
 429   ;; or crash, depending on what lay at 4 words past the function address.
 430   (assert (= (sb-pretty::macro-indentation 'macdaddy) 2)))
 431
 432 (defmacro try1 (a b &body fool) `(baz ,a ,b ,fool))
 433 (defmacro try2 (a b &optional &body fool) `(baz ,a ,b ,fool))
 434 (defmacro try3 (a b &optional c &body fool) `(baz ,a ,b ,c ,fool))
 435 (defmacro try4 (a b . fool) `(baz ,a ,b ,fool))
 436 (defmacro try5 (a b &optional . fool) `(baz ,a ,b ,fool))
 437 (defmacro try6 (a b &optional c . fool) `(baz ,a ,b ,c ,fool))
 438 (with-test (:name :macro-indentation)
 439   (assert (= (sb-pretty::macro-indentation 'try1) 2))
 440   (assert (= (sb-pretty::macro-indentation 'try2) 2))
 441   (assert (= (sb-pretty::macro-indentation 'try3) 3))
 442   (assert (= (sb-pretty::macro-indentation 'try4) 2))
 443   (assert (= (sb-pretty::macro-indentation 'try5) 2))
 444   (assert (= (sb-pretty::macro-indentation 'try6) 3)))
 445
 446 ;;; success