test-suite/tests/elisp-compiler.test

   1 ;;;; elisp-compiler.test --- Test the compiler for Elisp.
   2 ;;;;
   3 ;;;; Copyright (C) 2009 Free Software Foundation, Inc.
   4 ;;;; Daniel Kraft
   5 ;;;;
   6 ;;;; This library is free software; you can redistribute it and/or
   7 ;;;; modify it under the terms of the GNU Lesser General Public
   8 ;;;; License as published by the Free Software Foundation; either
   9 ;;;; version 3 of the License, or (at your option) any later version.
  10 ;;;;
  11 ;;;; This library is distributed in the hope that it will be useful,
  12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 ;;;; Lesser General Public License for more details.
  15 ;;;;
  16 ;;;; You should have received a copy of the GNU Lesser General Public
  17 ;;;; License along with this library; if not, write to the Free Software
  18 ;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19
  20 (define-module (test-elisp-compiler)
  21   :use-module (test-suite lib)
  22   :use-module (system base compile)
  23   :use-module (language elisp runtime))
  24
  25
  26 ; Macros to handle the compilation conveniently.
  27
  28 (define-syntax compile-test
  29   (syntax-rules (pass-if pass-if-exception)
  30     ((_ (pass-if test-name exp))
  31      (pass-if test-name (compile 'exp #:from 'elisp #:to 'value)))
  32     ((_ (pass-if test-name exp #:opts opts))
  33      (pass-if test-name (compile 'exp #:from 'elisp #:to 'value #:opts opts)))
  34     ((_ (pass-if-equal test-name result exp))
  35      (pass-if test-name (equal? result
  36                                 (compile 'exp #:from 'elisp #:to 'value))))
  37     ((_ (pass-if-exception test-name exc exp))
  38      (pass-if-exception test-name exc
  39                         (compile 'exp #:from 'elisp #:to 'value)))))
  40
  41 (define-syntax with-test-prefix/compile
  42   (syntax-rules ()
  43     ((_ section-name exp ...)
  44      (with-test-prefix section-name (compile-test exp) ...))))
  45
  46
  47 ; Test control structures.
  48 ; ========================
  49
  50 (with-test-prefix/compile "Sequencing"
  51
  52   (pass-if-equal "progn" 1
  53     (progn (setq a 0)
  54            (setq a (1+ a))
  55            a))
  56
  57   (pass-if "prog1"
  58     (progn (setq a 0)
  59            (setq b (prog1 a (setq a (1+ a))))
  60            (and (= a 1) (= b 0))))
  61
  62   (pass-if "prog2"
  63     (progn (setq a 0)
  64            (setq b (prog2 (setq a (1+ a))
  65                           (setq a (1+ a))
  66                           (setq a (1+ a))))
  67            (and (= a 3) (= b 2)))))
  68
  69 (with-test-prefix/compile "Conditionals"
  70
  71   (pass-if-equal "succeeding if" 1
  72     (if t 1 2))
  73   (pass-if "failing if"
  74     (and (= (if nil
  75               1
  76               (setq a 2) (setq a (1+ a)) a)
  77             3)
  78          (equal (if nil 1) nil)))
  79
  80   (pass-if-equal "failing when" nil-value
  81     (when nil 1 2 3))
  82   (pass-if-equal "succeeding when" 42
  83     (progn (setq a 0)
  84            (when t (setq a 42) a)))
  85
  86   (pass-if-equal "failing unless" nil-value
  87     (unless t 1 2 3))
  88   (pass-if-equal "succeeding unless" 42
  89     (progn (setq a 0)
  90            (unless nil (setq a 42) a)))
  91
  92   (pass-if-equal "empty cond" nil-value
  93     (cond))
  94   (pass-if-equal "all failing cond" nil-value
  95     (cond (nil) (nil)))
  96   (pass-if-equal "only condition" 5
  97     (cond (nil) (5)))
  98   (pass-if-equal "succeeding cond value" 42
  99     (cond (nil) (t 42) (t 0)))
 100   (pass-if-equal "succeeding cond side-effect" 42
 101     (progn (setq a 0)
 102            (cond (nil) (t (setq a 42) 1) (t (setq a 0)))
 103            a)))
 104
 105 (with-test-prefix/compile "Combining Conditions"
 106
 107   (pass-if-equal "empty and" t-value (and))
 108   (pass-if-equal "failing and" nil-value (and 1 2 nil 3))
 109   (pass-if-equal "succeeding and" 3 (and 1 2 3))
 110
 111   (pass-if-equal "empty or" nil-value (or))
 112   (pass-if-equal "failing or" nil-value (or nil nil nil))
 113   (pass-if-equal "succeeding or" 1 (or nil 1 nil 2 nil 3))
 114
 115   (pass-if-equal "not true" nil-value (not 1))
 116   (pass-if-equal "not false" t-value (not nil)))
 117
 118 (with-test-prefix/compile "Iteration"
 119
 120   (pass-if-equal "failing while" 0
 121     (progn (setq a 0)
 122            (while nil (setq a 1))
 123            a))
 124   (pass-if-equal "running while" 120
 125     (progn (setq prod 1
 126                  i 1)
 127            (while (<= i 5)
 128              (setq prod (* i prod))
 129              (setq i (1+ i)))
 130            prod))
 131
 132   (pass-if "dotimes"
 133     (progn (setq a 0)
 134            (setq count 100)
 135            (setq b (dotimes (i count)
 136                      (setq j (1+ i))
 137                      (setq a (+ a j))))
 138            (setq c (dotimes (i 10 42) nil))
 139            (and (= a 5050) (equal b nil) (= c 42))))
 140
 141   (pass-if "dolist"
 142     (let ((mylist '(7 2 5)))
 143       (setq sum 0)
 144       (setq a (dolist (i mylist)
 145                 (setq sum (+ sum i))))
 146       (setq b (dolist (i mylist 5) 0))
 147       (and (= sum (+ 7 2 5))
 148            (equal a nil)
 149            (equal mylist '(7 2 5))
 150            (equal b 5)))))
 151
 152 (with-test-prefix/compile "Exceptions"
 153
 154   (pass-if "catch without exception"
 155     (and (setq a 0)
 156          (= (catch 'foobar
 157                    (setq a (1+ a))
 158                    (setq a (1+ a))
 159                    a)
 160             2)
 161          (= (catch (+ 1 2) a) 2)))
 162
 163   ; FIXME: Figure out how to do this...
 164   ;(pass-if-exception "uncaught exception" 'elisp-exception
 165   ;  (throw 'abc 1))
 166
 167   (pass-if "catch and throw"
 168     (and (setq mylist '(1 2))
 169          (= (catch 'abc (throw 'abc 2) 1) 2)
 170          (= (catch 'abc (catch 'def (throw 'abc (1+ 0)) 2) 3) 1)
 171          (= (catch 'abc (catch 'def (throw 'def 1) 2) 3) 3)
 172          (= (catch mylist (catch '(1 2) (throw mylist 1) 2) 3) 1)))
 173
 174   (pass-if "unwind-protect"
 175     (progn (setq a 0 b 1 c 1)
 176            (catch 'exc
 177                   (unwind-protect (progn (setq a 1)
 178                                          (throw 'exc 0))
 179                                   (setq a 0)
 180                                   (setq b 0)))
 181            (unwind-protect nil (setq c 0))
 182            (and (= a 0) (= b 0) (= c 0)
 183                 (= (unwind-protect 42 1 2 3) 42)))))
 184
 185
 186 ; Test handling of variables.
 187 ; ===========================
 188
 189 (with-test-prefix/compile "Variable Setting/Referencing"
 190
 191   ; TODO: Check for variable-void error
 192
 193   (pass-if-equal "setq and reference" 6
 194     (progn (setq a 1 b 2 c 3)
 195            (+ a b c)))
 196   (pass-if-equal "setq value" 2
 197     (progn (setq a 1 b 2)))
 198
 199   (pass-if "set and symbol-value"
 200     (progn (setq myvar 'a)
 201            (and (= (set myvar 42) 42)
 202                 (= a 42)
 203                 (= (symbol-value myvar) 42))))
 204   (pass-if "void variables"
 205     (progn (setq a 1 b 2)
 206            (and (eq (makunbound 'b) 'b)
 207                 (boundp 'a)
 208                 (not (boundp 'b)))))
 209
 210   (pass-if "disabled void check (all)"
 211     (progn (makunbound 'a) a t)
 212     #:opts '(#:disable-void-check all))
 213   (pass-if "disabled void check (symbol list)"
 214     (progn (makunbound 'a) a t)
 215     #:opts '(#:disable-void-check (x y a b))))
 216
 217 (with-test-prefix/compile "Let and Let*"
 218
 219   (pass-if-equal "let without value" nil-value
 220     (let (a (b 5)) a))
 221   (pass-if-equal "basic let" 0
 222     (progn (setq a 0)
 223            (let ((a 1)
 224                  (b a))
 225              b)))
 226   (pass-if-equal "let*" 1
 227     (progn (setq a 0)
 228            (let* ((a 1)
 229                   (b a))
 230              b)))
 231
 232   (pass-if "local scope"
 233     (progn (setq a 0)
 234            (setq b (let (a)
 235                      (setq a 1)
 236                      a))
 237            (and (= a 0)
 238                 (= b 1)))))
 239
 240 (with-test-prefix/compile "defconst and defvar"
 241
 242   (pass-if-equal "defconst without docstring" 3.141
 243     (progn (setq pi 3)
 244            (defconst pi 3.141)
 245            pi))
 246   (pass-if-equal "defconst value" 'pi
 247     (defconst pi 3.141 "Pi"))
 248
 249   (pass-if-equal "defvar without value" 42
 250     (progn (setq a 42)
 251            (defvar a)
 252            a))
 253   (pass-if-equal "defvar on already defined variable" 42
 254     (progn (setq a 42)
 255            (defvar a 1 "Some docstring is also ok")
 256            a))
 257   (pass-if-equal "defvar on undefined variable" 1
 258     (progn (makunbound 'a)
 259            (defvar a 1)
 260            a))
 261   (pass-if-equal "defvar value" 'a
 262     (defvar a)))
 263
 264
 265 ; Functions and lambda expressions.
 266 ; =================================
 267
 268 (with-test-prefix/compile "Lambda Expressions"
 269
 270   (pass-if-equal "required arguments" 3
 271     ((lambda (a b c) c) 1 2 3))
 272
 273   (pass-if-equal "optional argument" 3
 274     ((function (lambda (a &optional b c) c)) 1 2 3))
 275   (pass-if-equal "optional missing" nil-value
 276     ((lambda (&optional a) a)))
 277
 278   (pass-if-equal "rest argument" '(3 4 5)
 279     ((lambda (a b &rest c) c) 1 2 3 4 5))
 280   (pass-if-equal "rest missing" nil-value
 281     ((lambda (a b &rest c) c) 1 2)))
 282
 283 (with-test-prefix/compile "Function Definitions"
 284
 285   (pass-if-equal "defun" 3
 286     (progn (defun test (a b) (+ a b))
 287            (test 1 2)))
 288   (pass-if-equal "defun value" 'test
 289     (defun test (a b) (+ a b)))
 290
 291   (pass-if "fset and symbol-function"
 292     (progn (setq myfunc 'x x 5)
 293            (and (= (fset myfunc 42) 42)
 294                 (= (symbol-function myfunc) 42)
 295                 (= x 5))))
 296   (pass-if "void function values"
 297     (progn (setq a 1)
 298            (defun test (a b) (+ a b))
 299            (fmakunbound 'a)
 300            (fset 'b 5)
 301            (and (fboundp 'b) (fboundp 'test)
 302                 (not (fboundp 'a))
 303                 (= a 1))))
 304
 305   (pass-if "flet and flet*"
 306     (progn (defun foobar () 42)
 307            (defun test () (foobar))
 308            (and (= (test) 42)
 309                 (flet ((foobar (lambda () 0))
 310                        (myfoo (symbol-function 'foobar)))
 311                   (and (= (myfoo) 42)
 312                        (= (test) 0)))
 313                 (flet* ((foobar (lambda () 0))
 314                         (myfoo (symbol-function 'foobar)))
 315                   (= (myfoo) 0))
 316                 (flet (foobar)
 317                   (defun foobar () 0)
 318                   (= (test) 0))
 319                 (= (test) 42)))))
 320
 321 (with-test-prefix/compile "Calling Functions"
 322
 323   (pass-if-equal "recursion" 120
 324     (progn (defun factorial (n prod)
 325              (if (zerop n)
 326                prod
 327                (factorial (1- n) (* prod n))))
 328            (factorial 5 1)))
 329
 330   (pass-if "dynamic scoping"
 331     (progn (setq a 0)
 332            (defun foo ()
 333              (setq a (1+ a))
 334              a)
 335            (defun bar (a)
 336              (foo))
 337            (and (= 43 (bar 42))
 338                 (zerop a)))))
 339
 340
 341 ; Quoting and Backquotation.
 342 ; ==========================
 343
 344 (with-test-prefix/compile "Quotation"
 345
 346   (pass-if "quote"
 347     (and (equal '42 42) (equal '"abc" "abc")
 348          (equal '(1 2 (3 (4) x)) '(1 2 (3 (4) x)))
 349          (not (equal '(1 2 (3 4 (x))) '(1 2 3 4 x)))
 350          (equal '(1 2 . 3) '(1 2 . 3))))
 351
 352   (pass-if "simple backquote"
 353     (and (equal (\` 42) 42)
 354          (equal (\` (1 (a))) '(1 (a)))
 355          (equal (\` (1 . 2)) '(1 . 2))))
 356   (pass-if "unquote"
 357     (progn (setq a 42 l '(18 12))
 358            (and (equal (\` (\, a)) 42)
 359                 (equal (\` (1 a ((\, l)) . (\, a))) '(1 a ((18 12)) . 42)))))
 360   (pass-if "unquote splicing"
 361     (progn (setq l '(18 12) empty '())
 362            (and (equal (\` (\,@ l)) '(18 12))
 363                 (equal (\` (l 2 (3 (\,@ l)) ((\,@ l)) (\,@ l)))
 364                        '(l 2 (3 18 12) (18 12) 18 12))
 365                 (equal (\` (1 2 (\,@ empty) 3)) '(1 2 3))))))
 366
 367
 368
 369 ; Macros.
 370 ; =======
 371
 372 (with-test-prefix/compile "Macros"
 373
 374   (pass-if-equal "defmacro value" 'magic-number
 375     (defmacro magic-number () 42))
 376
 377   (pass-if-equal "macro expansion" 1
 378     (progn (defmacro take-first (a b) a)
 379            (take-first 1 (/ 1 0)))))
 380
 381
 382 ; Test the built-ins.
 383 ; ===================
 384
 385 (with-test-prefix/compile "Equivalence Predicates"
 386
 387   (pass-if "equal"
 388     (and (equal 2 2) (not (equal 1 2))
 389          (equal "abc" "abc") (not (equal "abc" "ABC"))
 390          (equal 'abc 'abc) (not (equal 'abc 'def))
 391          (equal '(1 2 (3 4) 5) '(1 2 (3 4) 5))
 392          (not (equal '(1 2 3 4 5) '(1 2 (3 4) 5)))))
 393
 394   (pass-if "eq"
 395     (progn (setq some-list '(1 2))
 396            (setq some-string "abc")
 397            (and (eq 2 2) (not (eq 1 2))
 398                 (eq 'abc 'abc) (not (eq 'abc 'def))
 399                 (eq some-string some-string) (not (eq some-string "abc"))
 400                 (eq some-list some-list) (not (eq some-list '(1 2)))))))
 401
 402 (with-test-prefix/compile "Number Built-Ins"
 403
 404   (pass-if "floatp"
 405     (and (floatp 1.0) (not (floatp 1)) (not (floatp 'a))))
 406   (pass-if "integerp"
 407     (and (integerp 42) (integerp -2) (not (integerp 1.0))))
 408   (pass-if "numberp"
 409     (and (numberp 1.0) (numberp -2) (not (numberp 'a))))
 410   (pass-if "wholenump"
 411     (and (wholenump 0) (not (wholenump -2)) (not (wholenump 1.0))))
 412   (pass-if "zerop"
 413     (and (zerop 0) (zerop 0.0) (not (zerop 1))))
 414
 415   (pass-if "comparisons"
 416     (and (= 1 1.0) (/= 0 1)
 417          (< 1 2) (> 2 1) (>= 1 1) (<= 1 1)
 418          (not (< 1 1)) (not (<= 2 1))))
 419
 420   (pass-if "max and min"
 421     (and (= (max -5 2 4.0 1) 4.0) (= (min -5 2 4.0 1) -5)
 422          (= (max 1) 1) (= (min 1) 1)))
 423   (pass-if "abs"
 424     (and (= (abs 1.0) 1.0) (= (abs -5) 5)))
 425
 426   (pass-if "float"
 427     (and (= (float 1) 1) (= (float 5.5) 5.5)
 428          (floatp (float 1))))
 429
 430   (pass-if-equal "basic arithmetic operators" -8.5
 431     (+ (1+ 0) (1- 0) (- 5.5) (* 2 -2) (- 2 1)))
 432   (pass-if "modulo"
 433     (= (% 5 3) 2))
 434
 435   (pass-if "floating point rounding"
 436     (and (= (ffloor 1.7) 1.0) (= (ffloor -1.2) -2.0) (= (ffloor 1.0) 1.0)
 437          (= (fceiling 1.2) 2.0) (= (fceiling -1.7) -1.0) (= (fceiling 1.0) 1.0)
 438          (= (ftruncate 1.6) 1.0) (= (ftruncate -1.7) -1.0)
 439          (= (fround 1.2) 1.0) (= (fround 1.7) 2.0) (= (fround -1.7) -2.0))))
 440
 441 (with-test-prefix/compile "List Built-Ins"
 442
 443   (pass-if "consp and atomp"
 444     (and (consp '(1 2 3)) (consp '(1 2 . 3)) (consp '(a . b))
 445          (not (consp '())) (not (consp 1)) (not (consp "abc"))
 446          (atomp 'a) (atomp '()) (atomp -1.5) (atomp "abc")
 447          (not (atomp '(1 . 2))) (not (atomp '(1)))))
 448   (pass-if "listp and nlistp"
 449     (and (listp '(1 2 3)) (listp '(1)) (listp '()) (listp '(1 . 2))
 450          (not (listp 'a)) (not (listp 42)) (nlistp 42)
 451          (not (nlistp '())) (not (nlistp '(1 2 3))) (not (nlistp '(1 . 2)))))
 452   (pass-if "null"
 453     (and (null '()) (not (null 1)) (not (null '(1 2))) (not (null '(1 . 2)))))
 454
 455   (pass-if "car and cdr"
 456     (and (equal (car '(1 2 3)) 1) (equal (cdr '(1 2 3)) '(2 3))
 457          (equal (car '()) nil) (equal (cdr '()) nil)
 458          (equal (car '(1 . 2)) 1) (equal (cdr '(1 . 2)) 2)
 459          (null (cdr '(1)))))
 460   (pass-if "car-safe and cdr-safe"
 461     (and (equal (car-safe '(1 2)) 1) (equal (cdr-safe '(1 2)) '(2))
 462          (equal (car-safe 5) nil) (equal (cdr-safe 5) nil)))
 463
 464   (pass-if "pop"
 465     (progn (setq mylist '(a b c))
 466            (setq value (pop mylist))
 467            (and (equal value 'a)
 468                 (equal mylist '(b c)))))
 469   (pass-if-equal "push" '(a b c)
 470     (progn (setq mylist '(b c))
 471            (push 'a mylist)))
 472
 473   (pass-if "nth and nthcdr"
 474     (and (equal (nth -5 '(1 2 3)) 1) (equal (nth 3 '(1 2 3)) nil)
 475          (equal (nth 0 '(1 2 3)) 1) (equal (nth 2 '(1 2 3)) 3)
 476          (equal (nthcdr -5 '(1 2 3)) '(1 2 3))
 477          (equal (nthcdr 4 '(1 2 3)) nil)
 478          (equal (nthcdr 1 '(1 2 3)) '(2 3))
 479          (equal (nthcdr 2 '(1 2 3)) '(3))))
 480
 481   (pass-if "cons, list and make-list"
 482     (and (equal (cons 1 2) '(1 . 2)) (equal (cons 1 '(2 3)) '(1 2 3))
 483          (equal (cons 1 '()) '(1))
 484          (equal (list 'a) '(a)) (equal (list) '()) (equal (list 1 2) '(1 2))
 485          (equal (make-list 3 42) '(42 42 42))
 486          (equal (make-list 0 1) '())))
 487   (pass-if "append"
 488     (and (equal (append '(1 2) '(3 4) '(5)) '(1 2 3 4 5))
 489          (equal (append '(1 2) 3) '(1 2 . 3))))
 490   (pass-if "reverse"
 491     (and (equal (reverse '(5 4 3 2 1)) '(1 2 3 4 5))
 492          (equal (reverse '()) '())))
 493   (pass-if "copy-tree"
 494     (progn (setq mylist '(1 2 (3 4)))
 495            (and (not (eq mylist (copy-tree mylist)))
 496                 (equal mylist (copy-tree mylist)))))
 497
 498   (pass-if "number-sequence"
 499     (and (equal (number-sequence 5) '(5))
 500          (equal (number-sequence 5 9) '(5 6 7 8 9))
 501          (equal (number-sequence 5 9 3) '(5 8))
 502          (equal (number-sequence 5 1 -2) '(5 3 1))
 503          (equal (number-sequence 5 8 -1) '())
 504          (equal (number-sequence 5 1) '())
 505          (equal (number-sequence 5 5 0) '(5))))
 506
 507   (pass-if "setcar and setcdr"
 508     (progn (setq pair '(1 . 2))
 509            (setq copy pair)
 510            (setq a (setcar copy 3))
 511            (setq b (setcdr copy 4))
 512            (and (= a 3) (= b 4)
 513                 (equal pair '(3 . 4))))))