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)))
40 ((_ (expect-fail test-name exp))
43 (define-syntax with-test-prefix/compile
45 ((_ section-name exp ...)
46 (with-test-prefix section-name (compile-test exp) ...))))
49 ; Test control structures.
50 ; ========================
52 (compile '(%set-lexical-binding-mode #nil) #:from 'elisp #:to 'value)
54 (with-test-prefix/compile "Sequencing"
56 (pass-if-equal "progn" 1
61 (pass-if-equal "empty progn" #nil
66 (setq b (prog1 a (setq a (1+ a))))
67 (and (= a 1) (= b 0))))
71 (setq b (prog2 (setq a (1+ a))
74 (and (= a 3) (= b 2)))))
76 (with-test-prefix/compile "Conditionals"
78 (pass-if-equal "succeeding if" 1
83 (setq a 2) (setq a (1+ a)) a)
85 (equal (if nil 1) nil)))
87 (pass-if-equal "if with no else" #nil
90 (pass-if-equal "empty cond" nil-value
92 (pass-if-equal "all failing cond" nil-value
94 (pass-if-equal "only condition" 5
96 (pass-if-equal "succeeding cond value" 42
97 (cond (nil) (t 42) (t 0)))
98 (pass-if-equal "succeeding cond side-effect" 42
100 (cond (nil) (t (setq a 42) 1) (t (setq a 0)))
103 (with-test-prefix/compile "Combining Conditions"
105 (pass-if-equal "empty and" t-value (and))
106 (pass-if-equal "failing and" nil-value (and 1 2 nil 3))
107 (pass-if-equal "succeeding and" 3 (and 1 2 3))
109 (pass-if-equal "empty or" nil-value (or))
110 (pass-if-equal "failing or" nil-value (or nil nil nil))
111 (pass-if-equal "succeeding or" 1 (or nil 1 nil 2 nil 3))
113 (pass-if-equal "not true" nil-value (not 1))
114 (pass-if-equal "not false" t-value (not nil)))
116 (with-test-prefix/compile "Iteration"
118 (pass-if-equal "failing while" 0
120 (while nil (setq a 1))
122 (pass-if-equal "running while" 120
126 (setq prod (* i prod))
130 (with-test-prefix/compile "Exceptions"
132 (pass-if "catch without exception"
139 (= (catch (+ 1 2) a) 2)))
141 ; FIXME: Figure out how to do this...
142 ;(pass-if-exception "uncaught exception" 'elisp-exception
145 (pass-if "catch and throw"
146 (and (setq mylist '(1 2))
147 (= (catch 'abc (throw 'abc 2) 1) 2)
148 (= (catch 'abc (catch 'def (throw 'abc (1+ 0)) 2) 3) 1)
149 (= (catch 'abc (catch 'def (throw 'def 1) 2) 3) 3)
150 (= (catch mylist (catch (list 1 2) (throw mylist 1) 2) 3) 1)))
152 (pass-if "unwind-protect"
153 (progn (setq a 0 b 1 c 1)
155 (unwind-protect (progn (setq a 1)
159 (unwind-protect nil (setq c 0))
160 (and (= a 0) (= b 0) (= c 0)
161 (= (unwind-protect 42 1 2 3) 42)))))
163 (with-test-prefix/compile "Eval"
165 (pass-if-equal "basic eval" 3
166 (progn (setq code '(+ 1 2))
169 (pass-if "real dynamic code"
170 (and (setq a 1 b 1 c 1)
171 (defun set-code (var val)
172 (list 'setq var val))
173 (= a 1) (= b 1) (= c 1)
174 (eval (set-code 'a '(+ 2 3)))
175 (eval (set-code 'c 42))
176 (= a 5) (= b 1) (= c 42)))
178 ; Build code that recursively again and again calls eval. What we want is
180 ; (eval '(1+ (eval '(1+ (eval 1)))))
181 (pass-if "recursive eval"
182 (progn (setq depth 10 i depth)
183 (setq code '(eval 0))
184 (while (not (zerop i))
185 (setq code (#{`}# (eval (quote (1+ (#{,}# code))))))
187 (= (eval code) depth))))
190 ; Test handling of variables.
191 ; ===========================
193 (with-test-prefix/compile "Variable Setting/Referencing"
195 ; TODO: Check for variable-void error
197 (pass-if-equal "setq and reference" 6
198 (progn (setq a 1 b 2 c 3)
200 (pass-if-equal "setq evaluation order" 1
201 (progn (setq a 0 b 0)
203 (pass-if-equal "setq value" 2
204 (progn (setq a 1 b 2)))
206 (pass-if "set and symbol-value"
207 (progn (setq myvar 'a)
208 (and (= (set myvar 42) 42)
210 (= (symbol-value myvar) 42))))
211 (pass-if "void variables"
212 (progn (setq a 1 b 2)
213 (and (eq (makunbound 'b) 'b)
215 (not (boundp 'b))))))
217 (with-test-prefix/compile "Let and Let*"
219 (pass-if-equal "let without value" nil-value
221 (pass-if-equal "basic let" 0
227 (pass-if-equal "empty let" #nil (let ()))
236 (and (= a 1) (= b 2)))
240 (pass-if-equal "empty let*" #nil
243 (pass-if "local scope"
251 (with-test-prefix/compile "Lexical Scoping"
253 (pass-if "basic let semantics"
255 (lexical-let ((a 2) (b a))
256 (and (= a 2) (= b 1)))
257 (lexical-let* ((a 2) (b a))
258 (and (= a 2) (= b 2) (setq a 42) (= a 42)))
261 (pass-if "lexical scope with lexical-let's"
266 (and (= a 2) (= (dyna) 1)))
270 (and (= a 2) (= (dyna) 1)))
273 (pass-if "lexical scoping vs. symbol-value / set"
277 (= (symbol-value 'a) 1)
280 (= (symbol-value 'a) 3)))
283 (pass-if "let inside lexical-let"
285 (defun dynvals () (cons a b))
287 (and (= a 2) (equal (dynvals) '(1 . 1))
289 (declare (lexical a))
291 (equal (dynvals) '(1 . 2))))
293 (declare (lexical a))
295 (equal (dynvals) '(1 . 4))))
299 (pass-if "lambda args inside lexical-let"
302 (lexical-let ((a 2) (b 42))
303 (and (= a 2) (= (dyna) 1)
305 (declare (lexical a))
306 (and (= a 3) (= b 42) (= (dyna) 1))) 3)
307 ((lambda () (let ((a 3))
308 (declare (lexical a))
309 (and (= a 3) (= (dyna) 1)))))
310 (= a 2) (= (dyna) 1)))
314 (and (defun make-counter ()
315 (lexical-let ((cnt 0))
317 (setq cnt (1+ cnt)))))
318 (setq c1 (make-counter) c2 (make-counter))
327 (pass-if "lexical lambda args"
328 (progn (setq a 1 b 1)
332 ((lambda (a b &optional c)
333 (declare (lexical a c))
334 (and (= a 3) (= (dyna) 1)
339 ; Check if a lambda without dynamically bound arguments
340 ; is tail-optimized by doing a deep recursion that would otherwise overflow
342 (pass-if "lexical lambda tail-recursion"
345 (defun iteration-1 (i)
346 (declare (lexical i))
348 (iteration-1 (1+ i))))
351 (defun iteration-2 ()
359 (with-test-prefix/compile "defconst and defvar"
361 (pass-if-equal "defconst without docstring" 3.141
365 (pass-if-equal "defconst value" 'pi
366 (defconst pi 3.141 "Pi"))
368 (pass-if-equal "defvar without value" 42
372 (pass-if-equal "defvar on already defined variable" 42
374 (defvar a 1 "Some docstring is also ok")
376 (pass-if-equal "defvar on undefined variable" 1
377 (progn (makunbound 'a)
380 (pass-if-equal "defvar value" 'a
384 ; Functions and lambda expressions.
385 ; =================================
387 (with-test-prefix/compile "Lambda Expressions"
389 (pass-if-equal "required arguments" 3
390 ((lambda (a b c) c) 1 2 3))
392 (pass-if-equal "optional argument" 3
393 ((lambda (a &optional b c) c) 1 2 3))
394 (pass-if-equal "optional missing" nil-value
395 ((lambda (&optional a) a)))
397 (pass-if-equal "rest argument" '(3 4 5)
398 ((lambda (a b &rest c) c) 1 2 3 4 5))
399 (pass-if "rest missing"
400 (null ((lambda (a b &rest c) c) 1 2)))
402 (pass-if-equal "empty lambda" #nil
405 (with-test-prefix/compile "Function Definitions"
407 (pass-if-equal "defun" 3
408 (progn (defun test (a b) (+ a b))
410 (pass-if-equal "defun value" 'test
411 (defun test (a b) (+ a b)))
413 (pass-if "fset and symbol-function"
414 (progn (setq myfunc 'x x 5)
415 (and (= (fset myfunc 42) 42)
416 (= (symbol-function myfunc) 42)
418 (pass-if "void function values"
420 (defun test (a b) (+ a b))
423 (and (fboundp 'b) (fboundp 'test)
428 (progn (defun foobar () 42)
429 (defun test () (foobar))
433 (funcall (symbol-function 'foobar))))
436 (flet ((foobar () nil))
441 (with-test-prefix/compile "Calling Functions"
443 (pass-if-equal "recursion" 120
444 (progn (defun factorial (n prod)
447 (factorial (1- n) (* prod n))))
450 (pass-if "dynamic scoping"
460 (pass-if "funcall and apply argument handling"
461 (and (defun allid (&rest args) args)
462 (setq allid-var (symbol-function 'allid))
463 (equal (funcall allid-var 1 2 3) '(1 2 3))
464 (equal (funcall allid-var) nil)
465 (equal (funcall allid-var 1 2 '(3 4)) '(1 2 (3 4)))
466 (equal (funcall allid-var '()) '(()))
467 (equal (apply allid-var 1 2 '(3 4)) '(1 2 3 4))
468 (equal (apply allid-var '(1 2)) '(1 2))
469 (equal (apply allid-var '()) nil)))
471 (pass-if "raw functions with funcall"
472 (and (= (funcall '+ 1 2) 3)
473 (= (funcall (lambda (a b) (+ a b)) 1 2) 3)
474 (= (funcall '(lambda (a b) (+ a b)) 1 2) 3))))
477 ; Quoting and Backquotation.
478 ; ==========================
480 (with-test-prefix/compile "Quotation"
483 (and (equal '42 42) (equal '"abc" "abc")
484 (equal '(1 2 (3 (4) x)) '(1 2 (3 (4) x)))
485 (not (equal '(1 2 (3 4 (x))) '(1 2 3 4 x)))
486 (equal '(1 2 . 3) '(1 2 . 3))))
488 (pass-if "simple backquote"
489 (and (equal (#{`}# 42) 42)
490 (equal (#{`}# (1 (a))) '(1 (a)))
491 (equal (#{`}# (1 . 2)) '(1 . 2))))
493 (progn (setq a 42 l '(18 12))
494 (and (equal (#{`}# (#{,}# a)) 42)
495 (equal (#{`}# (1 a ((#{,}# l)) . (#{,}# a))) '(1 a ((18 12)) . 42)))))
496 (pass-if "unquote splicing"
497 (progn (setq l '(18 12) empty '())
498 (and (equal (#{`}# (#{,@}# l)) '(18 12))
499 (equal (#{`}# (l 2 (3 (#{,@}# l)) ((#{,@}# l)) (#{,@}# l)))
500 '(l 2 (3 18 12) (18 12) 18 12))
501 (equal (#{`}# (1 2 (#{,@}# empty) 3)) '(1 2 3))))))
508 (with-test-prefix/compile "Macros"
510 (pass-if-equal "defmacro value" 'magic-number
511 (defmacro magic-number () 42))
513 (pass-if-equal "macro expansion" 1
514 (progn (defmacro take-first (a b) a)
515 (take-first 1 (/ 1 0)))))
518 ; Test the built-ins.
519 ; ===================
521 (with-test-prefix/compile "Equivalence Predicates"
524 (and (equal 2 2) (not (equal 1 2))
525 (equal "abc" "abc") (not (equal "abc" "ABC"))
526 (equal 'abc 'abc) (not (equal 'abc 'def))
527 (equal '(1 2 (3 4) 5) '(1 2 (3 4) 5))
528 (not (equal '(1 2 3 4 5) '(1 2 (3 4) 5)))))
531 (progn (setq some-list '(1 2))
532 (setq some-string "abc")
533 (and (eq 2 2) (not (eq 1 2))
534 (eq 'abc 'abc) (not (eq 'abc 'def))
535 (eq some-string some-string) (not (eq some-string (string 97 98 99)))
536 (eq some-list some-list) (not (eq some-list (list 1 2)))))))
538 (with-test-prefix/compile "Number Built-Ins"
541 (and (floatp 1.0) (not (floatp 1)) (not (floatp 'a))))
543 (and (integerp 42) (integerp -2) (not (integerp 1.0))))
545 (and (numberp 1.0) (numberp -2) (not (numberp 'a))))
547 (and (wholenump 0) (not (wholenump -2)) (not (wholenump 1.0))))
549 (and (zerop 0) (zerop 0.0) (not (zerop 1))))
551 (pass-if "comparisons"
552 (and (= 1 1.0) (/= 0 1)
553 (< 1 2) (> 2 1) (>= 1 1) (<= 1 1)
554 (not (< 1 1)) (not (<= 2 1))))
556 (pass-if "max and min"
557 (and (= (max -5 2 4.0 1) 4.0) (= (min -5 2 4.0 1) -5)
558 (= (max 1) 1) (= (min 1) 1)))
560 (and (= (abs 1.0) 1.0) (= (abs -5) 5)))
563 (and (= (float 1) 1) (= (float 5.5) 5.5)
566 (pass-if-equal "basic arithmetic operators" -8.5
567 (+ (1+ 0) (1- 0) (- 5.5) (* 2 -2) (- 2 1)))
571 (pass-if "floating point rounding"
572 (and (= (ffloor 1.7) 1.0) (= (ffloor -1.2) -2.0) (= (ffloor 1.0) 1.0)
573 (= (fceiling 1.2) 2.0) (= (fceiling -1.7) -1.0) (= (fceiling 1.0) 1.0)
574 (= (ftruncate 1.6) 1.0) (= (ftruncate -1.7) -1.0)
575 (= (fround 1.2) 1.0) (= (fround 1.7) 2.0) (= (fround -1.7) -2.0))))
577 (with-test-prefix/compile "List Built-Ins"
579 (pass-if "consp and atom"
580 (and (consp '(1 2 3)) (consp '(1 2 . 3)) (consp '(a . b))
581 (not (consp '())) (not (consp 1)) (not (consp "abc"))
582 (atom 'a) (atom '()) (atom -1.5) (atom "abc")
583 (not (atom '(1 . 2))) (not (atom '(1)))))
584 (pass-if "listp and nlistp"
585 (and (listp '(1 2 3)) (listp '(1)) (listp '()) (listp '(1 . 2))
586 (not (listp 'a)) (not (listp 42)) (nlistp 42)
587 (not (nlistp '())) (not (nlistp '(1 2 3))) (not (nlistp '(1 . 2)))))
589 (and (null '()) (not (null 1)) (not (null '(1 2))) (not (null '(1 . 2)))))
591 (pass-if "car and cdr"
592 (and (equal (car '(1 2 3)) 1) (equal (cdr '(1 2 3)) '(2 3))
593 (equal (car '()) nil) (equal (cdr '()) nil)
594 (equal (car '(1 . 2)) 1) (equal (cdr '(1 . 2)) 2)
596 (pass-if "car-safe and cdr-safe"
597 (and (equal (car-safe '(1 2)) 1) (equal (cdr-safe '(1 2)) '(2))
598 (equal (car-safe 5) nil) (equal (cdr-safe 5) nil)))
600 (pass-if "nth and nthcdr"
601 (and (equal (nth -5 '(1 2 3)) 1) (equal (nth 3 '(1 2 3)) nil)
602 (equal (nth 0 '(1 2 3)) 1) (equal (nth 2 '(1 2 3)) 3)
603 (equal (nthcdr -5 '(1 2 3)) '(1 2 3))
604 (equal (nthcdr 4 '(1 2 3)) nil)
605 (equal (nthcdr 1 '(1 2 3)) '(2 3))
606 (equal (nthcdr 2 '(1 2 3)) '(3))))
609 (and (= (length '()) 0)
610 (= (length '(1 2 3 4 5)) 5)
611 (= (length '(1 2 (3 4 (5)) 6)) 4)))
613 (pass-if "cons, list and make-list"
614 (and (equal (cons 1 2) '(1 . 2)) (equal (cons 1 '(2 3)) '(1 2 3))
615 (equal (cons 1 '()) '(1))
616 (equal (list 'a) '(a)) (equal (list) '()) (equal (list 1 2) '(1 2))
617 (equal (make-list 3 42) '(42 42 42))
618 (equal (make-list 0 1) '())))
620 (and (equal (append '(1 2) '(3 4) '(5)) '(1 2 3 4 5))
621 (equal (append '(1 2) 3) '(1 2 . 3))))
623 (and (equal (reverse '(5 4 3 2 1)) '(1 2 3 4 5))
624 (equal (reverse '()) '())))
625 (pass-if "setcar and setcdr"
626 (progn (setq pair '(1 . 2))
628 (setq a (setcar copy 3))
629 (setq b (setcdr copy 4))
631 (equal pair '(3 . 4))))))