tests/octets.pure.lisp

   1 ;;;; tests of octet/character machinery with no side effects
   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 (cl:in-package :cl-user)
  15
  16 (locally
  17     (declare (optimize debug (speed 0)))
  18
  19 (labels ((ub8 (len-or-seq)
  20            (if (numberp len-or-seq)
  21                (make-array len-or-seq :element-type '(unsigned-byte 8) :initial-element 0)
  22                (coerce len-or-seq '(simple-array (unsigned-byte 8) (*)))))
  23
  24          (ensure-roundtrip-ascii ()
  25            (let ((octets (ub8 128)))
  26              (dotimes (i 128)
  27                (setf (aref octets i) i))
  28              (let* ((str (octets-to-string octets :external-format :ascii))
  29                     (oct2 (string-to-octets str :external-format :ascii)))
  30                (assert (= (length octets) (length oct2)))
  31                (assert (every #'= octets oct2))))
  32            t)
  33
  34          (ensure-roundtrip-latin (format)
  35            (let ((octets (ub8 256)))
  36              (dotimes (i 256)
  37                (setf (aref octets i) i))
  38              (let* ((str (octets-to-string octets :external-format format))
  39                     (oct2 (string-to-octets str :external-format format)))
  40                (assert (= (length octets) (length oct2)))
  41                (assert (every #'= octets oct2))))
  42            t)
  43
  44          (ensure-roundtrip-latin1 ()
  45            (ensure-roundtrip-latin :latin1))
  46
  47          #+sb-unicode
  48          (ensure-roundtrip-latin9 ()
  49            (ensure-roundtrip-latin :latin9))
  50
  51          (ensure-roundtrip-utf8 ()
  52            (let ((string (make-string char-code-limit)))
  53              (dotimes (i char-code-limit)
  54                (unless (<= #xd800 i #xdfff)
  55                  (setf (char string i) (code-char i))))
  56              (let ((string2
  57                     (octets-to-string (string-to-octets string :external-format :utf8)
  58                                       :external-format :utf8)))
  59                (assert (= (length string2) (length string)))
  60                (assert (string= string string2))))
  61            t)
  62
  63          (utf8-decode-test (octets expected-results expected-errors)
  64            (let ((error-count 0))
  65              (handler-bind ((sb-int:character-decoding-error
  66                              (lambda (c)
  67                                (incf error-count)
  68                                (use-value "?" c))))
  69                (assert (string= expected-results
  70                                 (octets-to-string (ub8 octets)
  71                                                   :external-format :utf-8)))
  72                (assert (= error-count expected-errors)))))
  73
  74          (utf8-decode-tests (octets expected-results)
  75            (let ((expected-errors (count #\? expected-results)))
  76              (utf8-decode-test octets expected-results expected-errors)
  77              (utf8-decode-test (concatenate 'vector
  78                                             '(34)
  79                                             octets
  80                                             '(34))
  81                                (format nil "\"~A\"" expected-results)
  82                                expected-errors))))
  83
  84   (ensure-roundtrip-ascii)
  85   (ensure-roundtrip-latin1)
  86   #+sb-unicode
  87   (progn
  88     (ensure-roundtrip-latin9)
  89     ;; Latin-9 chars; the previous test checked roundtrip from
  90     ;; octets->char and back, now test that the latin-9 characters did
  91     ;; in fact appear during that trip.
  92     (let ((l9c (map 'string #'code-char '(8364 352 353 381 382 338 339 376))))
  93       (assert
  94        (string= (octets-to-string (string-to-octets l9c :external-format :latin9)
  95                                   :external-format :latin9)
  96                 l9c))))
  97   (ensure-roundtrip-utf8)
  98
  99   (with-test (:name (:ascii :decoding-error use-value))
 100     (let ((non-ascii-bytes (make-array 128
 101                                        :element-type '(unsigned-byte 8)
 102                                        :initial-contents (loop for i from 128 below 256 collect i)))
 103         (error-count 0))
 104       (handler-bind ((sb-int:character-decoding-error
 105                       (lambda (c)
 106                         (incf error-count)
 107                         (use-value "??" c))))
 108         (assert (string= (octets-to-string non-ascii-bytes :external-format :ascii)
 109                          (make-string 256 :initial-element #\?)))
 110         (assert (= error-count 128)))))
 111   (with-test (:name (:ascii :encoding-error use-value))
 112     (let ((non-ascii-chars (make-array 128
 113                                        :element-type 'character
 114                                        :initial-contents (loop for i from 128 below 256 collect (code-char i))))
 115           (error-count 0))
 116       (handler-bind ((sb-int:character-encoding-error
 117                       (lambda (c)
 118                         (incf error-count)
 119                         (use-value "??" c))))
 120         (assert (equalp (string-to-octets non-ascii-chars :external-format :ascii)
 121                         (make-array 256 :initial-element (char-code #\?))))
 122         (assert (= error-count 128)))))
 123
 124   ;; From Markus Kuhn's UTF-8 test file:
 125   ;; http://www.cl.cam.ac.uk/~mgk25/ucs/examples/UTF-8-test.txt
 126
 127   ;; Too-big characters
 128   #-sb-unicode
 129   (progn
 130     (utf8-decode-tests #(#xc4 #x80) "?") ; #x100
 131     (utf8-decode-tests #(#xdf #xbf) "?") ; #x7ff
 132     (utf8-decode-tests #(#xe0 #xa0 #x80) "?") ; #x800
 133     (utf8-decode-tests #(#xef #xbf #xbf) "?") ; #xffff
 134     (utf8-decode-tests #(#xf0 #x90 #x80 #x80) "?")) ; #x10000
 135   #+nil ; old, 6-byte UTF-8 definition
 136   (progn
 137     (utf8-decode-tests #(#xf4 #x90 #x80 #x80) "?") ; #x110000
 138     (utf8-decode-tests #(#xf7 #xbf #xbf #xbf) "?") ; #x1fffff
 139     (utf8-decode-tests #(#xf8 #x88 #x80 #x80 #x80) "?") ; #x200000
 140     (utf8-decode-tests #(#xfb #xbf #xbf #xbf #xbf) "?") ; #x3ffffff
 141     (utf8-decode-tests #(#xfc #x84 #x80 #x80 #x80 #x80) "?") ; #x4000000
 142     (utf8-decode-tests #(#xfd #xbf #xbf #xbf #xbf #xbf) "?")) ; #x7fffffff
 143   (progn ; new, 4-byte (maximum #x10ffff) UTF-8 definition
 144     (utf8-decode-tests #(#xf4 #x90) "??") ; #x110000
 145     (utf8-decode-tests #(#xf7 #xbf #xbf #xbf) "????") ; #x1fffff
 146     (utf8-decode-tests #(#xf8 #x88 #x80 #x80 #x80) "?????") ; #x200000
 147     (utf8-decode-tests #(#xfb #xbf #xbf #xbf #xbf) "?????") ; #x3ffffff
 148     (utf8-decode-tests #(#xfc #x84 #x80 #x80 #x80 #x80) "??????") ; #x4000000
 149     (utf8-decode-tests #(#xfd #xbf #xbf #xbf #xbf #xbf) "??????")) ; #x7fffffff
 150
 151   ;; Unexpected continuation bytes
 152   (utf8-decode-tests #(#x80) "?")
 153   (utf8-decode-tests #(#xbf) "?")
 154   (utf8-decode-tests #(#x80 #xbf) "??")
 155   (utf8-decode-tests #(#x80 #xbf #x80) "???")
 156   (utf8-decode-tests #(#x80 #xbf #x80 #xbf) "????")
 157   (utf8-decode-tests #(#x80 #xbf #x80 #xbf #x80) "?????")
 158   (utf8-decode-tests #(#x80 #xbf #x80 #xbf #x80 #xbf) "??????")
 159   (utf8-decode-tests #(#x80 #xbf #x80 #xbf #x80 #xbf #x80) "???????")
 160
 161   ;; All 64 continuation bytes in a row
 162   (apply #'utf8-decode-tests
 163          (loop for i from #x80 to #xbf
 164                collect i into bytes
 165                collect #\? into chars
 166                finally (return (list bytes
 167                                      (coerce chars 'string)))))
 168
 169   ;; Lonely start characters
 170   (flet ((lsc (first last)
 171            (apply #'utf8-decode-tests
 172                   (loop for i from first to last
 173                         nconc (list i 32) into bytes
 174                         nconc (list #\? #\Space) into chars
 175                         finally (return (list bytes
 176                                               (coerce chars 'string)))))
 177            (apply #'utf8-decode-tests
 178                   (loop for i from first to last
 179                         collect i into bytes
 180                         collect #\? into chars
 181                         finally (return (list bytes
 182                                               (coerce chars 'string)))))))
 183     (lsc #xc0 #xdf) ; 2-byte sequence start chars
 184     (lsc #xe0 #xef) ; 3-byte
 185     (lsc #xf0 #xf7) ; 4-byte
 186     (lsc #xf8 #xfb) ; 5-byte
 187     (lsc #xfc #xfd)) ; 6-byte
 188
 189   ;; Otherwise incomplete sequences (last continuation byte missing)
 190   (utf8-decode-tests #0=#(#xc0) "?")
 191   (utf8-decode-tests #1=#(#xe0 #xa0) "?")
 192   (utf8-decode-tests #2=#(#xf0 #x90 #x80) "?")
 193   #+nil
 194   (utf8-decode-tests #3=#(#xf8 #x80 #x80 #x80) "?")
 195   #+nil
 196   (utf8-decode-tests #4=#(#xfc #x80 #x80 #x80 #x80) "?")
 197   (utf8-decode-tests #5=#(#xdf) "?")
 198   (utf8-decode-tests #6=#(#xef #xbf) "?")
 199   #+nil
 200   (utf8-decode-tests #7=#(#xf7 #xbf #xbf) "?")
 201   #+nil
 202   (utf8-decode-tests #8=#(#xfb #xbf #xbf #xbf) "?")
 203   #+nil
 204   (utf8-decode-tests #9=#(#xfd #xbf #xbf #xbf #xbf) "?")
 205
 206   ;; All ten previous tests concatenated
 207   (utf8-decode-tests (concatenate 'vector #0# #1# #2# #5# #6#)
 208                      "?????")
 209
 210   ;; Random impossible bytes
 211   (utf8-decode-tests #(#xfe) "?")
 212   (utf8-decode-tests #(#xff) "?")
 213   (utf8-decode-tests #(#xfe #xfe #xff #xff) "????")
 214
 215   ;; Overlong sequences - /
 216   (utf8-decode-tests #(#xc0 #xaf) "??")
 217   (utf8-decode-tests #(#xe0 #x80 #xaf) "???")
 218   (utf8-decode-tests #(#xf0 #x80 #x80 #xaf) "????")
 219   (utf8-decode-tests #(#xf8 #x80 #x80 #x80 #xaf) "?????")
 220   (utf8-decode-tests #(#xfc #x80 #x80 #x80 #x80 #xaf) "??????")
 221
 222   ;; Overlong sequences - #\Rubout
 223   (utf8-decode-tests #(#xc1 #xbf) "??")
 224   (utf8-decode-tests #(#xe0 #x9f #xbf) "???")
 225   (utf8-decode-tests #(#xf0 #x8f #xbf #xbf) "????")
 226   (utf8-decode-tests #(#xf8 #x87 #xbf #xbf #xbf) "?????")
 227   (utf8-decode-tests #(#xfc #x83 #xbf #xbf #xbf #xbf) "??????")
 228
 229   ;; Overlong sequences - #\Null
 230   (utf8-decode-tests #(#xc0 #x80) "??")
 231   (utf8-decode-tests #(#xe0 #x80 #x80) "???")
 232   (utf8-decode-tests #(#xf0 #x80 #x80 #x80) "????")
 233   (utf8-decode-tests #(#xf8 #x80 #x80 #x80 #x80) "?????")
 234   (utf8-decode-tests #(#xfc #x80 #x80 #x80 #x80 #x80) "??????")
 235
 236   ;; Not testing surrogates & characters #xFFFE, #xFFFF; they're
 237   ;; perfectly good sbcl chars even if they're not actually ISO 10646
 238   ;; characters, and it's probably a good idea for s-to-o and o-to-s
 239   ;; to be inverses of each other as far as possible.
 240   )
 241
 242 )
 243
 244 ;;; regression test: STRING->UTF8 didn't properly handle a non-zero
 245 ;;; START argument.
 246 (assert (equalp #(50) (string-to-octets "42" :start 1 :external-format :utf-8)))
 247
 248 ;;; STRING->UTF8 should cope with NIL strings if a null range is required
 249 (assert (equalp #() (string-to-octets "" :external-format :utf-8)))
 250 (assert (equalp #() (string-to-octets (make-array 0 :element-type nil)
 251                                       :external-format :utf-8)))
 252 (assert (equalp #() (string-to-octets (make-array 5 :element-type nil)
 253                                       :start 3 :end 3 :external-format :utf-8)))
 254 (assert (equalp #(0) (string-to-octets (make-array 5 :element-type nil)
 255                                        :start 3 :end 3 :null-terminate t
 256                                        :external-format :utf-8)))
 257
 258 ;;; whoops: the iso-8859-2 format referred to an undefined symbol.
 259 #+sb-unicode
 260 (assert (equalp #(251) (string-to-octets (string (code-char 369))
 261                                          :external-format :latin-2)))
 262
 263 (with-test (:name (:euc-jp :decoding-errors) :skipped-on '(not :sb-unicode))
 264   (handler-bind ((sb-int:character-decoding-error
 265                   (lambda (c) (use-value #\? c))))
 266     (assert (string= "?{?"
 267                      (octets-to-string
 268                       (coerce #(182 123 253 238) '(vector (unsigned-byte 8)))
 269                       :external-format :euc-jp)))))
 270
 271 (with-test (:name (:utf-8 :surrogates :encoding-errors) :skipped-on '(not :sb-unicode))
 272   (handler-bind ((sb-int:character-encoding-error
 273                   (lambda (c) (use-value #\? c))))
 274     (assert (equalp (string-to-octets (string (code-char #xd800))
 275                                       :external-format :utf-8)
 276                     (vector (char-code #\?))))))
 277 (with-test (:name (:utf-8 :surrogates :decoding-errors) :skipped-on '(not :sb-unicode))
 278   (handler-bind ((sb-int:character-decoding-error
 279                   (lambda (c) (use-value #\? c))))
 280     (assert (find #\? (octets-to-string
 281                        (coerce #(237 160 128) '(vector (unsigned-byte 8)))
 282                        :external-format :utf-8)))))
 283
 284 (with-test (:name (:ucs-2 :out-of-range :encoding-errors) :skipped-on '(not :sb-unicode))
 285   (handler-bind ((sb-int:character-encoding-error
 286                   (lambda (c) (use-value "???" c))))
 287     (assert (equalp (string-to-octets (string (code-char #x10001))
 288                                       :external-format :ucs-2le)
 289                     #(63 0 63 0 63 0))))
 290   (handler-bind ((sb-int:character-encoding-error
 291                   (lambda (c) (use-value "???" c))))
 292     (assert (equalp (string-to-octets (string (code-char #x10001))
 293                                       :external-format :ucs-2be)
 294                     #(0 63 0 63 0 63)))))
 295
 296 (with-test (:name (:ucs-4 :out-of-range :decoding-errors) :skipped-on '(not :sb-unicode))
 297   (handler-bind ((sb-int:character-decoding-error
 298                   (lambda (c) (use-value "???" c))))
 299     (assert (equalp (octets-to-string (coerce '(1 2 3 4) '(vector (unsigned-byte 8)))
 300                                       :external-format :ucs-4le)
 301                     "???")))
 302   (assert (equalp (octets-to-string (coerce '(#xff #xff #x10 #x00) '(vector (unsigned-byte 8)))
 303                                     :external-format :ucs-4le)
 304                   (string (code-char #x10ffff))))
 305   (handler-bind ((sb-int:character-decoding-error
 306                   (lambda (c) (use-value "???" c))))
 307     (assert (equalp (octets-to-string (coerce '(1 2 3 4) '(vector (unsigned-byte 8)))
 308                                       :external-format :ucs-4be)
 309                     "???"))
 310     (assert (equalp (octets-to-string (coerce '(#x00 #x10 #xff #xff) '(vector (unsigned-byte 8)))
 311                                       :external-format :ucs-4be)
 312                     (string (code-char #x10ffff))))))
 313
 314 (with-test (:name (:utf-16le :ensure-roundtrip) :skipped-on '(not :sb-unicode))
 315   (flet ((enc (x)
 316            (string-to-octets x :external-format :utf-16le))
 317          (dec (x)
 318            (octets-to-string (coerce x '(vector (unsigned-byte 8)))
 319                              :external-format :utf-16le)))
 320     (let ((string (map 'string 'code-char
 321                        '(#x20 #x200 #x2000 #x10000 #x10401 #x10fffd)))
 322           (octets #(#x20 0 0 #x2 0 #x20 0 #xd8 0 #xdc 1 #xd8 1 #xdc #xff #xdb #xfd #xdf)))
 323       (assert (equalp (enc string) octets))
 324       (assert (equalp (dec octets) string)))))
 325
 326 (with-test (:name (:utf-16le :encoding-error) :skipped-on '(not :sb-unicode))
 327   (flet ((enc (x)
 328            (string-to-octets x :external-format '(:utf-16le :replacement #\?)))
 329          (dec (x)
 330            (octets-to-string (coerce x '(vector (unsigned-byte 8)))
 331                              :external-format :utf-16le)))
 332     (let ((string (map 'string 'code-char '(#xd800 #xdc00 #xfffe #x10ffff))))
 333       (assert (equalp (enc string) #(63 0 63 0 63 0 63 0))))))
 334
 335 (with-test (:name (:utf-16be :ensure-roundtrip) :skipped-on '(not :sb-unicode))
 336   (flet ((enc (x)
 337            (string-to-octets x :external-format :utf-16be))
 338          (dec (x)
 339            (octets-to-string (coerce x '(vector (unsigned-byte 8)))
 340                              :external-format :utf-16be)))
 341     (let ((string (map 'string 'code-char
 342                        '(#x20 #x200 #x2000 #x10000 #x10401 #x10fffd)))
 343           (octets #(0 #x20 #x2 0 #x20 0 #xd8 0 #xdc 0 #xd8 1 #xdc 1 #xdb #xff #xdf #xfd)))
 344       (assert (equalp (enc string) octets))
 345       (assert (equalp (dec octets) string)))))
 346
 347 (with-test (:name (:utf-16be :encoding-error) :skipped-on '(not :sb-unicode))
 348   (flet ((enc (x)
 349            (string-to-octets x :external-format '(:utf-16be :replacement #\?)))
 350          (dec (x)
 351            (octets-to-string (coerce x '(vector (unsigned-byte 8)))
 352                              :external-format :utf-16be)))
 353     (let ((string (map 'string 'code-char '(#xd800 #xdc00 #xfffe #x10ffff))))
 354       (assert (equalp (enc string) #(0 63 0 63 0 63 0 63))))))
 355
 356
 357 (with-test (:name (:utf-32le :ensure-roundtrip) :skipped-on '(not :sb-unicode))
 358   (flet ((enc (x)
 359            (string-to-octets x :external-format :utf-32le))
 360          (dec (x)
 361            (octets-to-string (coerce x '(vector (unsigned-byte 8)))
 362                              :external-format :utf-32le)))
 363     (let ((string (map 'string 'code-char
 364                        '(#x20 #x200 #x2000 #x10000 #x10401 #x10fffd)))
 365           (octets #(#x20 0 0 0 0 #x2 0 0 0 #x20 0 0 0 0 1 0 1 4 1 0 #xfd #xff #x10 0)))
 366       (assert (equalp (enc string) octets))
 367       (assert (equalp (dec octets) string)))))
 368
 369 (with-test (:name (:utf-32le :encoding-error) :skipped-on '(not :sb-unicode))
 370   (flet ((enc (x)
 371            (string-to-octets x :external-format '(:utf-32le :replacement #\?)))
 372          (dec (x)
 373            (octets-to-string (coerce x '(vector (unsigned-byte 8)))
 374                              :external-format :utf-32le)))
 375     (let ((string (map 'string 'code-char '(#xd800 #xdc00 #xfffe #x10ffff))))
 376       (assert (equalp (enc string) #(63 0 0 0 63 0 0 0 63 0 0 0 63 0 0 0))))))
 377
 378
 379 (with-test (:name (:utf-32be :ensure-roundtrip) :skipped-on '(not :sb-unicode))
 380   (flet ((enc (x)
 381            (string-to-octets x :external-format :utf-32be))
 382          (dec (x)
 383            (octets-to-string (coerce x '(vector (unsigned-byte 8)))
 384                              :external-format :utf-32be)))
 385     (let ((string (map 'string 'code-char
 386                        '(#x20 #x200 #x2000 #x10000 #x10401 #x10fffd)))
 387           (octets #(0 0 0 #x20 0 0 #x2 0 0 0 #x20 0 0 1 0 0 0 1 4 1 0 #x10 #xff #xfd)))
 388       (assert (equalp (enc string) octets))
 389       (assert (equalp (dec octets) string)))))
 390
 391 (with-test (:name (:utf-32be :encoding-error) :skipped-on '(not :sb-unicode))
 392   (flet ((enc (x)
 393            (string-to-octets x :external-format '(:utf-32be :replacement #\?)))
 394          (dec (x)
 395            (octets-to-string (coerce x '(vector (unsigned-byte 8)))
 396                              :external-format :utf-32be)))
 397     (let ((string (map 'string 'code-char '(#xd800 #xdc00 #xfffe #x10ffff))))
 398       (assert (equalp (enc string) #(0 0 0 63 0 0 0 63 0 0 0 63 0 0 0 63))))))
 399
 400 (with-test (:name :compile-file-position-with-encodings
 401             :skipped-on '(not :sb-unicode))
 402   (with-open-file (f1 "data/compile-file-pos.lisp" :external-format :utf-8)
 403     (with-open-file (f2 "data/compile-file-pos-utf16be.lisp"
 404                         :external-format :utf-16be)
 405       (dotimes (i 3) ; skip three lines
 406         ;; because a comment line differs, and the function names differ
 407         (read-line f1)
 408         (read-line f2))
 409       (dotimes (i 3) ; compare three lines
 410         (assert (string= (read-line f1) (read-line f2))))))
 411   (flet ((compile-and-load (file encoding main-fun)
 412            (let ((fasl (compile-file file
 413                                      :external-format encoding
 414                                      :print nil :verbose nil)))
 415              (load fasl)
 416              (delete-file fasl)
 417              (funcall main-fun))))
 418     (multiple-value-bind (a1 b1 c1)
 419         (compile-and-load "data/compile-file-pos.lisp" :utf-8 'cfp-foolz1)
 420       (multiple-value-bind (a2 b2 c2)
 421           (compile-and-load "data/compile-file-pos-utf16be.lisp" :utf-16be
 422                             'cfp-foolz2)
 423         (assert (string= a1 a2))
 424         (assert (string= b1 b2))
 425         ;; COMPILE-FILE-POSITION is insensitive to file encoding.
 426         (assert (string= c1 c2))))))