;;; bytecomp-tests.el -*- lexical-binding:t -*-
;; Copyright (C) 2008-2020 Free Software Foundation, Inc.
;; Author: Shigeru Fukaya <shigeru.fukaya@gmail.com>
;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
;; Created: November 2008
;; Keywords: internal
;; Human-Keywords: internal
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
(require 'ert)
(require 'cl-lib)
(require 'subr-x)
(require 'bytecomp)
;;; Code:
(defconst byte-opt-testsuite-arith-data
'(
;; some functional tests
(let ((a most-positive-fixnum) (b 1) (c 1.0)) (+ a b c))
(let ((a most-positive-fixnum) (b -2) (c 1.0)) (- a b c))
(let ((a most-positive-fixnum) (b 2) (c 1.0)) (* a b c))
(let ((a 3) (b 2) (c 1.0)) (/ a b c))
(let ((a (+ 1 (expt 2 -64))) (b (expt 2 -65))) (+ a -1 b))
(let ((a (+ 1 (expt 2 -64))) (b (expt 2 -65))) (- a 1 (- b)))
(let ((a (expt 2 -1074)) (b 0.125)) (* a 8 b))
(let ((a 1.0)) (* a 0))
(let ((a 1.0)) (* a 2.0 0))
(let ((a 1.0)) (/ 0 a))
(let ((a 1.0)) (/ 3 a 2))
(let ((a most-positive-fixnum) (b 2.0)) (* a 2 b))
(let ((a 3) (b 2)) (/ a b 1.0))
(let ((a -0.0)) (+ a))
(let ((a -0.0)) (- a))
(let ((a -0.0)) (* a))
(let ((a -0.0)) (min a))
(let ((a -0.0)) (max a))
(/ 3 -1)
(+ 4 3 2 1)
(+ 4 3 2.0 1)
(- 4 3 2 1) ; not new, for reference
(- 4 3 2.0 1) ; not new, for reference
(* 4 3 2 1)
(* 4 3 2.0 1)
(/ 4 3 2 1)
(/ 4 3 2.0 1)
(let ((a 3) (b 2)) (+ a b 1))
(let ((a 3) (b 2)) (+ a b -1))
(let ((a 3) (b 2)) (- a b 1))
(let ((a 3) (b 2)) (- a b -1))
(let ((a 3) (b 2)) (+ a b a 1))
(let ((a 3) (b 2)) (+ a b a -1))
(let ((a 3) (b 2)) (- a b a 1))
(let ((a 3) (b 2)) (- a b a -1))
(let ((a 3) (b 2)) (* a b -1))
(let ((a 3) (b 2)) (* a -1))
(let ((a 3) (b 2)) (/ a b 1))
(let ((a 3) (b 2)) (/ (+ a b) 1))
;; coverage test
(let ((a 3) (b 2) (c 1.0)) (+))
(let ((a 3) (b 2) (c 1.0)) (+ 2))
(let ((a 3) (b 2) (c 1.0)) (+ 2 0))
(let ((a 3) (b 2) (c 1.0)) (+ 2 0.0))
(let ((a 3) (b 2) (c 1.0)) (+ 2.0))
(let ((a 3) (b 2) (c 1.0)) (+ 2.0 0))
(let ((a 3) (b 2) (c 1.0)) (+ 2.0 0.0))
(let ((a 3) (b 2) (c 1.0)) (+ 0 2))
(let ((a 3) (b 2) (c 1.0)) (+ 0 2.0))
(let ((a 3) (b 2) (c 1.0)) (+ 0.0 2))
(let ((a 3) (b 2) (c 1.0)) (+ 0.0 2.0))
(let ((a 3) (b 2) (c 1.0)) (+ a))
(let ((a 3) (b 2) (c 1.0)) (+ a 0))
(let ((a 3) (b 2) (c 1.0)) (+ a 0.0))
(let ((a 3) (b 2) (c 1.0)) (+ 0 a))
(let ((a 3) (b 2) (c 1.0)) (+ 0.0 a))
(let ((a 3) (b 2) (c 1.0)) (+ c 0))
(let ((a 3) (b 2) (c 1.0)) (+ c 0.0))
(let ((a 3) (b 2) (c 1.0)) (+ 0 c))
(let ((a 3) (b 2) (c 1.0)) (+ 0.0 c))
(let ((a 3) (b 2) (c 1.0)) (+ a b 0 c 0))
(let ((a 3) (b 2) (c 1.0)) (+ 0 a))
(let ((a 3) (b 2) (c 1.0)) (+ 0 a b))
(let ((a 3) (b 2) (c 1.0)) (+ 0 a b c))
(let ((a 3) (b 2) (c 1.0)) (+ 1 2 3))
(let ((a 3) (b 2) (c 1.0)) (+ 3.0 2.0 1))
(let ((a 3) (b 2) (c 1.0)) (+ 3.0 2.0 1 4))
(let ((a 3) (b 2) (c 1.0)) (+ a 1))
(let ((a 3) (b 2) (c 1.0)) (+ a -1))
(let ((a 3) (b 2) (c 1.0)) (+ 1 a))
(let ((a 3) (b 2) (c 1.0)) (+ -1 a))
(let ((a 3) (b 2) (c 1.0)) (+ c 1))
(let ((a 3) (b 2) (c 1.0)) (+ c -1))
(let ((a 3) (b 2) (c 1.0)) (+ 1 c))
(let ((a 3) (b 2) (c 1.0)) (+ -1 c))
(let ((a 3) (b 2) (c 1.0)) (+ a b 0))
(let ((a 3) (b 2) (c 1.0)) (+ a b 1))
(let ((a 3) (b 2) (c 1.0)) (+ a b -1))
(let ((a 3) (b 2) (c 1.0)) (+ a b 2))
(let ((a 3) (b 2) (c 1.0)) (+ 1 a b c))
(let ((a 3) (b 2) (c 1.0)) (+ a b c 0))
(let ((a 3) (b 2) (c 1.0)) (+ a b c 1))
(let ((a 3) (b 2) (c 1.0)) (+ a b c -1))
(let ((a 3) (b 2) (c 1.0)) (-))
(let ((a 3) (b 2) (c 1.0)) (- 2))
(let ((a 3) (b 2) (c 1.0)) (- 2 0))
(let ((a 3) (b 2) (c 1.0)) (- 2 0.0))
(let ((a 3) (b 2) (c 1.0)) (- 2.0))
(let ((a 3) (b 2) (c 1.0)) (- 2.0 0))
(let ((a 3) (b 2) (c 1.0)) (- 2.0 0.0))
(let ((a 3) (b 2) (c 1.0)) (- 0 2))
(let ((a 3) (b 2) (c 1.0)) (- 0 2.0))
(let ((a 3) (b 2) (c 1.0)) (- 0.0 2))
(let ((a 3) (b 2) (c 1.0)) (- 0.0 2.0))
(let ((a 3) (b 2) (c 1.0)) (- a))
(let ((a 3) (b 2) (c 1.0)) (- a 0))
(let ((a 3) (b 2) (c 1.0)) (- a 0.0))
(let ((a 3) (b 2) (c 1.0)) (- 0 a))
(let ((a 3) (b 2) (c 1.0)) (- 0.0 a))
(let ((a 3) (b 2) (c 1.0)) (- c 0))
(let ((a 3) (b 2) (c 1.0)) (- c 0.0))
(let ((a 3) (b 2) (c 1.0)) (- 0 c))
(let ((a 3) (b 2) (c 1.0)) (- 0.0 c))
(let ((a 3) (b 2) (c 1.0)) (- a b 0 c 0))
(let ((a 3) (b 2) (c 1.0)) (- 0 a))
(let ((a 3) (b 2) (c 1.0)) (- 0 a b))
(let ((a 3) (b 2) (c 1.0)) (- 0 a b c))
(let ((a 3) (b 2) (c 1.0)) (- 1 2 3))
(let ((a 3) (b 2) (c 1.0)) (- 3.0 2.0 1))
(let ((a 3) (b 2) (c 1.0)) (- 3.0 2.0 1 4))
(let ((a 3) (b 2) (c 1.0)) (- a 1))
(let ((a 3) (b 2) (c 1.0)) (- a -1))
(let ((a 3) (b 2) (c 1.0)) (- 1 a))
(let ((a 3) (b 2) (c 1.0)) (- -1 a))
(let ((a 3) (b 2) (c 1.0)) (- c 1))
(let ((a 3) (b 2) (c 1.0)) (- c -1))
(let ((a 3) (b 2) (c 1.0)) (- 1 c))
(let ((a 3) (b 2) (c 1.0)) (- -1 c))
(let ((a 3) (b 2) (c 1.0)) (- a b 0))
(let ((a 3) (b 2) (c 1.0)) (- a b 1))
(let ((a 3) (b 2) (c 1.0)) (- a b -1))
(let ((a 3) (b 2) (c 1.0)) (- a b 2))
(let ((a 3) (b 2) (c 1.0)) (- 1 a b c))
(let ((a 3) (b 2) (c 1.0)) (- a b c 0))
(let ((a 3) (b 2) (c 1.0)) (- a b c 1))
(let ((a 3) (b 2) (c 1.0)) (- a b c -1))
(let ((a 3) (b 2) (c 1.0)) (*))
(let ((a 3) (b 2) (c 1.0)) (* 2))
(let ((a 3) (b 2) (c 1.0)) (* 2 0))
(let ((a 3) (b 2) (c 1.0)) (* 2 0.0))
(let ((a 3) (b 2) (c 1.0)) (* 2.0))
(let ((a 3) (b 2) (c 1.0)) (* 2.0 0))
(let ((a 3) (b 2) (c 1.0)) (* 2.0 0.0))
(let ((a 3) (b 2) (c 1.0)) (* 0 2))
(let ((a 3) (b 2) (c 1.0)) (* 0 2.0))
(let ((a 3) (b 2) (c 1.0)) (* 0.0 2))
(let ((a 3) (b 2) (c 1.0)) (* 0.0 2.0))
(let ((a 3) (b 2) (c 1.0)) (* a))
(let ((a 3) (b 2) (c 1.0)) (* a 0))
(let ((a 3) (b 2) (c 1.0)) (* a 0.0))
(let ((a 3) (b 2) (c 1.0)) (* 0 a))
(let ((a 3) (b 2) (c 1.0)) (* 0.0 a))
(let ((a 3) (b 2) (c 1.0)) (* c 0))
(let ((a 3) (b 2) (c 1.0)) (* c 0.0))
(let ((a 3) (b 2) (c 1.0)) (* 0 c))
(let ((a 3) (b 2) (c 1.0)) (* 0.0 c))
(let ((a 3) (b 2) (c 1.0)) (* a b 0 c 0))
(let ((a 3) (b 2) (c 1.0)) (* 0 a))
(let ((a 3) (b 2) (c 1.0)) (* 0 a b))
(let ((a 3) (b 2) (c 1.0)) (* 0 a b c))
(let ((a 3) (b 2) (c 1.0)) (* 1 2 3))
(let ((a 3) (b 2) (c 1.0)) (* 3.0 2.0 1))
(let ((a 3) (b 2) (c 1.0)) (* 3.0 2.0 1 4))
(let ((a 3) (b 2) (c 1.0)) (* a 1))
(let ((a 3) (b 2) (c 1.0)) (* a -1))
(let ((a 3) (b 2) (c 1.0)) (* 1 a))
(let ((a 3) (b 2) (c 1.0)) (* -1 a))
(let ((a 3) (b 2) (c 1.0)) (* c 1))
(let ((a 3) (b 2) (c 1.0)) (* c -1))
(let ((a 3) (b 2) (c 1.0)) (* 1 c))
(let ((a 3) (b 2) (c 1.0)) (* -1 c))
(let ((a 3) (b 2) (c 1.0)) (* a b 0))
(let ((a 3) (b 2) (c 1.0)) (* a b 1))
(let ((a 3) (b 2) (c 1.0)) (* a b -1))
(let ((a 3) (b 2) (c 1.0)) (* a b 2))
(let ((a 3) (b 2) (c 1.0)) (* 1 a b c))
(let ((a 3) (b 2) (c 1.0)) (* a b c 0))
(let ((a 3) (b 2) (c 1.0)) (* a b c 1))
(let ((a 3) (b 2) (c 1.0)) (* a b c -1))
(let ((a 3) (b 2) (c 1.0)) (/))
(let ((a 3) (b 2) (c 1.0)) (/ 2))
(let ((a 3) (b 2) (c 1.0)) (/ 2 0))
(let ((a 3) (b 2) (c 1.0)) (/ 2 0.0))
(let ((a 3) (b 2) (c 1.0)) (/ 2.0))
(let ((a 3) (b 2) (c 1.0)) (/ 2.0 0))
(let ((a 3) (b 2) (c 1.0)) (/ 2.0 0.0))
(let ((a 3) (b 2) (c 1.0)) (/ 0 2))
(let ((a 3) (b 2) (c 1.0)) (/ 0 2.0))
(let ((a 3) (b 2) (c 1.0)) (/ 0.0 2))
(let ((a 3) (b 2) (c 1.0)) (/ 0.0 2.0))
(let ((a 3) (b 2) (c 1.0)) (/ a))
(let ((a 3) (b 2) (c 1.0)) (/ a 0))
(let ((a 3) (b 2) (c 1.0)) (/ a 0.0))
(let ((a 3) (b 2) (c 1.0)) (/ 0 a))
(let ((a 3) (b 2) (c 1.0)) (/ 0.0 a))
(let ((a 3) (b 2) (c 1.0)) (/ c 0))
(let ((a 3) (b 2) (c 1.0)) (/ c 0.0))
(let ((a 3) (b 2) (c 1.0)) (/ 0 c))
(let ((a 3) (b 2) (c 1.0)) (/ 0.0 c))
(let ((a 3) (b 2) (c 1.0)) (/ a b 0 c 0))
(let ((a 3) (b 2) (c 1.0)) (/ 0 a))
(let ((a 3) (b 2) (c 1.0)) (/ 0 a b))
(let ((a 3) (b 2) (c 1.0)) (/ 0 a b c))
(let ((a 3) (b 2) (c 1.0)) (/ 1 2 3))
(let ((a 3) (b 2) (c 1.0)) (/ 3.0 2.0 1))
(let ((a 3) (b 2) (c 1.0)) (/ 3.0 2.0 1 4))
(let ((a 3) (b 2) (c 1.0)) (/ a 1))
(let ((a 3) (b 2) (c 1.0)) (/ a -1))
(let ((a 3) (b 2) (c 1.0)) (/ 1 a))
(let ((a 3) (b 2) (c 1.0)) (/ -1 a))
(let ((a 3) (b 2) (c 1.0)) (/ c 1))
(let ((a 3) (b 2) (c 1.0)) (/ c -1))
(let ((a 3) (b 2) (c 1.0)) (/ 1 c))
(let ((a 3) (b 2) (c 1.0)) (/ -1 c))
(let ((a 3) (b 2) (c 1.0)) (/ a b 0))
(let ((a 3) (b 2) (c 1.0)) (/ a b 1))
(let ((a 3) (b 2) (c 1.0)) (/ a b -1))
(let ((a 3) (b 2) (c 1.0)) (/ a b 2))
(let ((a 3) (b 2) (c 1.0)) (/ 1 a b c))
(let ((a 3) (b 2) (c 1.0)) (/ a b c 0))
(let ((a 3) (b 2) (c 1.0)) (/ a b c 1))
(let ((a 3) (b 2) (c 1.0)) (/ a b c -1))
(let ((a t)) (logand 0 a))
;; Test switch bytecode
(let ((a 3)) (cond ((eq a 1) 'one) ((eq a 2) 'two) ((eq a 3) 'three) (t t)))
(let ((a 'three)) (cond ((eq a 'one) 1) ((eq a 2) 'two) ((eq a 'three) 3)
(t t)))
(let ((a 2)) (cond ((eq a 'one) 1) ((eq a 1) 'one) ((eq a 2) 'two)
(t nil)))
(let ((a 2.0)) (cond ((eql a 2) 'incorrect) ((eql a 2.00) 'correct)))
(let ((a "foobar")) (cond ((equal "notfoobar" a) 'incorrect)
((equal 1 a) 'incorrect)
((equal a "foobar") 'correct)
(t 'incorrect)))
(let ((a "foobar") (l t)) (pcase a
("bar" 'incorrect)
("foobar" (while l
a (setq l nil))
'correct)))
(let ((a 'foobar) (l t)) (cl-case a
('foo 'incorrect)
('bar 'incorrect)
('foobar (while l
a (setq l nil))
'correct)))
(let ((a 'foobar) (l t)) (cond
((eq a 'bar) 'incorrect)
((eq a 'foo) 'incorrect)
((eq a 'bar) 'incorrect)
(t (while l
a (setq l nil))
'correct)))
(let ((a 'foobar) (l t)) (cond
((eq a 'bar) 'incorrect)
((eq a 'foo) 'incorrect)
((eq a 'foobar)
(while l
a (setq l nil))
'correct)
(t 'incorrect)))
(let ((a))
(cond ((eq a 'foo) 'incorrect)
(t)))
(let ((a))
(cond ((eq a 'foo) 'incorrect)
('correct)))
;; Bug#31734
(let ((variable 0))
(cond
((eq variable 'default)
(message "equal"))
(t
(message "not equal"))))
;; Bug#35770
(let ((x 'a)) (cond ((eq x 'a) 'correct)
((eq x 'b) 'incorrect)
((eq x 'a) 'incorrect)
((eq x 'c) 'incorrect)))
(let ((x #x10000000000000000))
(cond ((eql x #x10000000000000000) 'correct)
((eql x #x10000000000000001) 'incorrect)
((eql x #x10000000000000000) 'incorrect)
((eql x #x10000000000000002) 'incorrect)))
(let ((x "a")) (cond ((equal x "a") 'correct)
((equal x "b") 'incorrect)
((equal x "a") 'incorrect)
((equal x "c") 'incorrect)))
;; Multi-value clauses
(mapcar (lambda (x) (cond ((eq x 'a) 11)
((memq x '(b a c d)) 22)
((eq x 'c) 33)
((eq x 'e) 44)
((memq x '(d f g)) 55)
(t 99)))
'(a b c d e f g h))
(mapcar (lambda (x) (cond ((eql x 1) 11)
((memq x '(a b c)) 22)
((memql x '(2 1 4 1e-3)) 33)
((eq x 'd) 44)
((eql x #x10000000000000000))))
'(1 2 4 1e-3 a b c d 1.0 #x10000000000000000))
(mapcar (lambda (x) (cond ((eq x 'a) 11)
((memq x '(b d)) 22)
((equal x '(a . b)) 33)
((member x '(b c 1.5 2.5 "X" (d))) 44)
((eql x 3.14) 55)
((memql x '(9 0.5 1.5 q)) 66)
(t 99)))
'(a b c d (d) (a . b) "X" 0.5 1.5 3.14 9 9.0))
;; Multi-switch cond form
(mapcar (lambda (p) (let ((x (car p)) (y (cadr p)))
(cond ((consp x) 11)
((eq x 'a) 22)
((memql x '(b 7 a -3)) 33)
((equal y "a") 44)
((memq y '(c d e)) 55)
((booleanp x) 66)
((eq x 'q) 77)
((memq x '(r s)) 88)
((eq x 't) 99)
(t 999))))
'((a c) (b c) (7 c) (-3 c) (nil nil) (t c) (q c) (r c) (s c)
(t c) (x "a") (x "c") (x c) (x d) (x e)))
(mapcar (lambda (x) (cond ((member '(a . b) x) 1)
((equal x '(c)) 2)))
'(((a . b)) a b (c) (d)))
(mapcar (lambda (x) (cond ((memq '(a . b) x) 1)
((equal x '(c)) 2)))
'(((a . b)) a b (c) (d)))
(mapcar (lambda (x) (cond ((member '(a b) x) 1)
((equal x '(c)) 2)))
'(((a b)) a b (c) (d)))
(mapcar (lambda (x) (cond ((memq '(a b) x) 1)
((equal x '(c)) 2)))
'(((a b)) a b (c) (d))))
"List of expression for test.
Each element will be executed by interpreter and with
bytecompiled code, and their results compared.")
(defun bytecomp-check-1 (pat)
"Return non-nil if PAT is the same whether directly evalled or compiled."
(let ((warning-minimum-log-level :emergency)
(byte-compile-warnings nil)
(v0 (condition-case err
(eval pat)
(error (list 'bytecomp-check-error (car err)))))
(v1 (condition-case err
(funcall (byte-compile (list 'lambda nil pat)))
(error (list 'bytecomp-check-error (car err))))))
(equal v0 v1)))
(put 'bytecomp-check-1 'ert-explainer 'bytecomp-explain-1)
(defun bytecomp-explain-1 (pat)
(let ((v0 (condition-case err
(eval pat)
(error (list 'bytecomp-check-error (car err)))))
(v1 (condition-case err
(funcall (byte-compile (list 'lambda nil pat)))
(error (list 'bytecomp-check-error (car err))))))
(format "Expression `%s' gives `%s' if directly evalled, `%s' if compiled."
pat v0 v1)))
(ert-deftest bytecomp-tests ()
"Test the Emacs byte compiler."
(dolist (pat byte-opt-testsuite-arith-data)
(should (bytecomp-check-1 pat))))
(defun test-byte-opt-arithmetic (&optional arg)
"Unit test for byte-opt arithmetic operations.
Subtests signal errors if something goes wrong."
(interactive "P")
(switch-to-buffer (generate-new-buffer "*Font Pase Test*"))
(let ((warning-minimum-log-level :emergency)
(byte-compile-warnings nil)
(pass-face '((t :foreground "green")))
(fail-face '((t :foreground "red")))
(print-escape-nonascii t)
(print-escape-newlines t)
(print-quoted t)
v0 v1)
(dolist (pat byte-opt-testsuite-arith-data)
(condition-case err
(setq v0 (eval pat))
(error (setq v0 (list 'bytecomp-check-error (car err)))))
(condition-case err
(setq v1 (funcall (byte-compile (list 'lambda nil pat))))
(error (setq v1 (list 'bytecomp-check-error (car err)))))
(insert (format "%s" pat))
(indent-to-column 65)
(if (equal v0 v1)
(insert (propertize "OK" 'face pass-face))
(insert (propertize "FAIL\n" 'face fail-face))
(indent-to-column 55)
(insert (propertize (format "[%s] vs [%s]" v0 v1)
'face fail-face)))
(insert "\n"))))
(defun test-byte-comp-compile-and-load (compile &rest forms)
(let ((elfile nil)
(elcfile nil))
(unwind-protect
(progn
(setf elfile (make-temp-file "test-bytecomp" nil ".el"))
(when compile
(setf elcfile (make-temp-file "test-bytecomp" nil ".elc")))
(with-temp-buffer
(dolist (form forms)
(print form (current-buffer)))
(write-region (point-min) (point-max) elfile nil 'silent))
(if compile
(let ((byte-compile-dest-file-function
(lambda (e) elcfile)))
(byte-compile-file elfile t))
(load elfile nil 'nomessage)))
(when elfile (delete-file elfile))
(when elcfile (delete-file elcfile)))))
(put 'test-byte-comp-compile-and-load 'lisp-indent-function 1)
(ert-deftest test-byte-comp-macro-expansion ()
(test-byte-comp-compile-and-load t
'(progn (defmacro abc (arg) 1) (defun def () (abc 2))))
(should (equal (funcall 'def) 1)))
(ert-deftest test-byte-comp-macro-expansion-eval-and-compile ()
(test-byte-comp-compile-and-load t
'(eval-and-compile (defmacro abc (arg) -1) (defun def () (abc 2))))
(should (equal (funcall 'def) -1)))
(ert-deftest test-byte-comp-macro-expansion-eval-when-compile ()
;; Make sure we interpret eval-when-compile forms properly. CLISP
;; and SBCL interpreter eval-when-compile (well, the CL equivalent)
;; in the same way.
(test-byte-comp-compile-and-load t
'(eval-when-compile
(defmacro abc (arg) -10)
(defun abc-1 () (abc 2)))
'(defmacro abc-2 () (abc-1))
'(defun def () (abc-2)))
(should (equal (funcall 'def) -10)))
(ert-deftest test-byte-comp-macro-expand-lexical-override ()
;; Intuitively, one might expect the defmacro to override the
;; macrolet since macrolet's is explicitly called out as being
;; equivalent to toplevel, but CLISP and SBCL both evaluate the form
;; this way, so we should too.
(test-byte-comp-compile-and-load t
'(require 'cl-lib)
'(cl-macrolet ((m () 4))
(defmacro m () 5)
(defun def () (m))))
(should (equal (funcall 'def) 4)))
(ert-deftest bytecomp-tests--warnings ()
(with-current-buffer (get-buffer-create "*Compile-Log*")
(let ((inhibit-read-only t)) (erase-buffer)))
(mapc #'fmakunbound '(my-test0 my--test11 my--test12 my--test2))
(test-byte-comp-compile-and-load t
'(progn
(defun my-test0 ()
(my--test11 3)
(my--test12 3)
(my--test2 5))
(defmacro my--test11 (arg) (+ arg 1))
(eval-and-compile
(defmacro my--test12 (arg) (+ arg 1))
(defun my--test2 (arg) (+ arg 1)))))
(with-current-buffer (get-buffer-create "*Compile-Log*")
(goto-char (point-min))
;; Should warn that mt--test1[12] are first used as functions.
;; The second alternative is for when the file name is so long
;; that pretty-printing starts the message on the next line.
(should (or (re-search-forward "my--test11:\n.*macro" nil t)
(re-search-forward "my--test11:\n.*:\n.*macro" nil t)))
(should (or (re-search-forward "my--test12:\n.*macro" nil t)
(re-search-forward "my--test12:\n.*:\n.*macro" nil t)))
(goto-char (point-min))
;; Should not warn that mt--test2 is not known to be defined.
(should-not (re-search-forward "my--test2" nil t))))
(ert-deftest bytecomp-warn-wrong-args ()
(with-current-buffer (get-buffer-create "*Compile-Log*")
(let ((inhibit-read-only t)) (erase-buffer))
(byte-compile '(remq 1 2 3))
(ert-info ((buffer-string) :prefix "buffer: ")
(should (re-search-forward "remq.*3.*2")))))
(ert-deftest bytecomp-warn-wrong-args-subr ()
(with-current-buffer (get-buffer-create "*Compile-Log*")
(let ((inhibit-read-only t)) (erase-buffer))
(byte-compile '(safe-length 1 2 3))
(ert-info ((buffer-string) :prefix "buffer: ")
(should (re-search-forward "safe-length.*3.*1")))))
(ert-deftest test-eager-load-macro-expansion ()
(test-byte-comp-compile-and-load nil
'(progn (defmacro abc (arg) 1) (defun def () (abc 2))))
(should (equal (funcall 'def) 1)))
(ert-deftest test-eager-load-macro-expansion-eval-and-compile ()
(test-byte-comp-compile-and-load nil
'(eval-and-compile (defmacro abc (arg) -1) (defun def () (abc 2))))
(should (equal (funcall 'def) -1)))
(ert-deftest test-eager-load-macro-expansion-eval-when-compile ()
;; Make sure we interpret eval-when-compile forms properly. CLISP
;; and SBCL interpreter eval-when-compile (well, the CL equivalent)
;; in the same way.
(test-byte-comp-compile-and-load nil
'(eval-when-compile
(defmacro abc (arg) -10)
(defun abc-1 () (abc 2)))
'(defmacro abc-2 () (abc-1))
'(defun def () (abc-2)))
(should (equal (funcall 'def) -10)))
(ert-deftest test-eager-load-macro-expand-lexical-override ()
;; Intuitively, one might expect the defmacro to override the
;; macrolet since macrolet's is explicitly called out as being
;; equivalent to toplevel, but CLISP and SBCL both evaluate the form
;; this way, so we should too.
(test-byte-comp-compile-and-load nil
'(require 'cl-lib)
'(cl-macrolet ((m () 4))
(defmacro m () 5)
(defun def () (m))))
(should (equal (funcall 'def) 4)))
(defconst bytecomp-lexbind-tests
`(
(let ((f #'car))
(let ((f (lambda (x) (cons (funcall f x) (cdr x)))))
(funcall f '(1 . 2))))
)
"List of expression for test.
Each element will be executed by interpreter and with
bytecompiled code, and their results compared.")
(defun bytecomp-lexbind-check-1 (pat)
"Return non-nil if PAT is the same whether directly evalled or compiled."
(let ((warning-minimum-log-level :emergency)
(byte-compile-warnings nil)
(v0 (condition-case err
(eval pat t)
(error (list 'bytecomp-check-error (car err)))))
(v1 (condition-case err
(funcall (let ((lexical-binding t))
(byte-compile `(lambda nil ,pat))))
(error (list 'bytecomp-check-error (car err))))))
(equal v0 v1)))
(put 'bytecomp-lexbind-check-1 'ert-explainer 'bytecomp-lexbind-explain-1)
(defun bytecomp-lexbind-explain-1 (pat)
(let ((v0 (condition-case err
(eval pat t)
(error (list 'bytecomp-check-error (car err)))))
(v1 (condition-case err
(funcall (let ((lexical-binding t))
(byte-compile (list 'lambda nil pat))))
(error (list 'bytecomp-check-error (car err))))))
(format "Expression `%s' gives `%s' if directly evalled, `%s' if compiled."
pat v0 v1)))
(ert-deftest bytecomp-lexbind-tests ()
"Test the Emacs byte compiler lexbind handling."
(dolist (pat bytecomp-lexbind-tests)
(should (bytecomp-lexbind-check-1 pat))))
(defmacro bytecomp-tests--with-temp-file (file-name-var &rest body)
(declare (indent 1))
(cl-check-type file-name-var symbol)
`(let ((,file-name-var (make-temp-file "emacs")))
(unwind-protect
(progn ,@body)
(delete-file ,file-name-var)
(let ((elc (concat ,file-name-var ".elc")))
(if (file-exists-p elc) (delete-file elc))))))
(ert-deftest bytecomp-tests--unescaped-char-literals ()
"Check that byte compiling warns about unescaped character
literals (Bug#20852)."
(should (boundp 'lread--unescaped-character-literals))
(let ((byte-compile-error-on-warn t)
(byte-compile-debug t))
(bytecomp-tests--with-temp-file source
(write-region "(list ?) ?( ?; ?\" ?[ ?])" nil source)
(bytecomp-tests--with-temp-file destination
(let* ((byte-compile-dest-file-function (lambda (_) destination))
(err (should-error (byte-compile-file source))))
(should (equal (cdr err)
`(,(concat "unescaped character literals "
"`?\"', `?(', `?)', `?;', `?[', `?]' "
"detected, "
"`?\\\"', `?\\(', `?\\)', `?\\;', `?\\[', "
"`?\\]' expected!")))))))
;; But don't warn in subsequent compilations (Bug#36068).
(bytecomp-tests--with-temp-file source
(write-region "(list 1 2 3)" nil source)
(bytecomp-tests--with-temp-file destination
(let ((byte-compile-dest-file-function (lambda (_) destination)))
(should (byte-compile-file source)))))))
(ert-deftest bytecomp-tests-function-put ()
"Check `function-put' operates during compilation."
(bytecomp-tests--with-temp-file source
(dolist (form '((function-put 'bytecomp-tests--foo 'foo 1)
(function-put 'bytecomp-tests--foo 'bar 2)
(defmacro bytecomp-tests--foobar ()
`(cons ,(function-get 'bytecomp-tests--foo 'foo)
,(function-get 'bytecomp-tests--foo 'bar)))
(defvar bytecomp-tests--foobar 1)
(setq bytecomp-tests--foobar (bytecomp-tests--foobar))))
(print form (current-buffer)))
(write-region (point-min) (point-max) source nil 'silent)
(byte-compile-file source t)
(should (equal bytecomp-tests--foobar (cons 1 2)))))
(ert-deftest bytecomp-tests--test-no-warnings-with-advice ()
(defun f ())
(define-advice f (:around (oldfun &rest args) test)
(apply oldfun args))
(with-current-buffer (get-buffer-create "*Compile-Log*")
(let ((inhibit-read-only t)) (erase-buffer)))
(test-byte-comp-compile-and-load t '(defun f ()))
(with-current-buffer (get-buffer-create "*Compile-Log*")
(goto-char (point-min))
(should-not (search-forward "Warning" nil t))))
(ert-deftest bytecomp-test-featurep-warnings ()
(let ((byte-compile-log-buffer (generate-new-buffer " *Compile-Log*")))
(unwind-protect
(progn
(with-temp-buffer
(insert "\
\(defun foo ()
(an-undefined-function))
\(defun foo1 ()
(if (featurep 'xemacs)
(some-undefined-function-if)))
\(defun foo2 ()
(and (featurep 'xemacs)
(some-undefined-function-and)))
\(defun foo3 ()
(if (not (featurep 'emacs))
(some-undefined-function-not)))
\(defun foo4 ()
(or (featurep 'emacs)
(some-undefined-function-or)))
")
(byte-compile-from-buffer (current-buffer)))
(with-current-buffer byte-compile-log-buffer
(should (search-forward "an-undefined-function" nil t))
(should-not (search-forward "some-undefined-function" nil t))))
(if (buffer-live-p byte-compile-log-buffer)
(kill-buffer byte-compile-log-buffer)))))
(ert-deftest bytecomp-test--switch-duplicates ()
"Check that duplicates in switches are eliminated correctly (bug#35770)."
:expected-result (if byte-compile-cond-use-jump-table :passed :failed)
(dolist (params
'(((lambda (x)
(cond ((eq x 'a) 111)
((eq x 'b) 222)
((eq x 'a) 333)
((eq x 'c) 444)))
(a b c)
string<)
((lambda (x)
(cond ((eql x #x10000000000000000) 111)
((eql x #x10000000000000001) 222)
((eql x #x10000000000000000) 333)
((eql x #x10000000000000002) 444)))
(#x10000000000000000 #x10000000000000001 #x10000000000000002)
<)
((lambda (x)
(cond ((equal x "a") 111)
((equal x "b") 222)
((equal x "a") 333)
((equal x "c") 444)))
("a" "b" "c")
string<)))
(let* ((lisp (nth 0 params))
(keys (nth 1 params))
(lessp (nth 2 params))
(bc (byte-compile lisp))
(lap (byte-decompile-bytecode (aref bc 1) (aref bc 2)))
;; Assume the first constant is the switch table.
(table (cadr (assq 'byte-constant lap))))
(should (hash-table-p table))
(should (equal (sort (hash-table-keys table) lessp) keys))
(should (member '(byte-constant 111) lap))
(should (member '(byte-constant 222) lap))
(should-not (member '(byte-constant 333) lap))
(should (member '(byte-constant 444) lap)))))
(defun test-suppression (form suppress match)
(let ((lexical-binding t)
(byte-compile-log-buffer (generate-new-buffer " *Compile-Log*")))
;; Check that we get a warning without suppression.
(with-current-buffer byte-compile-log-buffer
(setq-local fill-column 9999)
(setq-local warning-fill-column fill-column)
(let ((inhibit-read-only t))
(erase-buffer)))
(test-byte-comp-compile-and-load t form)
(with-current-buffer byte-compile-log-buffer
(unless match
(error "%s" (buffer-string)))
(goto-char (point-min))
(should (string-match match (buffer-string))))
;; And that it's gone now.
(with-current-buffer byte-compile-log-buffer
(let ((inhibit-read-only t))
(erase-buffer)))
(test-byte-comp-compile-and-load t
`(with-suppressed-warnings ,suppress
,form))
(with-current-buffer byte-compile-log-buffer
(goto-char (point-min))
(should-not (string-match match (buffer-string))))
;; Also check that byte compiled forms are identical.
(should (equal (byte-compile form)
(byte-compile
`(with-suppressed-warnings ,suppress ,form))))))
(ert-deftest bytecomp-test--with-suppressed-warnings ()
(test-suppression
'(defvar prefixless)
'((lexical prefixless))
"global/dynamic var .prefixless. lacks")
(test-suppression
'(defun foo()
(let ((nil t))
(message-mail)))
'((constants nil))
"Warning: attempt to let-bind constant .nil.")
(test-suppression
'(progn
(defun obsolete ()
(declare (obsolete foo "22.1")))
(defun zot ()
(obsolete)))
'((obsolete obsolete))
"Warning: .obsolete. is an obsolete function")
(test-suppression
'(progn
(defun wrong-params (foo &optional unused)
(ignore unused)
foo)
(defun zot ()
(wrong-params 1 2 3)))
'((callargs wrong-params))
"Warning: wrong-params called with")
(test-byte-comp-compile-and-load nil
(defvar obsolete-variable nil)
(make-obsolete-variable 'obsolete-variable nil "24.1"))
(test-suppression
'(defun zot ()
obsolete-variable)
'((obsolete obsolete-variable))
"obsolete")
(test-suppression
'(defun zot ()
(mapcar #'list '(1 2 3))
nil)
'((mapcar mapcar))
"Warning: .mapcar. called for effect")
(test-suppression
'(defun zot ()
free-variable)
'((free-vars free-variable))
"Warning: reference to free variable")
(test-suppression
'(defun zot ()
(save-excursion
(set-buffer (get-buffer-create "foo"))
nil))
'((suspicious set-buffer))
"Warning: Use .with-current-buffer. rather than"))
;; Local Variables:
;; no-byte-compile: t
;; End:
(provide 'bytecomp-tests)
;; bytecomp-tests.el ends here.