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 (compile '(%set-lexical-binding-mode #nil) #:from 'elisp #:to 'value)
52 (with-test-prefix/compile "Sequencing"
54 (pass-if-equal "progn" 1
59 (pass-if-equal "empty progn" #nil
64 (setq b (prog1 a (setq a (1+ a))))
65 (and (= a 1) (= b 0))))
69 (setq b (prog2 (setq a (1+ a))
72 (and (= a 3) (= b 2)))))
74 (with-test-prefix/compile "Conditionals"
76 (pass-if-equal "succeeding if" 1
81 (setq a 2) (setq a (1+ a)) a)
83 (equal (if nil 1) nil)))
85 (pass-if-equal "if with no else" #nil
88 (pass-if-equal "empty cond" nil-value
90 (pass-if-equal "all failing cond" nil-value
92 (pass-if-equal "only condition" 5
94 (pass-if-equal "succeeding cond value" 42
95 (cond (nil) (t 42) (t 0)))
96 (pass-if-equal "succeeding cond side-effect" 42
98 (cond (nil) (t (setq a 42) 1) (t (setq a 0)))
101 (with-test-prefix/compile "Combining Conditions"
103 (pass-if-equal "empty and" t-value (and))
104 (pass-if-equal "failing and" nil-value (and 1 2 nil 3))
105 (pass-if-equal "succeeding and" 3 (and 1 2 3))
107 (pass-if-equal "empty or" nil-value (or))
108 (pass-if-equal "failing or" nil-value (or nil nil nil))
109 (pass-if-equal "succeeding or" 1 (or nil 1 nil 2 nil 3))
111 (pass-if-equal "not true" nil-value (not 1))
112 (pass-if-equal "not false" t-value (not nil)))
114 (with-test-prefix/compile "Iteration"
116 (pass-if-equal "failing while" 0
118 (while nil (setq a 1))
120 (pass-if-equal "running while" 120
124 (setq prod (* i prod))
128 (with-test-prefix/compile "Exceptions"
130 (pass-if "catch without exception"
137 (= (catch (+ 1 2) a) 2)))
139 ; FIXME: Figure out how to do this...
140 ;(pass-if-exception "uncaught exception" 'elisp-exception
143 (pass-if "catch and throw"
144 (and (setq mylist '(1 2))
145 (= (catch 'abc (throw 'abc 2) 1) 2)
146 (= (catch 'abc (catch 'def (throw 'abc (1+ 0)) 2) 3) 1)
147 (= (catch 'abc (catch 'def (throw 'def 1) 2) 3) 3)
148 (= (catch mylist (catch (list 1 2) (throw mylist 1) 2) 3) 1)))
150 (pass-if "unwind-protect"
151 (progn (setq a 0 b 1 c 1)
153 (unwind-protect (progn (setq a 1)
157 (unwind-protect nil (setq c 0))
158 (and (= a 0) (= b 0) (= c 0)
159 (= (unwind-protect 42 1 2 3) 42)))))
161 (with-test-prefix/compile "Eval"
163 (pass-if-equal "basic eval" 3
164 (progn (setq code '(+ 1 2))
167 (pass-if "real dynamic code"
168 (and (setq a 1 b 1 c 1)
169 (defun set-code (var val)
170 (list 'setq var val))
171 (= a 1) (= b 1) (= c 1)
172 (eval (set-code 'a '(+ 2 3)))
173 (eval (set-code 'c 42))
174 (= a 5) (= b 1) (= c 42)))
176 ; Build code that recursively again and again calls eval. What we want is
178 ; (eval '(1+ (eval '(1+ (eval 1)))))
179 (pass-if "recursive eval"
180 (progn (setq depth 10 i depth)
181 (setq code '(eval 0))
182 (while (not (zerop i))
183 (setq code (#{`}# (eval (quote (1+ (#{,}# code))))))
185 (= (eval code) depth))))
188 ; Test handling of variables.
189 ; ===========================
191 (with-test-prefix/compile "Variable Setting/Referencing"
193 ; TODO: Check for variable-void error
195 (pass-if-equal "setq and reference" 6
196 (progn (setq a 1 b 2 c 3)
198 (pass-if-equal "setq evaluation order" 1
199 (progn (setq a 0 b 0)
201 (pass-if-equal "setq value" 2
202 (progn (setq a 1 b 2)))
204 (pass-if "set and symbol-value"
205 (progn (setq myvar 'a)
206 (and (= (set myvar 42) 42)
208 (= (symbol-value myvar) 42))))
209 (pass-if "void variables"
210 (progn (setq a 1 b 2)
211 (and (eq (makunbound 'b) 'b)
213 (not (boundp 'b))))))
215 (with-test-prefix/compile "Let and Let*"
217 (pass-if-equal "let without value" nil-value
219 (pass-if-equal "basic let" 0
225 (pass-if-equal "empty let" #nil (let ()))
234 (and (= a 1) (= b 2)))
238 (pass-if-equal "empty let*" #nil
241 (pass-if "local scope"
249 (with-test-prefix/compile "Lexical Scoping"
251 (pass-if "basic let semantics"
253 (lexical-let ((a 2) (b a))
254 (and (= a 2) (= b 1)))
255 (lexical-let* ((a 2) (b a))
256 (and (= a 2) (= b 2) (setq a 42) (= a 42)))
259 (pass-if "lexical scope with lexical-let's"
264 (and (= a 2) (= (dyna) 1)))
268 (and (= a 2) (= (dyna) 1)))
271 (pass-if "lexical scoping vs. symbol-value / set"
275 (= (symbol-value 'a) 1)
278 (= (symbol-value 'a) 3)))
281 (pass-if "let inside lexical-let"
283 (defun dynvals () (cons a b))
285 (and (= a 2) (equal (dynvals) '(1 . 1))
287 (declare (lexical a))
289 (equal (dynvals) '(1 . 2))))
291 (declare (lexical a))
293 (equal (dynvals) '(1 . 4))))
297 (pass-if "lambda args inside lexical-let"
300 (lexical-let ((a 2) (b 42))
301 (and (= a 2) (= (dyna) 1)
303 (declare (lexical a))
304 (and (= a 3) (= b 42) (= (dyna) 1))) 3)
305 ((lambda () (let ((a 3))
306 (declare (lexical a))
307 (and (= a 3) (= (dyna) 1)))))
308 (= a 2) (= (dyna) 1)))
312 (and (defun make-counter ()
313 (lexical-let ((cnt 0))
315 (setq cnt (1+ cnt)))))
316 (setq c1 (make-counter) c2 (make-counter))
325 (pass-if "lexical lambda args"
326 (progn (setq a 1 b 1)
330 ((lambda (a b &optional c)
331 (declare (lexical a c))
332 (and (= a 3) (= (dyna) 1)
337 ; Check if a lambda without dynamically bound arguments
338 ; is tail-optimized by doing a deep recursion that would otherwise overflow
340 (pass-if "lexical lambda tail-recursion"
343 (defun iteration-1 (i)
344 (declare (lexical i))
346 (iteration-1 (1+ i))))
349 (defun iteration-2 ()
357 (with-test-prefix/compile "defconst and defvar"
359 (pass-if-equal "defconst without docstring" 3.141
363 (pass-if-equal "defconst value" 'pi
364 (defconst pi 3.141 "Pi"))
366 (pass-if-equal "defvar without value" 42
370 (pass-if-equal "defvar on already defined variable" 42
372 (defvar a 1 "Some docstring is also ok")
374 (pass-if-equal "defvar on undefined variable" 1
375 (progn (makunbound 'a)
378 (pass-if-equal "defvar value" 'a
382 ; Functions and lambda expressions.
383 ; =================================
385 (with-test-prefix/compile "Lambda Expressions"
387 (pass-if-equal "required arguments" 3
388 ((lambda (a b c) c) 1 2 3))
390 (pass-if-equal "optional argument" 3
391 ((lambda (a &optional b c) c) 1 2 3))
392 (pass-if-equal "optional missing" nil-value
393 ((lambda (&optional a) a)))
395 (pass-if-equal "rest argument" '(3 4 5)
396 ((lambda (a b &rest c) c) 1 2 3 4 5))
397 (pass-if "rest missing"
398 (null ((lambda (a b &rest c) c) 1 2)))
400 (pass-if-equal "empty lambda" #nil
403 (with-test-prefix/compile "Function Definitions"
405 (pass-if-equal "defun" 3
406 (progn (defun test (a b) (+ a b))
408 (pass-if-equal "defun value" 'test
409 (defun test (a b) (+ a b)))
411 (pass-if "fset and symbol-function"
412 (progn (setq myfunc 'x x 5)
413 (and (= (fset myfunc 42) 42)
414 (= (symbol-function myfunc) 42)
416 (pass-if "void function values"
418 (defun test (a b) (+ a b))
421 (and (fboundp 'b) (fboundp 'test)
426 (progn (defun foobar () 42)
427 (defun test () (foobar))
431 (funcall (symbol-function 'foobar))))
434 (flet ((foobar () nil))
439 (with-test-prefix/compile "Calling Functions"
441 (pass-if-equal "recursion" 120
442 (progn (defun factorial (n prod)
445 (factorial (1- n) (* prod n))))
448 (pass-if "dynamic scoping"
458 (pass-if "funcall and apply argument handling"
459 (and (defun allid (&rest args) args)
460 (setq allid-var (symbol-function 'allid))
461 (equal (funcall allid-var 1 2 3) '(1 2 3))
462 (equal (funcall allid-var) nil)
463 (equal (funcall allid-var 1 2 '(3 4)) '(1 2 (3 4)))
464 (equal (funcall allid-var '()) '(()))
465 (equal (apply allid-var 1 2 '(3 4)) '(1 2 3 4))
466 (equal (apply allid-var '(1 2)) '(1 2))
467 (equal (apply allid-var '()) nil)))
469 (pass-if "raw functions with funcall"
470 (and (= (funcall '+ 1 2) 3)
471 (= (funcall (lambda (a b) (+ a b)) 1 2) 3)
472 (= (funcall '(lambda (a b) (+ a b)) 1 2) 3))))
475 ; Quoting and Backquotation.
476 ; ==========================
478 (with-test-prefix/compile "Quotation"
481 (and (equal '42 42) (equal '"abc" "abc")
482 (equal '(1 2 (3 (4) x)) '(1 2 (3 (4) x)))
483 (not (equal '(1 2 (3 4 (x))) '(1 2 3 4 x)))
484 (equal '(1 2 . 3) '(1 2 . 3))))
486 (pass-if "simple backquote"
487 (and (equal (#{`}# 42) 42)
488 (equal (#{`}# (1 (a))) '(1 (a)))
489 (equal (#{`}# (1 . 2)) '(1 . 2))))
491 (progn (setq a 42 l '(18 12))
492 (and (equal (#{`}# (#{,}# a)) 42)
493 (equal (#{`}# (1 a ((#{,}# l)) . (#{,}# a))) '(1 a ((18 12)) . 42)))))
494 (pass-if "unquote splicing"
495 (progn (setq l '(18 12) empty '())
496 (and (equal (#{`}# (#{,@}# l)) '(18 12))
497 (equal (#{`}# (l 2 (3 (#{,@}# l)) ((#{,@}# l)) (#{,@}# l)))
498 '(l 2 (3 18 12) (18 12) 18 12))
499 (equal (#{`}# (1 2 (#{,@}# empty) 3)) '(1 2 3))))))
506 (with-test-prefix/compile "Macros"
508 (pass-if-equal "defmacro value" 'magic-number
509 (defmacro magic-number () 42))
511 (pass-if-equal "macro expansion" 1
512 (progn (defmacro take-first (a b) a)
513 (take-first 1 (/ 1 0)))))
516 ; Test the built-ins.
517 ; ===================
519 (with-test-prefix/compile "Equivalence Predicates"
522 (and (equal 2 2) (not (equal 1 2))
523 (equal "abc" "abc") (not (equal "abc" "ABC"))
524 (equal 'abc 'abc) (not (equal 'abc 'def))
525 (equal '(1 2 (3 4) 5) '(1 2 (3 4) 5))
526 (not (equal '(1 2 3 4 5) '(1 2 (3 4) 5)))))
529 (progn (setq some-list '(1 2))
530 (setq some-string "abc")
531 (and (eq 2 2) (not (eq 1 2))
532 (eq 'abc 'abc) (not (eq 'abc 'def))
533 (eq some-string some-string) (not (eq some-string (string 97 98 99)))
534 (eq some-list some-list) (not (eq some-list (list 1 2)))))))
536 (with-test-prefix/compile "Number Built-Ins"
539 (and (floatp 1.0) (not (floatp 1)) (not (floatp 'a))))
541 (and (integerp 42) (integerp -2) (not (integerp 1.0))))
543 (and (numberp 1.0) (numberp -2) (not (numberp 'a))))
545 (and (wholenump 0) (not (wholenump -2)) (not (wholenump 1.0))))
547 (and (zerop 0) (zerop 0.0) (not (zerop 1))))
549 (pass-if "comparisons"
550 (and (= 1 1.0) (/= 0 1)
551 (< 1 2) (> 2 1) (>= 1 1) (<= 1 1)
552 (not (< 1 1)) (not (<= 2 1))))
554 (pass-if "max and min"
555 (and (= (max -5 2 4.0 1) 4.0) (= (min -5 2 4.0 1) -5)
556 (= (max 1) 1) (= (min 1) 1)))
558 (and (= (abs 1.0) 1.0) (= (abs -5) 5)))
561 (and (= (float 1) 1) (= (float 5.5) 5.5)
564 (pass-if-equal "basic arithmetic operators" -8.5
565 (+ (1+ 0) (1- 0) (- 5.5) (* 2 -2) (- 2 1)))
569 (pass-if "floating point rounding"
570 (and (= (ffloor 1.7) 1.0) (= (ffloor -1.2) -2.0) (= (ffloor 1.0) 1.0)
571 (= (fceiling 1.2) 2.0) (= (fceiling -1.7) -1.0) (= (fceiling 1.0) 1.0)
572 (= (ftruncate 1.6) 1.0) (= (ftruncate -1.7) -1.0)
573 (= (fround 1.2) 1.0) (= (fround 1.7) 2.0) (= (fround -1.7) -2.0))))
575 (with-test-prefix/compile "List Built-Ins"
577 (pass-if "consp and atom"
578 (and (consp '(1 2 3)) (consp '(1 2 . 3)) (consp '(a . b))
579 (not (consp '())) (not (consp 1)) (not (consp "abc"))
580 (atom 'a) (atom '()) (atom -1.5) (atom "abc")
581 (not (atom '(1 . 2))) (not (atom '(1)))))
582 (pass-if "listp and nlistp"
583 (and (listp '(1 2 3)) (listp '(1)) (listp '()) (listp '(1 . 2))
584 (not (listp 'a)) (not (listp 42)) (nlistp 42)
585 (not (nlistp '())) (not (nlistp '(1 2 3))) (not (nlistp '(1 . 2)))))
587 (and (null '()) (not (null 1)) (not (null '(1 2))) (not (null '(1 . 2)))))
589 (pass-if "car and cdr"
590 (and (equal (car '(1 2 3)) 1) (equal (cdr '(1 2 3)) '(2 3))
591 (equal (car '()) nil) (equal (cdr '()) nil)
592 (equal (car '(1 . 2)) 1) (equal (cdr '(1 . 2)) 2)
594 (pass-if "car-safe and cdr-safe"
595 (and (equal (car-safe '(1 2)) 1) (equal (cdr-safe '(1 2)) '(2))
596 (equal (car-safe 5) nil) (equal (cdr-safe 5) nil)))
598 (pass-if "nth and nthcdr"
599 (and (equal (nth -5 '(1 2 3)) 1) (equal (nth 3 '(1 2 3)) nil)
600 (equal (nth 0 '(1 2 3)) 1) (equal (nth 2 '(1 2 3)) 3)
601 (equal (nthcdr -5 '(1 2 3)) '(1 2 3))
602 (equal (nthcdr 4 '(1 2 3)) nil)
603 (equal (nthcdr 1 '(1 2 3)) '(2 3))
604 (equal (nthcdr 2 '(1 2 3)) '(3))))
607 (and (= (length '()) 0)
608 (= (length '(1 2 3 4 5)) 5)
609 (= (length '(1 2 (3 4 (5)) 6)) 4)))
611 (pass-if "cons, list and make-list"
612 (and (equal (cons 1 2) '(1 . 2)) (equal (cons 1 '(2 3)) '(1 2 3))
613 (equal (cons 1 '()) '(1))
614 (equal (list 'a) '(a)) (equal (list) '()) (equal (list 1 2) '(1 2))
615 (equal (make-list 3 42) '(42 42 42))
616 (equal (make-list 0 1) '())))
618 (and (equal (append '(1 2) '(3 4) '(5)) '(1 2 3 4 5))
619 (equal (append '(1 2) 3) '(1 2 . 3))))
621 (and (equal (reverse '(5 4 3 2 1)) '(1 2 3 4 5))
622 (equal (reverse '()) '())))
623 (pass-if "setcar and setcdr"
624 (progn (setq pair '(1 . 2))
626 (setq a (setcar copy 3))
627 (setq b (setcdr copy 4))
629 (equal pair '(3 . 4))))))