1 ;;;; elisp-compiler.test --- Test the compiler for Elisp. -*- scheme -*-
3 ;;;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
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.
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.
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
20 (define-module (test-elisp-compiler)
21 :use-module (test-suite lib)
22 :use-module (system base compile)
23 :use-module (language elisp runtime))
26 ; Macros to handle the compilation conveniently.
28 (define-syntax compile-test
29 (syntax-rules (pass-if pass-if-equal 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)))))
41 (define-syntax with-test-prefix/compile
43 ((_ section-name exp ...)
44 (with-test-prefix section-name (compile-test exp) ...))))
47 ; Test control structures.
48 ; ========================
50 (with-test-prefix/compile "Sequencing"
52 (pass-if-equal "progn" 1
59 (setq b (prog1 a (setq a (1+ a))))
60 (and (= a 1) (= b 0))))
64 (setq b (prog2 (setq a (1+ a))
67 (and (= a 3) (= b 2)))))
69 (with-test-prefix/compile "Conditionals"
71 (pass-if-equal "succeeding if" 1
76 (setq a 2) (setq a (1+ a)) a)
78 (equal (if nil 1) nil)))
80 (pass-if-equal "failing when" nil-value
82 (pass-if-equal "succeeding when" 42
84 (when t (setq a 42) a)))
86 (pass-if-equal "failing unless" nil-value
88 (pass-if-equal "succeeding unless" 42
90 (unless nil (setq a 42) a)))
92 (pass-if-equal "empty cond" nil-value
94 (pass-if-equal "all failing cond" nil-value
96 (pass-if-equal "only condition" 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
102 (cond (nil) (t (setq a 42) 1) (t (setq a 0)))
105 (with-test-prefix/compile "Combining Conditions"
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))
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))
115 (pass-if-equal "not true" nil-value (not 1))
116 (pass-if-equal "not false" t-value (not nil)))
118 (with-test-prefix/compile "Iteration"
120 (pass-if-equal "failing while" 0
122 (while nil (setq a 1))
124 (pass-if-equal "running while" 120
128 (setq prod (* i prod))
135 (setq b (dotimes (i count)
138 (setq c (dotimes (i 10 42) nil))
139 (and (= a 5050) (equal b nil) (= c 42))))
142 (let ((mylist '(7 2 5)))
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))
149 (equal mylist '(7 2 5))
152 (with-test-prefix/compile "Exceptions"
154 (pass-if "catch without exception"
161 (= (catch (+ 1 2) a) 2)))
163 ; FIXME: Figure out how to do this...
164 ;(pass-if-exception "uncaught exception" 'elisp-exception
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)))
174 (pass-if "unwind-protect"
175 (progn (setq a 0 b 1 c 1)
177 (unwind-protect (progn (setq a 1)
181 (unwind-protect nil (setq c 0))
182 (and (= a 0) (= b 0) (= c 0)
183 (= (unwind-protect 42 1 2 3) 42)))))
185 (with-test-prefix/compile "Eval"
187 (pass-if-equal "basic eval" 3
188 (progn (setq code '(+ 1 2))
191 (pass-if "real dynamic code"
192 (and (setq a 1 b 1 c 1)
193 (defun set-code (var val)
194 (list 'setq var val))
195 (= a 1) (= b 1) (= c 1)
196 (eval (set-code 'a '(+ 2 3)))
197 (eval (set-code 'c 42))
198 (= a 5) (= b 1) (= c 42)))
200 ; Build code that recursively again and again calls eval. What we want is
202 ; (eval '(1+ (eval '(1+ (eval 1)))))
203 (pass-if "recursive eval"
204 (progn (setq depth 10 i depth)
205 (setq code '(eval 0))
206 (while (not (zerop i))
207 (setq code (#{`}# (eval (quote (1+ (#{,}# code))))))
209 (= (eval code) depth))))
212 ; Test handling of variables.
213 ; ===========================
215 (with-test-prefix/compile "Variable Setting/Referencing"
217 ; TODO: Check for variable-void error
219 (pass-if-equal "setq and reference" 6
220 (progn (setq a 1 b 2 c 3)
222 (pass-if-equal "setq evaluation order" 1
223 (progn (setq a 0 b 0)
225 (pass-if-equal "setq value" 2
226 (progn (setq a 1 b 2)))
228 (pass-if "set and symbol-value"
229 (progn (setq myvar 'a)
230 (and (= (set myvar 42) 42)
232 (= (symbol-value myvar) 42))))
233 (pass-if "void variables"
234 (progn (setq a 1 b 2)
235 (and (eq (makunbound 'b) 'b)
237 (not (boundp 'b))))))
239 (with-test-prefix/compile "Let and Let*"
241 (pass-if-equal "let without value" nil-value
243 (pass-if-equal "basic let" 0
256 (and (= a 1) (= b 2)))
260 (pass-if "local scope"
268 (with-test-prefix/compile "Lexical Scoping"
270 (pass-if "basic let semantics"
272 (lexical-let ((a 2) (b a))
273 (and (= a 2) (= b 1)))
274 (lexical-let* ((a 2) (b a))
275 (and (= a 2) (= b 2) (setq a 42) (= a 42)))
278 (pass-if "lexical scope with lexical-let's"
283 (and (= a 2) (= (dyna) 1)))
287 (and (= a 2) (= (dyna) 1)))
290 (pass-if "lexical scoping vs. symbol-value / set"
294 (= (symbol-value 'a) 1)
297 (= (symbol-value 'a) 3)))
300 (pass-if "let inside lexical-let"
302 (defun dynvals () (cons a b))
304 (and (= a 2) (equal (dynvals) '(1 . 1))
307 (equal (dynvals) '(1 . 2))))
310 (equal (dynvals) '(1 . 4))))
314 (pass-if "lambda args inside lexical-let"
317 (lexical-let ((a 2) (b 42))
318 (and (= a 2) (= (dyna) 1)
319 ((lambda (a) (and (= a 3) (= b 42) (= (dyna) 3))) 3)
320 ((lambda () (let ((a 3))
321 (and (= a 3) (= (dyna) 1)))))
322 (= a 2) (= (dyna) 1)))
326 (and (defun make-counter ()
327 (lexical-let ((cnt 0))
329 (setq cnt (1+ cnt)))))
330 (setq c1 (make-counter) c2 (make-counter))
339 (pass-if "always lexical option (all)"
343 (and (= a 1) (= (dyna) 0))))
344 #:opts '(#:always-lexical all))
345 (pass-if "always lexical option (list)"
346 (progn (setq a 0 b 0)
351 (and (= a 1) (= (dyna) 0)
352 (= b 1) (= (dynb) 1))))
353 #:opts '(#:always-lexical (a)))
354 (pass-if "with-always-lexical"
357 (with-always-lexical (a)
359 (and (= a 1) (= (dyna) 0))))))
361 (pass-if "lexical lambda args"
362 (progn (setq a 1 b 1)
365 (with-always-lexical (a c)
366 ((lambda (a b &optional c)
367 (and (= a 3) (= (dyna) 1)
372 ; Check if a lambda without dynamically bound arguments
373 ; is tail-optimized by doing a deep recursion that would otherwise overflow
375 (pass-if "lexical lambda tail-recursion"
376 (with-always-lexical (i)
378 (defun iteration-1 (i)
380 (iteration-1 (1+ i))))
383 (defun iteration-2 ()
391 (with-test-prefix/compile "defconst and defvar"
393 (pass-if-equal "defconst without docstring" 3.141
397 (pass-if-equal "defconst value" 'pi
398 (defconst pi 3.141 "Pi"))
400 (pass-if-equal "defvar without value" 42
404 (pass-if-equal "defvar on already defined variable" 42
406 (defvar a 1 "Some docstring is also ok")
408 (pass-if-equal "defvar on undefined variable" 1
409 (progn (makunbound 'a)
412 (pass-if-equal "defvar value" 'a
416 ; Functions and lambda expressions.
417 ; =================================
419 (with-test-prefix/compile "Lambda Expressions"
421 (pass-if-equal "required arguments" 3
422 ((lambda (a b c) c) 1 2 3))
424 (pass-if-equal "optional argument" 3
425 ((function (lambda (a &optional b c) c)) 1 2 3))
426 (pass-if-equal "optional missing" nil-value
427 ((lambda (&optional a) a)))
429 (pass-if-equal "rest argument" '(3 4 5)
430 ((lambda (a b &rest c) c) 1 2 3 4 5))
431 (pass-if-equal "rest missing" nil-value
432 ((lambda (a b &rest c) c) 1 2)))
434 (with-test-prefix/compile "Function Definitions"
436 (pass-if-equal "defun" 3
437 (progn (defun test (a b) (+ a b))
439 (pass-if-equal "defun value" 'test
440 (defun test (a b) (+ a b)))
442 (pass-if "fset and symbol-function"
443 (progn (setq myfunc 'x x 5)
444 (and (= (fset myfunc 42) 42)
445 (= (symbol-function myfunc) 42)
447 (pass-if "void function values"
449 (defun test (a b) (+ a b))
452 (and (fboundp 'b) (fboundp 'test)
456 (pass-if "flet and flet*"
457 (progn (defun foobar () 42)
458 (defun test () (foobar))
460 (flet ((foobar (lambda () 0))
461 (myfoo (symbol-function 'foobar)))
464 (flet* ((foobar (lambda () 0))
465 (myfoo (symbol-function 'foobar)))
472 (with-test-prefix/compile "Calling Functions"
474 (pass-if-equal "recursion" 120
475 (progn (defun factorial (n prod)
478 (factorial (1- n) (* prod n))))
481 (pass-if "dynamic scoping"
491 (pass-if "funcall and apply argument handling"
492 (and (defun allid (&rest args) args)
493 (setq allid-var (symbol-function 'allid))
494 (equal (funcall allid-var 1 2 3) '(1 2 3))
495 (equal (funcall allid-var) nil)
496 (equal (funcall allid-var 1 2 '(3 4)) '(1 2 (3 4)))
497 (equal (funcall allid-var '()) '(()))
498 (equal (apply allid-var 1 2 '(3 4)) '(1 2 3 4))
499 (equal (apply allid-var '(1 2)) '(1 2))
500 (equal (apply allid-var '()) nil)))
502 (pass-if "raw functions with funcall"
503 (and (= (funcall '+ 1 2) 3)
504 (= (funcall (lambda (a b) (+ a b)) 1 2) 3)
505 (= (funcall '(lambda (a b) (+ a b)) 1 2) 3))))
508 ; Quoting and Backquotation.
509 ; ==========================
511 (with-test-prefix/compile "Quotation"
514 (and (equal '42 42) (equal '"abc" "abc")
515 (equal '(1 2 (3 (4) x)) '(1 2 (3 (4) x)))
516 (not (equal '(1 2 (3 4 (x))) '(1 2 3 4 x)))
517 (equal '(1 2 . 3) '(1 2 . 3))))
519 (pass-if "simple backquote"
520 (and (equal (#{`}# 42) 42)
521 (equal (#{`}# (1 (a))) '(1 (a)))
522 (equal (#{`}# (1 . 2)) '(1 . 2))))
524 (progn (setq a 42 l '(18 12))
525 (and (equal (#{`}# (#{,}# a)) 42)
526 (equal (#{`}# (1 a ((#{,}# l)) . (#{,}# a))) '(1 a ((18 12)) . 42)))))
527 (pass-if "unquote splicing"
528 (progn (setq l '(18 12) empty '())
529 (and (equal (#{`}# (#{,@}# l)) '(18 12))
530 (equal (#{`}# (l 2 (3 (#{,@}# l)) ((#{,@}# l)) (#{,@}# l)))
531 '(l 2 (3 18 12) (18 12) 18 12))
532 (equal (#{`}# (1 2 (#{,@}# empty) 3)) '(1 2 3))))))
539 (with-test-prefix/compile "Macros"
541 (pass-if-equal "defmacro value" 'magic-number
542 (defmacro magic-number () 42))
544 (pass-if-equal "macro expansion" 1
545 (progn (defmacro take-first (a b) a)
546 (take-first 1 (/ 1 0)))))
549 ; Test the built-ins.
550 ; ===================
552 (with-test-prefix/compile "Equivalence Predicates"
555 (and (equal 2 2) (not (equal 1 2))
556 (equal "abc" "abc") (not (equal "abc" "ABC"))
557 (equal 'abc 'abc) (not (equal 'abc 'def))
558 (equal '(1 2 (3 4) 5) '(1 2 (3 4) 5))
559 (not (equal '(1 2 3 4 5) '(1 2 (3 4) 5)))))
562 (progn (setq some-list '(1 2))
563 (setq some-string "abc")
564 (and (eq 2 2) (not (eq 1 2))
565 (eq 'abc 'abc) (not (eq 'abc 'def))
566 (eq some-string some-string) (not (eq some-string "abc"))
567 (eq some-list some-list) (not (eq some-list '(1 2)))))))
569 (with-test-prefix/compile "Number Built-Ins"
572 (and (floatp 1.0) (not (floatp 1)) (not (floatp 'a))))
574 (and (integerp 42) (integerp -2) (not (integerp 1.0))))
576 (and (numberp 1.0) (numberp -2) (not (numberp 'a))))
578 (and (wholenump 0) (not (wholenump -2)) (not (wholenump 1.0))))
580 (and (zerop 0) (zerop 0.0) (not (zerop 1))))
582 (pass-if "comparisons"
583 (and (= 1 1.0) (/= 0 1)
584 (< 1 2) (> 2 1) (>= 1 1) (<= 1 1)
585 (not (< 1 1)) (not (<= 2 1))))
587 (pass-if "max and min"
588 (and (= (max -5 2 4.0 1) 4.0) (= (min -5 2 4.0 1) -5)
589 (= (max 1) 1) (= (min 1) 1)))
591 (and (= (abs 1.0) 1.0) (= (abs -5) 5)))
594 (and (= (float 1) 1) (= (float 5.5) 5.5)
597 (pass-if-equal "basic arithmetic operators" -8.5
598 (+ (1+ 0) (1- 0) (- 5.5) (* 2 -2) (- 2 1)))
602 (pass-if "floating point rounding"
603 (and (= (ffloor 1.7) 1.0) (= (ffloor -1.2) -2.0) (= (ffloor 1.0) 1.0)
604 (= (fceiling 1.2) 2.0) (= (fceiling -1.7) -1.0) (= (fceiling 1.0) 1.0)
605 (= (ftruncate 1.6) 1.0) (= (ftruncate -1.7) -1.0)
606 (= (fround 1.2) 1.0) (= (fround 1.7) 2.0) (= (fround -1.7) -2.0))))
608 (with-test-prefix/compile "List Built-Ins"
610 (pass-if "consp and atomp"
611 (and (consp '(1 2 3)) (consp '(1 2 . 3)) (consp '(a . b))
612 (not (consp '())) (not (consp 1)) (not (consp "abc"))
613 (atomp 'a) (atomp '()) (atomp -1.5) (atomp "abc")
614 (not (atomp '(1 . 2))) (not (atomp '(1)))))
615 (pass-if "listp and nlistp"
616 (and (listp '(1 2 3)) (listp '(1)) (listp '()) (listp '(1 . 2))
617 (not (listp 'a)) (not (listp 42)) (nlistp 42)
618 (not (nlistp '())) (not (nlistp '(1 2 3))) (not (nlistp '(1 . 2)))))
620 (and (null '()) (not (null 1)) (not (null '(1 2))) (not (null '(1 . 2)))))
622 (pass-if "car and cdr"
623 (and (equal (car '(1 2 3)) 1) (equal (cdr '(1 2 3)) '(2 3))
624 (equal (car '()) nil) (equal (cdr '()) nil)
625 (equal (car '(1 . 2)) 1) (equal (cdr '(1 . 2)) 2)
627 (pass-if "car-safe and cdr-safe"
628 (and (equal (car-safe '(1 2)) 1) (equal (cdr-safe '(1 2)) '(2))
629 (equal (car-safe 5) nil) (equal (cdr-safe 5) nil)))
632 (progn (setq mylist '(a b c))
633 (setq value (pop mylist))
634 (and (equal value 'a)
635 (equal mylist '(b c)))))
636 (pass-if-equal "push" '(a b c)
637 (progn (setq mylist '(b c))
640 (pass-if "nth and nthcdr"
641 (and (equal (nth -5 '(1 2 3)) 1) (equal (nth 3 '(1 2 3)) nil)
642 (equal (nth 0 '(1 2 3)) 1) (equal (nth 2 '(1 2 3)) 3)
643 (equal (nthcdr -5 '(1 2 3)) '(1 2 3))
644 (equal (nthcdr 4 '(1 2 3)) nil)
645 (equal (nthcdr 1 '(1 2 3)) '(2 3))
646 (equal (nthcdr 2 '(1 2 3)) '(3))))
649 (and (= (length '()) 0)
650 (= (length '(1 2 3 4 5)) 5)
651 (= (length '(1 2 (3 4 (5)) 6)) 4)))
653 (pass-if "cons, list and make-list"
654 (and (equal (cons 1 2) '(1 . 2)) (equal (cons 1 '(2 3)) '(1 2 3))
655 (equal (cons 1 '()) '(1))
656 (equal (list 'a) '(a)) (equal (list) '()) (equal (list 1 2) '(1 2))
657 (equal (make-list 3 42) '(42 42 42))
658 (equal (make-list 0 1) '())))
660 (and (equal (append '(1 2) '(3 4) '(5)) '(1 2 3 4 5))
661 (equal (append '(1 2) 3) '(1 2 . 3))))
663 (and (equal (reverse '(5 4 3 2 1)) '(1 2 3 4 5))
664 (equal (reverse '()) '())))
666 (progn (setq mylist '(1 2 (3 4)))
667 (and (not (eq mylist (copy-tree mylist)))
668 (equal mylist (copy-tree mylist)))))
670 (pass-if "number-sequence"
671 (and (equal (number-sequence 5) '(5))
672 (equal (number-sequence 5 9) '(5 6 7 8 9))
673 (equal (number-sequence 5 9 3) '(5 8))
674 (equal (number-sequence 5 1 -2) '(5 3 1))
675 (equal (number-sequence 5 8 -1) '())
676 (equal (number-sequence 5 1) '())
677 (equal (number-sequence 5 5 0) '(5))))
679 (pass-if "setcar and setcdr"
680 (progn (setq pair '(1 . 2))
682 (setq a (setcar copy 3))
683 (setq b (setcdr copy 4))
685 (equal pair '(3 . 4))))))