byte-opt.el 73.4 KB
Newer Older
1
;;; byte-opt.el --- the optimization passes of the emacs-lisp byte compiler
Jim Blandy's avatar
Jim Blandy committed
2

3 4
;; Copyright (C) 1991, 1994, 2000, 2001, 2002, 2003, 2004,
;;   2005 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

;; Author: Jamie Zawinski <jwz@lucid.com>
;;	Hallvard Furuseth <hbf@ulrik.uio.no>
Dave Love's avatar
Dave Love committed
8
;; Maintainer: FSF
Jim Blandy's avatar
Jim Blandy committed
9
;; Keywords: internal
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14

;; 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
Jim Blandy's avatar
Jim Blandy committed
15
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
16 17 18 19 20 21 22 23
;; 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
Erik Naggum's avatar
Erik Naggum committed
24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Jim Blandy's avatar
Jim Blandy committed
27

Jim Blandy's avatar
Jim Blandy committed
28 29
;;; Commentary:

Erik Naggum's avatar
Erik Naggum committed
30 31 32 33 34
;; ========================================================================
;; "No matter how hard you try, you can't make a racehorse out of a pig.
;; You can, however, make a faster pig."
;;
;; Or, to put it another way, the emacs byte compiler is a VW Bug.  This code
35
;; makes it be a VW Bug with fuel injection and a turbocharger...  You're
Erik Naggum's avatar
Erik Naggum committed
36 37 38
;; still not going to make it go faster than 70 mph, but it might be easier
;; to get it there.
;;
Jim Blandy's avatar
Jim Blandy committed
39

Erik Naggum's avatar
Erik Naggum committed
40 41
;; TO DO:
;;
Stefan Monnier's avatar
Stefan Monnier committed
42
;; (apply (lambda (x &rest y) ...) 1 (foo))
Erik Naggum's avatar
Erik Naggum committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
;;
;; maintain a list of functions known not to access any global variables
;; (actually, give them a 'dynamically-safe property) and then
;;   (let ( v1 v2 ... vM vN ) <...dynamically-safe...> )  ==>
;;   (let ( v1 v2 ... vM ) vN <...dynamically-safe...> )
;; by recursing on this, we might be able to eliminate the entire let.
;; However certain variables should never have their bindings optimized
;; away, because they affect everything.
;;   (put 'debug-on-error 'binding-is-magic t)
;;   (put 'debug-on-abort 'binding-is-magic t)
;;   (put 'debug-on-next-call 'binding-is-magic t)
;;   (put 'inhibit-quit 'binding-is-magic t)
;;   (put 'quit-flag 'binding-is-magic t)
;;   (put 't 'binding-is-magic t)
;;   (put 'nil 'binding-is-magic t)
;; possibly also
;;   (put 'gc-cons-threshold 'binding-is-magic t)
;;   (put 'track-mouse 'binding-is-magic t)
;; others?
;;
;; Simple defsubsts often produce forms like
;;    (let ((v1 (f1)) (v2 (f2)) ...)
;;       (FN v1 v2 ...))
66
;; It would be nice if we could optimize this to
Erik Naggum's avatar
Erik Naggum committed
67 68 69 70 71
;;    (FN (f1) (f2) ...)
;; but we can't unless FN is dynamically-safe (it might be dynamically
;; referring to the bindings that the lambda arglist established.)
;; One of the uncountable lossages introduced by dynamic scope...
;;
72
;; Maybe there should be a control-structure that says "turn on
Erik Naggum's avatar
Erik Naggum committed
73 74 75
;; fast-and-loose type-assumptive optimizations here."  Then when
;; we see a form like (car foo) we can from then on assume that
;; the variable foo is of type cons, and optimize based on that.
76
;; But, this won't win much because of (you guessed it) dynamic
Erik Naggum's avatar
Erik Naggum committed
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
;; scope.  Anything down the stack could change the value.
;; (Another reason it doesn't work is that it is perfectly valid
;; to call car with a null argument.)  A better approach might
;; be to allow type-specification of the form
;;   (put 'foo 'arg-types '(float (list integer) dynamic))
;;   (put 'foo 'result-type 'bool)
;; It should be possible to have these types checked to a certain
;; degree.
;;
;; collapse common subexpressions
;;
;; It would be nice if redundant sequences could be factored out as well,
;; when they are known to have no side-effects:
;;   (list (+ a b c) (+ a b c))   -->  a b add c add dup list-2
;; but beware of traps like
;;   (cons (list x y) (list x y))
;;
;; Tail-recursion elimination is not really possible in Emacs Lisp.
;; Tail-recursion elimination is almost always impossible when all variables
;; have dynamic scope, but given that the "return" byteop requires the
;; binding stack to be empty (rather than emptying it itself), there can be
;; no truly tail-recursive Emacs Lisp functions that take any arguments or
;; make any bindings.
;;
;; Here is an example of an Emacs Lisp function which could safely be
;; byte-compiled tail-recursively:
;;
;;  (defun tail-map (fn list)
;;    (cond (list
;;           (funcall fn (car list))
;;           (tail-map fn (cdr list)))))
;;
;; However, if there was even a single let-binding around the COND,
;; it could not be byte-compiled, because there would be an "unbind"
111
;; byte-op between the final "call" and "return."  Adding a
Erik Naggum's avatar
Erik Naggum committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
;; Bunbind_all byteop would fix this.
;;
;;   (defun foo (x y z) ... (foo a b c))
;;   ... (const foo) (varref a) (varref b) (varref c) (call 3) END: (return)
;;   ... (varref a) (varbind x) (varref b) (varbind y) (varref c) (varbind z) (goto 0) END: (unbind-all) (return)
;;   ... (varref a) (varset x) (varref b) (varset y) (varref c) (varset z) (goto 0) END: (return)
;;
;; this also can be considered tail recursion:
;;
;;   ... (const foo) (varref a) (call 1) (goto X) ... X: (return)
;; could generalize this by doing the optimization
;;   (goto X) ... X: (return)  -->  (return)
;;
;; But this doesn't solve all of the problems: although by doing tail-
;; recursion elimination in this way, the call-stack does not grow, the
;; binding-stack would grow with each recursive step, and would eventually
;; overflow.  I don't believe there is any way around this without lexical
;; scope.
;;
;; Wouldn't it be nice if Emacs Lisp had lexical scope.
;;
133 134
;; Idea: the form (lexical-scope) in a file means that the file may be
;; compiled lexically.  This proclamation is file-local.  Then, within
Erik Naggum's avatar
Erik Naggum committed
135 136 137 138 139 140 141 142 143
;; that file, "let" would establish lexical bindings, and "let-dynamic"
;; would do things the old way.  (Or we could use CL "declare" forms.)
;; We'd have to notice defvars and defconsts, since those variables should
;; always be dynamic, and attempting to do a lexical binding of them
;; should simply do a dynamic binding instead.
;; But!  We need to know about variables that were not necessarily defvarred
;; in the file being compiled (doing a boundp check isn't good enough.)
;; Fdefvar() would have to be modified to add something to the plist.
;;
144 145
;; A major disadvantage of this scheme is that the interpreter and compiler
;; would have different semantics for files compiled with (dynamic-scope).
Erik Naggum's avatar
Erik Naggum committed
146
;; Since this would be a file-local optimization, there would be no way to
147
;; modify the interpreter to obey this (unless the loader was hacked
Erik Naggum's avatar
Erik Naggum committed
148
;; in some grody way, but that's a really bad idea.)
149 150 151

;; Other things to consider:

152 153 154
;; ;; Associative math should recognize subcalls to identical function:
;; (disassemble (lambda (x) (+ (+ (foo) 1) (+ (bar) 2))))
;; ;; This should generate the same as (1+ x) and (1- x)
155

156 157 158
;; (disassemble (lambda (x) (cons (+ x 1) (- x 1))))
;; ;; An awful lot of functions always return a non-nil value.  If they're
;; ;; error free also they may act as true-constants.
159

160 161 162 163 164 165 166 167
;; (disassemble (lambda (x) (and (point) (foo))))
;; ;; When
;; ;;   - all but one arguments to a function are constant
;; ;;   - the non-constant argument is an if-expression (cond-expression?)
;; ;; then the outer function can be distributed.  If the guarding
;; ;; condition is side-effect-free [assignment-free] then the other
;; ;; arguments may be any expressions.  Since, however, the code size
;; ;; can increase this way they should be "simple".  Compare:
168

169 170
;; (disassemble (lambda (x) (eq (if (point) 'a 'b) 'c)))
;; (disassemble (lambda (x) (if (point) (eq 'a 'c) (eq 'b 'c))))
171

172 173
;; ;; (car (cons A B)) -> (prog1 A B)
;; (disassemble (lambda (x) (car (cons (foo) 42))))
174

175 176
;; ;; (cdr (cons A B)) -> (progn A B)
;; (disassemble (lambda (x) (cdr (cons 42 (foo)))))
177

178 179
;; ;; (car (list A B ...)) -> (prog1 A B ...)
;; (disassemble (lambda (x) (car (list (foo) 42 (bar)))))
180

181 182
;; ;; (cdr (list A B ...)) -> (progn A (list B ...))
;; (disassemble (lambda (x) (cdr (list 42 (foo) (bar)))))
183

Jim Blandy's avatar
Jim Blandy committed
184

Jim Blandy's avatar
Jim Blandy committed
185
;;; Code:
Jim Blandy's avatar
Jim Blandy committed
186

187 188
(require 'bytecomp)

Jim Blandy's avatar
Jim Blandy committed
189 190
(defun byte-compile-log-lap-1 (format &rest args)
  (if (aref byte-code-vector 0)
191
      (error "The old version of the disassembler is loaded.  Reload new-bytecomp as well"))
Jim Blandy's avatar
Jim Blandy committed
192 193 194
  (byte-compile-log-1
   (apply 'format format
     (let (c a)
Stefan Monnier's avatar
Stefan Monnier committed
195
       (mapcar (lambda (arg)
Jim Blandy's avatar
Jim Blandy committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
		  (if (not (consp arg))
		      (if (and (symbolp arg)
			       (string-match "^byte-" (symbol-name arg)))
			  (intern (substring (symbol-name arg) 5))
			arg)
		    (if (integerp (setq c (car arg)))
			(error "non-symbolic byte-op %s" c))
		    (if (eq c 'TAG)
			(setq c arg)
		      (setq a (cond ((memq c byte-goto-ops)
				     (car (cdr (cdr arg))))
				    ((memq c byte-constref-ops)
				     (car (cdr arg)))
				    (t (cdr arg))))
		      (setq c (symbol-name c))
		      (if (string-match "^byte-." c)
			  (setq c (intern (substring c 5)))))
		    (if (eq c 'constant) (setq c 'const))
		    (if (and (eq (cdr arg) 0)
			     (not (memq c '(unbind call const))))
			c
		      (format "(%s %s)" c a))))
	       args)))))

(defmacro byte-compile-log-lap (format-string &rest args)
221 222
  `(and (memq byte-optimize-log '(t byte))
	(byte-compile-log-lap-1 ,format-string ,@args)))
Jim Blandy's avatar
Jim Blandy committed
223 224 225 226 227 228 229 230 231 232


;;; byte-compile optimizers to support inlining

(put 'inline 'byte-optimizer 'byte-optimize-inline-handler)

(defun byte-optimize-inline-handler (form)
  "byte-optimize-handler for the `inline' special-form."
  (cons 'progn
	(mapcar
Stefan Monnier's avatar
Stefan Monnier committed
233
	 (lambda (sexp)
234 235 236 237 238 239 240 241 242 243
	   (let ((f (car-safe sexp)))
	     (if (and (symbolp f)
		      (or (cdr (assq f byte-compile-function-environment))
			  (not (or (not (fboundp f))
				   (cdr (assq f byte-compile-macro-environment))
				   (and (consp (setq f (symbol-function f)))
					(eq (car f) 'macro))
				   (subrp f)))))
		 (byte-compile-inline-expand sexp)
	       sexp)))
Jim Blandy's avatar
Jim Blandy committed
244 245 246
	 (cdr form))))


247 248 249 250
;; Splice the given lap code into the current instruction stream.
;; If it has any labels in it, you're responsible for making sure there
;; are no collisions, and that byte-compile-tag-number is reasonable
;; after this is spliced in.  The provided list is destroyed.
Jim Blandy's avatar
Jim Blandy committed
251 252 253 254 255 256 257 258 259
(defun byte-inline-lapcode (lap)
  (setq byte-compile-output (nconc (nreverse lap) byte-compile-output)))

(defun byte-compile-inline-expand (form)
  (let* ((name (car form))
	 (fn (or (cdr (assq name byte-compile-function-environment))
		 (and (fboundp name) (symbol-function name)))))
    (if (null fn)
	(progn
Gerd Moellmann's avatar
Gerd Moellmann committed
260
	  (byte-compile-warn "attempt to inline `%s' before it was defined"
261
			     name)
Jim Blandy's avatar
Jim Blandy committed
262 263
	  form)
      ;; else
264
      (when (and (consp fn) (eq (car fn) 'autoload))
265
	(load (nth 1 fn))
266 267
	(setq fn (or (and (fboundp name) (symbol-function name))
		     (cdr (assq name byte-compile-function-environment)))))
Jim Blandy's avatar
Jim Blandy committed
268
      (if (and (consp fn) (eq (car fn) 'autoload))
269
	  (error "File `%s' didn't define `%s'" (nth 1 fn) name))
270
      (if (and (symbolp fn) (not (eq fn t)))
Jim Blandy's avatar
Jim Blandy committed
271
	  (byte-compile-inline-expand (cons fn (cdr form)))
272
	(if (byte-code-function-p fn)
273
	    (let (string)
274
	      (fetch-bytecode fn)
275
	      (setq string (aref fn 1))
276
	      ;; Isn't it an error for `string' not to be unibyte??  --stef
277 278
	      (if (fboundp 'string-as-unibyte)
		  (setq string (string-as-unibyte string)))
279 280
	      (cons `(lambda ,(aref fn 0)
		       (byte-code ,string ,(aref fn 2) ,(aref fn 3)))
281
		    (cdr form)))
Karl Heuer's avatar
Karl Heuer committed
282 283 284 285
	  (if (eq (car-safe fn) 'lambda)
	      (cons fn (cdr form))
	    ;; Give up on inlining.
	    form))))))
Jim Blandy's avatar
Jim Blandy committed
286

287
;; ((lambda ...) ...)
Jim Blandy's avatar
Jim Blandy committed
288 289 290 291
(defun byte-compile-unfold-lambda (form &optional name)
  (or name (setq name "anonymous lambda"))
  (let ((lambda (car form))
	(values (cdr form)))
292
    (if (byte-code-function-p lambda)
Jim Blandy's avatar
Jim Blandy committed
293 294 295
	(setq lambda (list 'lambda (aref lambda 0)
			   (list 'byte-code (aref lambda 1)
				 (aref lambda 2) (aref lambda 3)))))
Jim Blandy's avatar
Jim Blandy committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
    (let ((arglist (nth 1 lambda))
	  (body (cdr (cdr lambda)))
	  optionalp restp
	  bindings)
      (if (and (stringp (car body)) (cdr body))
	  (setq body (cdr body)))
      (if (and (consp (car body)) (eq 'interactive (car (car body))))
	  (setq body (cdr body)))
      (while arglist
	(cond ((eq (car arglist) '&optional)
	       ;; ok, I'll let this slide because funcall_lambda() does...
	       ;; (if optionalp (error "multiple &optional keywords in %s" name))
	       (if restp (error "&optional found after &rest in %s" name))
	       (if (null (cdr arglist))
		   (error "nothing after &optional in %s" name))
	       (setq optionalp t))
	      ((eq (car arglist) '&rest)
	       ;; ...but it is by no stretch of the imagination a reasonable
	       ;; thing that funcall_lambda() allows (&rest x y) and
	       ;; (&rest x &optional y) in arglists.
	       (if (null (cdr arglist))
		   (error "nothing after &rest in %s" name))
	       (if (cdr (cdr arglist))
		   (error "multiple vars after &rest in %s" name))
	       (setq restp t))
	      (restp
	       (setq bindings (cons (list (car arglist)
					  (and values (cons 'list values)))
				    bindings)
		     values nil))
	      ((and (not optionalp) (null values))
Gerd Moellmann's avatar
Gerd Moellmann committed
327
	       (byte-compile-warn "attempt to open-code `%s' with too few arguments" name)
Jim Blandy's avatar
Jim Blandy committed
328 329 330 331 332 333 334 335 336 337
	       (setq arglist nil values 'too-few))
	      (t
	       (setq bindings (cons (list (car arglist) (car values))
				    bindings)
		     values (cdr values))))
	(setq arglist (cdr arglist)))
      (if values
	  (progn
	    (or (eq values 'too-few)
		(byte-compile-warn
Gerd Moellmann's avatar
Gerd Moellmann committed
338
		 "attempt to open-code `%s' with too many arguments" name))
Jim Blandy's avatar
Jim Blandy committed
339
	    form)
340

341 342 343 344
	;; The following leads to infinite recursion when loading a
	;; file containing `(defsubst f () (f))', and then trying to
	;; byte-compile that file.
	;(setq body (mapcar 'byte-optimize-form body)))
345 346

	(let ((newform
Jim Blandy's avatar
Jim Blandy committed
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
	       (if bindings
		   (cons 'let (cons (nreverse bindings) body))
		 (cons 'progn body))))
	  (byte-compile-log "  %s\t==>\t%s" form newform)
	  newform)))))


;;; implementing source-level optimizers

(defun byte-optimize-form-code-walker (form for-effect)
  ;;
  ;; For normal function calls, We can just mapcar the optimizer the cdr.  But
  ;; we need to have special knowledge of the syntax of the special forms
  ;; like let and defun (that's why they're special forms :-).  (Actually,
  ;; the important aspect is that they are subrs that don't evaluate all of
  ;; their args.)
  ;;
  (let ((fn (car-safe form))
	tmp)
    (cond ((not (consp form))
	   (if (not (and for-effect
			 (or byte-compile-delete-errors
			     (not (symbolp form))
			     (eq form t))))
	     form))
	  ((eq fn 'quote)
	   (if (cdr (cdr form))
Gerd Moellmann's avatar
Gerd Moellmann committed
374
	       (byte-compile-warn "malformed quote form: `%s'"
Jim Blandy's avatar
Jim Blandy committed
375 376 377 378 379 380
				  (prin1-to-string form)))
	   ;; map (quote nil) to nil to simplify optimizer logic.
	   ;; map quoted constants to nil if for-effect (just because).
	   (and (nth 1 form)
		(not for-effect)
		form))
381
	  ((or (byte-code-function-p fn)
Jim Blandy's avatar
Jim Blandy committed
382 383 384 385 386 387 388 389
	       (eq 'lambda (car-safe fn)))
	   (byte-compile-unfold-lambda form))
	  ((memq fn '(let let*))
	   ;; recursively enter the optimizer for the bindings and body
	   ;; of a let or let*.  This for depth-firstness: forms that
	   ;; are more deeply nested are optimized first.
	   (cons fn
	     (cons
Stefan Monnier's avatar
Stefan Monnier committed
390
	      (mapcar (lambda (binding)
Jim Blandy's avatar
Jim Blandy committed
391 392 393
			 (if (symbolp binding)
			     binding
			   (if (cdr (cdr binding))
Gerd Moellmann's avatar
Gerd Moellmann committed
394
			       (byte-compile-warn "malformed let binding: `%s'"
Jim Blandy's avatar
Jim Blandy committed
395 396 397 398 399 400 401
						  (prin1-to-string binding)))
			   (list (car binding)
				 (byte-optimize-form (nth 1 binding) nil))))
		      (nth 1 form))
	      (byte-optimize-body (cdr (cdr form)) for-effect))))
	  ((eq fn 'cond)
	   (cons fn
Stefan Monnier's avatar
Stefan Monnier committed
402
		 (mapcar (lambda (clause)
Jim Blandy's avatar
Jim Blandy committed
403 404 405 406
			    (if (consp clause)
				(cons
				 (byte-optimize-form (car clause) nil)
				 (byte-optimize-body (cdr clause) for-effect))
Gerd Moellmann's avatar
Gerd Moellmann committed
407
			      (byte-compile-warn "malformed cond form: `%s'"
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
						 (prin1-to-string clause))
			      clause))
			 (cdr form))))
	  ((eq fn 'progn)
	   ;; as an extra added bonus, this simplifies (progn <x>) --> <x>
	   (if (cdr (cdr form))
	       (progn
		 (setq tmp (byte-optimize-body (cdr form) for-effect))
		 (if (cdr tmp) (cons 'progn tmp) (car tmp)))
	     (byte-optimize-form (nth 1 form) for-effect)))
	  ((eq fn 'prog1)
	   (if (cdr (cdr form))
	       (cons 'prog1
		     (cons (byte-optimize-form (nth 1 form) for-effect)
			   (byte-optimize-body (cdr (cdr form)) t)))
	     (byte-optimize-form (nth 1 form) for-effect)))
	  ((eq fn 'prog2)
	   (cons 'prog2
	     (cons (byte-optimize-form (nth 1 form) t)
	       (cons (byte-optimize-form (nth 2 form) for-effect)
		     (byte-optimize-body (cdr (cdr (cdr form))) t)))))
429

430
	  ((memq fn '(save-excursion save-restriction save-current-buffer))
Jim Blandy's avatar
Jim Blandy committed
431 432 433 434 435
	   ;; those subrs which have an implicit progn; it's not quite good
	   ;; enough to treat these like normal function calls.
	   ;; This can turn (save-excursion ...) into (save-excursion) which
	   ;; will be optimized away in the lap-optimize pass.
	   (cons fn (byte-optimize-body (cdr form) for-effect)))
436

Jim Blandy's avatar
Jim Blandy committed
437 438 439 440 441 442
	  ((eq fn 'with-output-to-temp-buffer)
	   ;; this is just like the above, except for the first argument.
	   (cons fn
	     (cons
	      (byte-optimize-form (nth 1 form) nil)
	      (byte-optimize-body (cdr (cdr form)) for-effect))))
443

Jim Blandy's avatar
Jim Blandy committed
444
	  ((eq fn 'if)
Gerd Moellmann's avatar
Gerd Moellmann committed
445
	   (when (< (length form) 3)
Gerd Moellmann's avatar
Gerd Moellmann committed
446
	     (byte-compile-warn "too few arguments for `if'"))
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450 451
	   (cons fn
	     (cons (byte-optimize-form (nth 1 form) nil)
	       (cons
		(byte-optimize-form (nth 2 form) for-effect)
		(byte-optimize-body (nthcdr 3 form) for-effect)))))
452

Jim Blandy's avatar
Jim Blandy committed
453 454
	  ((memq fn '(and or))  ; remember, and/or are control structures.
	   ;; take forms off the back until we can't any more.
455
	   ;; In the future it could conceivably be a problem that the
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459 460 461 462 463 464 465 466 467 468
	   ;; subexpressions of these forms are optimized in the reverse
	   ;; order, but it's ok for now.
	   (if for-effect
	       (let ((backwards (reverse (cdr form))))
		 (while (and backwards
			     (null (setcar backwards
					   (byte-optimize-form (car backwards)
							       for-effect))))
		   (setq backwards (cdr backwards)))
		 (if (and (cdr form) (null backwards))
		     (byte-compile-log
		      "  all subforms of %s called for effect; deleted" form))
		 (and backwards
469
		      (cons fn (nreverse (mapcar 'byte-optimize-form backwards)))))
Jim Blandy's avatar
Jim Blandy committed
470 471 472
	     (cons fn (mapcar 'byte-optimize-form (cdr form)))))

	  ((eq fn 'interactive)
Gerd Moellmann's avatar
Gerd Moellmann committed
473
	   (byte-compile-warn "misplaced interactive spec: `%s'"
Jim Blandy's avatar
Jim Blandy committed
474 475
			      (prin1-to-string form))
	   nil)
476

Jim Blandy's avatar
Jim Blandy committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
	  ((memq fn '(defun defmacro function
		      condition-case save-window-excursion))
	   ;; These forms are compiled as constants or by breaking out
	   ;; all the subexpressions and compiling them separately.
	   form)

	  ((eq fn 'unwind-protect)
	   ;; the "protected" part of an unwind-protect is compiled (and thus
	   ;; optimized) as a top-level form, so don't do it here.  But the
	   ;; non-protected part has the same for-effect status as the
	   ;; unwind-protect itself.  (The protected part is always for effect,
	   ;; but that isn't handled properly yet.)
	   (cons fn
		 (cons (byte-optimize-form (nth 1 form) for-effect)
		       (cdr (cdr form)))))
492

Jim Blandy's avatar
Jim Blandy committed
493 494 495 496 497 498 499 500 501
	  ((eq fn 'catch)
	   ;; the body of a catch is compiled (and thus optimized) as a
	   ;; top-level form, so don't do it here.  The tag is never
	   ;; for-effect.  The body should have the same for-effect status
	   ;; as the catch form itself, but that isn't handled properly yet.
	   (cons fn
		 (cons (byte-optimize-form (nth 1 form) nil)
		       (cdr (cdr form)))))

502 503 504 505 506 507 508
	  ((eq fn 'ignore)
	   ;; Don't treat the args to `ignore' as being
	   ;; computed for effect.  We want to avoid the warnings
	   ;; that might occur if they were treated that way.
	   ;; However, don't actually bother calling `ignore'.
	   `(prog1 nil . ,(mapcar 'byte-optimize-form (cdr form))))

Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513 514 515 516
	  ;; If optimization is on, this is the only place that macros are
	  ;; expanded.  If optimization is off, then macroexpansion happens
	  ;; in byte-compile-form.  Otherwise, the macros are already expanded
	  ;; by the time that is reached.
	  ((not (eq form
		    (setq form (macroexpand form
					    byte-compile-macro-environment))))
	   (byte-optimize-form form for-effect))
517 518 519

	  ;; Support compiler macros as in cl.el.
	  ((and (fboundp 'compiler-macroexpand)
520 521
		(symbolp (car-safe form))
		(get (car-safe form) 'cl-compiler-macro)
522
	        (not (eq form
523 524
			 (with-no-warnings
			  (setq form (compiler-macroexpand form))))))
525
	   (byte-optimize-form form for-effect))
526

Jim Blandy's avatar
Jim Blandy committed
527
	  ((not (symbolp fn))
528 529
	   (byte-compile-warn "`%s' is a malformed function"
			      (prin1-to-string fn))
Jim Blandy's avatar
Jim Blandy committed
530 531 532 533 534
	   form)

	  ((and for-effect (setq tmp (get fn 'side-effect-free))
		(or byte-compile-delete-errors
		    (eq tmp 'error-free)
535 536 537 538 539 540 541 542 543 544 545 546
		    ;; Detect the expansion of (pop foo).
		    ;; There is no need to compile the call to `car' there.
		    (and (eq fn 'car)
			 (eq (car-safe (cadr form)) 'prog1)
			 (let ((var (cadr (cadr form)))
			       (last (nth 2 (cadr form))))
			   (and (symbolp var)
				(null (nthcdr 3 (cadr form)))
				(eq (car-safe last) 'setq)
				(eq (cadr last) var)
				(eq (car-safe (nth 2 last)) 'cdr)
				(eq (cadr (nth 2 last)) var))))
Jim Blandy's avatar
Jim Blandy committed
547
		    (progn
548
		      (byte-compile-warn "`%s' called for effect"
549
					 (prin1-to-string (car form)))
Jim Blandy's avatar
Jim Blandy committed
550 551 552 553 554
		      nil)))
	   (byte-compile-log "  %s called for effect; deleted" fn)
	   ;; appending a nil here might not be necessary, but it can't hurt.
	   (byte-optimize-form
	    (cons 'progn (append (cdr form) '(nil))) t))
555

Jim Blandy's avatar
Jim Blandy committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
	  (t
	   ;; Otherwise, no args can be considered to be for-effect,
	   ;; even if the called function is for-effect, because we
	   ;; don't know anything about that function.
	   (cons fn (mapcar 'byte-optimize-form (cdr form)))))))


(defun byte-optimize-form (form &optional for-effect)
  "The source-level pass of the optimizer."
  ;;
  ;; First, optimize all sub-forms of this one.
  (setq form (byte-optimize-form-code-walker form for-effect))
  ;;
  ;; after optimizing all subforms, optimize this form until it doesn't
  ;; optimize any further.  This means that some forms will be passed through
  ;; the optimizer many times, but that's necessary to make the for-effect
  ;; processing do as much as possible.
  ;;
  (let (opt new)
    (if (and (consp form)
	     (symbolp (car form))
	     (or (and for-effect
		      ;; we don't have any of these yet, but we might.
		      (setq opt (get (car form) 'byte-for-effect-optimizer)))
		 (setq opt (get (car form) 'byte-optimizer)))
	     (not (eq form (setq new (funcall opt form)))))
	(progn
;;	  (if (equal form new) (error "bogus optimizer -- %s" opt))
	  (byte-compile-log "  %s\t==>\t%s" form new)
	  (setq new (byte-optimize-form new for-effect))
	  new)
      form)))


(defun byte-optimize-body (forms all-for-effect)
  ;; optimize the cdr of a progn or implicit progn; all forms is a list of
  ;; forms, all but the last of which are optimized with the assumption that
  ;; they are being called for effect.  the last is for-effect as well if
  ;; all-for-effect is true.  returns a new list of forms.
  (let ((rest forms)
	(result nil)
	fe new)
    (while rest
      (setq fe (or all-for-effect (cdr rest)))
      (setq new (and (car rest) (byte-optimize-form (car rest) fe)))
      (if (or new (not fe))
	  (setq result (cons new result)))
      (setq rest (cdr rest)))
    (nreverse result)))


607 608 609 610 611 612 613 614
;; some source-level optimizers
;;
;; when writing optimizers, be VERY careful that the optimizer returns
;; something not EQ to its argument if and ONLY if it has made a change.
;; This implies that you cannot simply destructively modify the list;
;; you must return something not EQ to it if you make an optimization.
;;
;; It is now safe to optimize code such that it introduces new bindings.
Jim Blandy's avatar
Jim Blandy committed
615

616
;; I'd like this to be a defsubst, but let's not be self-referential...
Jim Blandy's avatar
Jim Blandy committed
617 618
(defmacro byte-compile-trueconstp (form)
  ;; Returns non-nil if FORM is a non-nil constant.
Dave Love's avatar
Dave Love committed
619 620 621 622
  `(cond ((consp ,form) (eq (car ,form) 'quote))
	 ((not (symbolp ,form)))
	 ((eq ,form t))
	 ((keywordp ,form))))
Jim Blandy's avatar
Jim Blandy committed
623

624
;; If the function is being called with constant numeric args,
625
;; evaluate as much as possible at compile-time.  This optimizer
626
;; assumes that the function is associative, like + or *.
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
(defun byte-optimize-associative-math (form)
  (let ((args nil)
	(constants nil)
	(rest (cdr form)))
    (while rest
      (if (numberp (car rest))
	  (setq constants (cons (car rest) constants))
	  (setq args (cons (car rest) args)))
      (setq rest (cdr rest)))
    (if (cdr constants)
	(if args
	    (list (car form)
		  (apply (car form) constants)
		  (if (cdr args)
		      (cons (car form) (nreverse args))
		      (car args)))
	    (apply (car form) constants))
	form)))

646
;; If the function is being called with constant numeric args,
647 648 649 650
;; evaluate as much as possible at compile-time.  This optimizer
;; assumes that the function satisfies
;;   (op x1 x2 ... xn) == (op ...(op (op x1 x2) x3) ...xn)
;; like - and /.
Jim Blandy's avatar
Jim Blandy committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
(defun byte-optimize-nonassociative-math (form)
  (if (or (not (numberp (car (cdr form))))
	  (not (numberp (car (cdr (cdr form))))))
      form
    (let ((constant (car (cdr form)))
	  (rest (cdr (cdr form))))
      (while (numberp (car rest))
	(setq constant (funcall (car form) constant (car rest))
	      rest (cdr rest)))
      (if rest
	  (cons (car form) (cons constant rest))
	  constant))))

;;(defun byte-optimize-associative-two-args-math (form)
;;  (setq form (byte-optimize-associative-math form))
;;  (if (consp form)
;;      (byte-optimize-two-args-left form)
;;      form))

;;(defun byte-optimize-nonassociative-two-args-math (form)
;;  (setq form (byte-optimize-nonassociative-math form))
;;  (if (consp form)
;;      (byte-optimize-two-args-right form)
;;      form))

676
(defun byte-optimize-approx-equal (x y)
677
  (<= (* (abs (- x y)) 100) (abs (+ x y))))
678 679 680 681 682 683 684 685

;; Collect all the constants from FORM, after the STARTth arg,
;; and apply FUN to them to make one argument at the end.
;; For functions that can handle floats, that optimization
;; can be incorrect because reordering can cause an overflow
;; that would otherwise be avoided by encountering an arg that is a float.
;; We avoid this problem by (1) not moving float constants and
;; (2) not moving anything if it would cause an overflow.
Jim Blandy's avatar
Jim Blandy committed
686 687 688
(defun byte-optimize-delay-constants-math (form start fun)
  ;; Merge all FORM's constants from number START, call FUN on them
  ;; and put the result at the end.
689 690 691 692
  (let ((rest (nthcdr (1- start) form))
	(orig form)
	;; t means we must check for overflow.
	(overflow (memq fun '(+ *))))
Jim Blandy's avatar
Jim Blandy committed
693
    (while (cdr (setq rest (cdr rest)))
694
      (if (integerp (car rest))
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698
	  (let (constants)
	    (setq form (copy-sequence form)
		  rest (nthcdr (1- start) form))
	    (while (setq rest (cdr rest))
699
	      (cond ((integerp (car rest))
Jim Blandy's avatar
Jim Blandy committed
700 701
		     (setq constants (cons (car rest) constants))
		     (setcar rest nil))))
702 703 704 705 706 707 708 709 710 711 712 713
	    ;; If necessary, check now for overflow
	    ;; that might be caused by reordering.
	    (if (and overflow
		     ;; We have overflow if the result of doing the arithmetic
		     ;; on floats is not even close to the result
		     ;; of doing it on integers.
		     (not (byte-optimize-approx-equal
			    (apply fun (mapcar 'float constants))
			    (float (apply fun constants)))))
		(setq form orig)
	      (setq form (nconc (delq nil form)
				(list (apply fun (nreverse constants)))))))))
Jim Blandy's avatar
Jim Blandy committed
714 715 716 717 718 719 720 721 722 723
    form))

(defun byte-optimize-plus (form)
  (setq form (byte-optimize-delay-constants-math form 1 '+))
  (if (memq 0 form) (setq form (delq 0 (copy-sequence form))))
  ;;(setq form (byte-optimize-associative-two-args-math form))
  (cond ((null (cdr form))
	 (condition-case ()
	     (eval form)
	   (error form)))
724 725 726 727
;;;  It is not safe to delete the function entirely
;;;  (actually, it would be safe if we know the sole arg
;;;  is not a marker).
;;;	((null (cdr (cdr form))) (nth 1 form))
728 729 730 731
	((null (cddr form))
	 (if (numberp (nth 1 form))
	     (nth 1 form)
	   form))
732 733 734
	((and (null (nthcdr 3 form))
	      (or (memq (nth 1 form) '(1 -1))
		  (memq (nth 2 form) '(1 -1))))
735
	 ;; Optimize (+ x 1) into (1+ x) and (+ x -1) into (1- x).
736 737 738 739 740 741 742 743 744 745
	 (let ((integer
		(if (memq (nth 1 form) '(1 -1))
		    (nth 1 form)
		  (nth 2 form)))
	       (other
		(if (memq (nth 1 form) '(1 -1))
		    (nth 2 form)
		  (nth 1 form))))
	   (list (if (eq integer 1) '1+ '1-)
		 other)))
Jim Blandy's avatar
Jim Blandy committed
746 747 748 749 750 751 752 753 754 755 756
	(t form)))

(defun byte-optimize-minus (form)
  ;; Put constants at the end, except the last constant.
  (setq form (byte-optimize-delay-constants-math form 2 '+))
  ;; Now only first and last element can be a number.
  (let ((last (car (reverse (nthcdr 3 form)))))
    (cond ((eq 0 last)
	   ;; (- x y ... 0)  --> (- x y ...)
	   (setq form (copy-sequence form))
	   (setcdr (cdr (cdr form)) (delq 0 (nthcdr 3 form))))
757 758 759 760
	  ((equal (nthcdr 2 form) '(1))
	   (setq form (list '1- (nth 1 form))))
	  ((equal (nthcdr 2 form) '(-1))
	   (setq form (list '1+ (nth 1 form))))
Jim Blandy's avatar
Jim Blandy committed
761 762 763 764 765
	  ;; If form is (- CONST foo... CONST), merge first and last.
	  ((and (numberp (nth 1 form))
		(numberp last))
	   (setq form (nconc (list '- (- (nth 1 form) last) (nth 2 form))
			     (delq last (copy-sequence (nthcdr 3 form))))))))
766 767 768
;;;  It is not safe to delete the function entirely
;;;  (actually, it would be safe if we know the sole arg
;;;  is not a marker).
769 770
;;;  (if (eq (nth 2 form) 0)
;;;      (nth 1 form)			; (- x 0)  -->  x
Jim Blandy's avatar
Jim Blandy committed
771 772 773 774
    (byte-optimize-predicate
     (if (and (null (cdr (cdr (cdr form))))
	      (eq (nth 1 form) 0))	; (- 0 x)  -->  (- x)
	 (cons (car form) (cdr (cdr form)))
775 776 777
       form))
;;;    )
  )
Jim Blandy's avatar
Jim Blandy committed
778 779 780 781 782

(defun byte-optimize-multiply (form)
  (setq form (byte-optimize-delay-constants-math form 1 '*))
  ;; If there is a constant in FORM, it is now the last element.
  (cond ((null (cdr form)) 1)
783 784 785
;;;  It is not safe to delete the function entirely
;;;  (actually, it would be safe if we know the sole arg
;;;  is not a marker or if it appears in other arithmetic).
786
;;;	((null (cdr (cdr form))) (nth 1 form))
Jim Blandy's avatar
Jim Blandy committed
787
	((let ((last (car (reverse form))))
788
	   (cond ((eq 0 last)  (cons 'progn (cdr form)))
Jim Blandy's avatar
Jim Blandy committed
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
		 ((eq 1 last)  (delq 1 (copy-sequence form)))
		 ((eq -1 last) (list '- (delq -1 (copy-sequence form))))
		 ((and (eq 2 last)
		       (memq t (mapcar 'symbolp (cdr form))))
		  (prog1 (setq form (delq 2 (copy-sequence form)))
		    (while (not (symbolp (car (setq form (cdr form))))))
		    (setcar form (list '+ (car form) (car form)))))
		 (form))))))

(defsubst byte-compile-butlast (form)
  (nreverse (cdr (reverse form))))

(defun byte-optimize-divide (form)
  (setq form (byte-optimize-delay-constants-math form 2 '*))
  (let ((last (car (reverse (cdr (cdr form))))))
    (if (numberp last)
805
	(cond ((= (length form) 3)
806 807 808 809 810 811
	       (if (and (numberp (nth 1 form))
			(not (zerop last))
			(condition-case nil
			    (/ (nth 1 form) last)
			  (error nil)))
		   (setq form (list 'progn (/ (nth 1 form) last)))))
812
	      ((= last 1)
Jim Blandy's avatar
Jim Blandy committed
813 814 815 816 817 818
	       (setq form (byte-compile-butlast form)))
	      ((numberp (nth 1 form))
	       (setq form (cons (car form)
				(cons (/ (nth 1 form) last)
				      (byte-compile-butlast (cdr (cdr form)))))
		     last nil))))
819
    (cond
820 821
;;;	  ((null (cdr (cdr form)))
;;;	   (nth 1 form))
Jim Blandy's avatar
Jim Blandy committed
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
	  ((eq (nth 1 form) 0)
	   (append '(progn) (cdr (cdr form)) '(0)))
	  ((eq last -1)
	   (list '- (if (nthcdr 3 form)
			(byte-compile-butlast form)
		      (nth 1 form))))
	  (form))))

(defun byte-optimize-logmumble (form)
  (setq form (byte-optimize-delay-constants-math form 1 (car form)))
  (byte-optimize-predicate
   (cond ((memq 0 form)
	  (setq form (if (eq (car form) 'logand)
			 (cons 'progn (cdr form))
		       (delq 0 (copy-sequence form)))))
	 ((and (eq (car-safe form) 'logior)
	       (memq -1 form))
839
	  (cons 'progn (cdr form)))
Jim Blandy's avatar
Jim Blandy committed
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
	 (form))))


(defun byte-optimize-binary-predicate (form)
  (if (byte-compile-constp (nth 1 form))
      (if (byte-compile-constp (nth 2 form))
	  (condition-case ()
	      (list 'quote (eval form))
	    (error form))
	;; This can enable some lapcode optimizations.
	(list (car form) (nth 2 form) (nth 1 form)))
    form))

(defun byte-optimize-predicate (form)
  (let ((ok t)
	(rest (cdr form)))
    (while (and rest ok)
      (setq ok (byte-compile-constp (car rest))
	    rest (cdr rest)))
    (if ok
	(condition-case ()
	    (list 'quote (eval form))
	  (error form))
	form)))

(defun byte-optimize-identity (form)
  (if (and (cdr form) (null (cdr (cdr form))))
      (nth 1 form)
Gerd Moellmann's avatar
Gerd Moellmann committed
868
    (byte-compile-warn "identity called with %d arg%s, but requires 1"
Jim Blandy's avatar
Jim Blandy committed
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
		       (length (cdr form))
		       (if (= 1 (length (cdr form))) "" "s"))
    form))

(put 'identity 'byte-optimizer 'byte-optimize-identity)

(put '+   'byte-optimizer 'byte-optimize-plus)
(put '*   'byte-optimizer 'byte-optimize-multiply)
(put '-   'byte-optimizer 'byte-optimize-minus)
(put '/   'byte-optimizer 'byte-optimize-divide)
(put 'max 'byte-optimizer 'byte-optimize-associative-math)
(put 'min 'byte-optimizer 'byte-optimize-associative-math)

(put '=   'byte-optimizer 'byte-optimize-binary-predicate)
(put 'eq  'byte-optimizer 'byte-optimize-binary-predicate)
(put 'equal   'byte-optimizer 'byte-optimize-binary-predicate)
(put 'string= 'byte-optimizer 'byte-optimize-binary-predicate)
(put 'string-equal 'byte-optimizer 'byte-optimize-binary-predicate)

(put '<   'byte-optimizer 'byte-optimize-predicate)
(put '>   'byte-optimizer 'byte-optimize-predicate)
(put '<=  'byte-optimizer 'byte-optimize-predicate)
(put '>=  'byte-optimizer 'byte-optimize-predicate)
(put '1+  'byte-optimizer 'byte-optimize-predicate)
(put '1-  'byte-optimizer 'byte-optimize-predicate)
(put 'not 'byte-optimizer 'byte-optimize-predicate)
(put 'null  'byte-optimizer 'byte-optimize-predicate)
(put 'memq  'byte-optimizer 'byte-optimize-predicate)
(put 'consp 'byte-optimizer 'byte-optimize-predicate)
(put 'listp 'byte-optimizer 'byte-optimize-predicate)
(put 'symbolp 'byte-optimizer 'byte-optimize-predicate)
(put 'stringp 'byte-optimizer 'byte-optimize-predicate)
(put 'string< 'byte-optimizer 'byte-optimize-predicate)
(put 'string-lessp 'byte-optimizer 'byte-optimize-predicate)

(put 'logand 'byte-optimizer 'byte-optimize-logmumble)
(put 'logior 'byte-optimizer 'byte-optimize-logmumble)
(put 'logxor 'byte-optimizer 'byte-optimize-logmumble)
(put 'lognot 'byte-optimizer 'byte-optimize-predicate)

(put 'car 'byte-optimizer 'byte-optimize-predicate)
(put 'cdr 'byte-optimizer 'byte-optimize-predicate)
(put 'car-safe 'byte-optimizer 'byte-optimize-predicate)
(put 'cdr-safe 'byte-optimizer 'byte-optimize-predicate)


915
;; I'm not convinced that this is necessary.  Doesn't the optimizer loop
Jim Blandy's avatar
Jim Blandy committed
916 917
;; take care of this? - Jamie
;; I think this may some times be necessary to reduce ie (quote 5) to 5,
918
;; so arithmetic optimizers recognize the numeric constant.  - Hallvard
Jim Blandy's avatar
Jim Blandy committed
919 920 921 922
(put 'quote 'byte-optimizer 'byte-optimize-quote)
(defun byte-optimize-quote (form)
  (if (or (consp (nth 1 form))
	  (and (symbolp (nth 1 form))
Dave Love's avatar
Dave Love committed
923
	       (not (byte-compile-const-symbol-p form))))
Jim Blandy's avatar
Jim Blandy committed
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
      form
    (nth 1 form)))

(defun byte-optimize-zerop (form)
  (cond ((numberp (nth 1 form))
	 (eval form))
	(byte-compile-delete-errors
	 (list '= (nth 1 form) 0))
	(form)))

(put 'zerop 'byte-optimizer 'byte-optimize-zerop)

(defun byte-optimize-and (form)
  ;; Simplify if less than 2 args.
  ;; if there is a literal nil in the args to `and', throw it and following
  ;; forms away, and surround the `and' with (progn ... nil).
  (cond ((null (cdr form)))
	((memq nil form)
	 (list 'progn
	       (byte-optimize-and
		(prog1 (setq form (copy-sequence form))
		  (while (nth 1 form)
		    (setq form (cdr form)))
		  (setcdr form nil)))
	       nil))
	((null (cdr (cdr form)))
	 (nth 1 form))
	((byte-optimize-predicate form))))

(defun byte-optimize-or (form)
  ;; Throw away nil's, and simplify if less than 2 args.
  ;; If there is a literal non-nil constant in the args to `or', throw away all
  ;; following forms.
  (if (memq nil form)
      (setq form (delq nil (copy-sequence form))))
  (let ((rest form))
    (while (cdr (setq rest (cdr rest)))
      (if (byte-compile-trueconstp (car rest))
	  (setq form (copy-sequence form)
		rest (setcdr (memq (car rest) form) nil))))
    (if (cdr (cdr form))
	(byte-optimize-predicate form)
      (nth 1 form))))

(defun byte-optimize-cond (form)
  ;; if any clauses have a literal nil as their test, throw them away.
  ;; if any clause has a literal non-nil constant as its test, throw
  ;; away all following clauses.
  (let (rest)
    ;; This must be first, to reduce (cond (t ...) (nil)) to (progn t ...)
    (while (setq rest (assq nil (cdr form)))
      (setq form (delq rest (copy-sequence form))))
    (if (memq nil (cdr form))
	(setq form (delq nil (copy-sequence form))))
    (setq rest form)
    (while (setq rest (cdr rest))
      (cond ((byte-compile-trueconstp (car-safe (car rest)))
	     (cond ((eq rest (cdr form))
		    (setq form
			  (if (cdr (car rest))
			      (if (cdr (cdr (car rest)))
				  (cons 'progn (cdr (car rest)))
				(nth 1 (car rest)))
			    (car (car rest)))))
		   ((cdr rest)
		    (setq form (copy-sequence form))
		    (setcdr (memq (car rest) form) nil)))
	     (setq rest nil)))))
  ;;
  ;; Turn (cond (( <x> )) ... ) into (or <x> (cond ... ))
  (if (eq 'cond (car-safe form))
      (let ((clauses (cdr form)))
	(if (and (consp (car clauses))
		 (null (cdr (car clauses))))
	    (list 'or (car (car clauses))
		  (byte-optimize-cond
		   (cons (car form) (cdr (cdr form)))))
	  form))
    form))

(defun byte-optimize-if (form)
  ;; (if <true-constant> <then> <else...>) ==> <then>
  ;; (if <false-constant> <then> <else...>) ==> (progn <else...>)
  ;; (if <test> nil <else...>) ==> (if (not <test>) (progn <else...>))
  ;; (if <test> <then> nil) ==> (if <test> <then>)
  (let ((clause (nth 1 form)))
    (cond ((byte-compile-trueconstp clause)
	   (nth 2 form))
	  ((null clause)
	   (if (nthcdr 4 form)
	       (cons 'progn (nthcdr 3 form))
	     (nth 3 form)))
	  ((nth 2 form)
	   (if (equal '(nil) (nthcdr 3 form))
	       (list 'if clause (nth 2 form))
	     form))
	  ((or (nth 3 form) (nthcdr 4 form))
1021 1022 1023 1024 1025 1026 1027
	   (list 'if
		 ;; Don't make a double negative;
		 ;; instead, take away the one that is there.
		 (if (and (consp clause) (memq (car clause) '(not null))
			  (= (length clause) 2)) ; (not xxxx) or (not (xxxx))
		     (nth 1 clause)
		   (list 'not clause))
Jim Blandy's avatar
Jim Blandy committed
1028 1029 1030 1031 1032 1033 1034
		 (if (nthcdr 4 form)
		     (cons 'progn (nthcdr 3 form))
		   (nth 3 form))))
	  (t
	   (list 'progn clause nil)))))

(defun byte-optimize-while (form)
Gerd Moellmann's avatar
Gerd Moellmann committed
1035
  (when (< (length form) 2)
Gerd Moellmann's avatar
Gerd Moellmann committed
1036
    (byte-compile-warn "too few arguments for `while'"))
Jim Blandy's avatar
Jim Blandy committed
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
  (if (nth 1 form)
      form))

(put 'and   'byte-optimizer 'byte-optimize-and)
(put 'or    'byte-optimizer 'byte-optimize-or)
(put 'cond  'byte-optimizer 'byte-optimize-cond)
(put 'if    'byte-optimizer 'byte-optimize-if)
(put 'while 'byte-optimizer 'byte-optimize-while)

;; byte-compile-negation-optimizer lives in bytecomp.el
(put '/= 'byte-optimizer 'byte-compile-negation-optimizer)
(put 'atom 'byte-optimizer 'byte-compile-negation-optimizer)
(put 'nlistp 'byte-optimizer 'byte-compile-negation-optimizer)


(defun byte-optimize-funcall (form)
Stefan Monnier's avatar
Stefan Monnier committed
1053 1054
  ;; (funcall (lambda ...) ...) ==> ((lambda ...) ...)
  ;; (funcall foo ...) ==> (foo ...)
Jim Blandy's avatar
Jim Blandy committed
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
  (let ((fn (nth 1 form)))
    (if (memq (car-safe fn) '(quote function))
	(cons (nth 1 fn) (cdr (cdr form)))
	form)))

(defun byte-optimize-apply (form)
  ;; If the last arg is a literal constant, turn this into a funcall.
  ;; The funcall optimizer can then transform (funcall 'foo ...) -> (foo ...).
  (let ((fn (nth 1 form))
	(last (nth (1- (length form)) form))) ; I think this really is fastest
    (or (if (or (null last)
		(eq (car-safe last) 'quote))
	    (if (listp (nth 1 last))
		(let ((butlast (nreverse (cdr (reverse (cdr (cdr form)))))))
Jim Blandy's avatar
Jim Blandy committed
1069
		  (nconc (list 'funcall fn) butlast
Stefan Monnier's avatar
Stefan Monnier committed
1070
			 (mapcar (lambda (x) (list 'quote x)) (nth 1 last))))
Jim Blandy's avatar
Jim Blandy committed
1071
	      (byte-compile-warn
Gerd Moellmann's avatar
Gerd Moellmann committed
1072
	       "last arg to apply can't be a literal atom: `%s'"
Jim Blandy's avatar
Jim Blandy committed
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
	       (prin1-to-string last))
	      nil))
	form)))

(put 'funcall 'byte-optimizer 'byte-optimize-funcall)
(put 'apply   'byte-optimizer 'byte-optimize-apply)


(put 'let 'byte-optimizer 'byte-optimize-letX)
(put 'let* 'byte-optimizer 'byte-optimize-letX)
(defun byte-optimize-letX (form)
  (cond ((null (nth 1 form))
	 ;; No bindings
	 (cons 'progn (cdr (cdr form))))
	((or (nth 2 form) (nthcdr 3 form))
	 form)
	 ;; The body is nil
	((eq (car form) 'let)
1091 1092
	 (append '(progn) (mapcar 'car-safe (mapcar 'cdr-safe (nth 1 form)))
		 '(nil)))
Jim Blandy's avatar
Jim Blandy committed
1093 1094 1095 1096 1097 1098 1099
	(t
	 (let ((binds (reverse (nth 1 form))))
	   (list 'let* (reverse (cdr binds)) (nth 1 (car binds)) nil)))))


(put 'nth 'byte-optimizer 'byte-optimize-nth)
(defun byte-optimize-nth (form)
Dave Love's avatar
Dave Love committed
1100 1101 1102 1103 1104 1105 1106
  (if (= (safe-length form) 3)
      (if (memq (nth 1 form) '(0 1))
	  (list 'car (if (zerop (nth 1 form))
			 (nth 2 form)
		       (list 'cdr (nth 2 form))))
	(byte-optimize-predicate form))
    form))
Jim Blandy's avatar
Jim Blandy committed
1107 1108 1109

(put 'nthcdr 'byte-optimizer 'byte-optimize-nthcdr)
(defun byte-optimize-nthcdr (form)
Dave Love's avatar
Dave Love committed
1110 1111 1112 1113 1114 1115 1116 1117 1118
  (if (= (safe-length form) 3)
      (if (memq (nth 1 form) '(0 1 2))
	  (let ((count (nth 1 form)))
	    (setq form (nth 2 form))
	    (while (>= (setq count (1- count)) 0)
	      (setq form (list 'cdr form)))
	    form)
	(byte-optimize-predicate form))
    form))
1119

1120 1121 1122 1123
(put 'concat 'byte-optimizer 'byte-optimize-pure-func)
(put 'symbol-name 'byte-optimizer 'byte-optimize-pure-func)
(put 'regexp-opt 'byte-optimizer 'byte-optimize-pure-func)
(put 'regexp-quote 'byte-optimizer 'byte-optimize-pure-func)
1124
(put 'string-to-syntax 'byte-optimizer 'byte-optimize-pure-func)
1125 1126 1127 1128 1129
(defun byte-optimize-pure-func (form)
  "Do constant folding for pure functions.
This assumes that the function will not have any side-effects and that
its return value depends solely on its arguments.
If the function can signal an error, this might change the semantics
1130
of FORM by signaling the error at compile-time."
1131 1132 1133 1134 1135 1136 1137
  (let ((args (cdr form))
	(constant t))
    (while (and args constant)
      (or (byte-compile-constp (car args))
	  (setq constant nil))
      (setq args (cdr args)))
    (if constant
1138
	(list 'quote (eval form))
1139
      form)))
1140 1141

;; Avoid having to write forward-... with a negative arg for speed.
Dave Love's avatar
Dave Love committed
1142
;; Fixme: don't be limited to constant args.
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
(put 'backward-char 'byte-optimizer 'byte-optimize-backward-char)
(defun byte-optimize-backward-char (form)
  (cond ((and (= 2 (safe-length form))
	      (numberp (nth 1 form)))
	 (list 'forward-char (eval (- (nth 1 form)))))
	((= 1 (safe-length form))
	 '(forward-char -1))
	(t form)))

(put 'backward-word 'byte-optimizer 'byte-optimize-backward-word)
(defun byte-optimize-backward-word (form)
  (cond ((and (= 2 (safe-length form))
	      (numberp (nth 1 form)))
	 (list 'forward-word (eval (- (nth 1 form)))))
	((= 1 (safe-length form))
1158
	 '(forward-word -1))
1159
	(t form)))
Dave Love's avatar
Dave Love committed
1160 1161 1162 1163 1164 1165 1166 1167

(put 'char-before 'byte-optimizer 'byte-optimize-char-before)
(defun byte-optimize-char-before (form)
  (cond ((= 2 (safe-length form))
	 `(char-after (1- ,(nth 1 form))))
	((= 1 (safe-length form))
	 '(char-after (1- (point))))
	(t form)))
Dave Love's avatar
Dave Love committed
1168 1169 1170 1171 1172 1173 1174

;; Fixme: delete-char -> delete-region (byte-coded)
;; optimize string-as-unibyte, string-as-multibyte, string-make-unibyte,
;; string-make-multibyte for constant args.

(put 'featurep 'byte-optimizer 'byte-optimize-featurep)
(defun byte-optimize-featurep (form)
1175 1176
  ;; Emacs-21's byte-code doesn't run under XEmacs anyway, so we can
  ;; safely optimize away this test.
Dave Love's avatar
Dave Love committed
1177 1178 1179
  (if (equal '((quote xemacs)) (cdr-safe form))
      nil
    form))
1180 1181 1182 1183 1184 1185

(put 'set 'byte-optimizer 'byte-optimize-set)
(defun byte-optimize-set (form)
  (let ((var (car-safe (cdr-safe form))))
    (cond
     ((and (eq (car-safe var) 'quote) (consp (cdr var)))
1186
      `(setq ,(cadr var) ,@(cddr form)))
1187 1188 1189 1190 1191
     ((and (eq (car-safe var) 'make-local-variable)
	   (eq (car-safe (setq var (car-safe (cdr var)))) 'quote)
	   (consp (cdr var)))
      `(progn ,(cadr form) (setq ,(cadr var) ,@(cddr form))))
     (t form))))
Jim Blandy's avatar
Jim Blandy committed
1192

1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
;; enumerating those functions which need not be called if the returned
;; value is not used.  That is, something like
;;    (progn (list (something-with-side-effects) (yow))
;;           (foo))
;; may safely be turned into
;;    (progn (progn (something-with-side-effects) (yow))
;;           (foo))
;; Further optimizations will turn (progn (list 1 2 3) 'foo) into 'foo.

;; Some of these functions have the side effect of allocating memory
;; and it would be incorrect to replace two calls with one.
;; But we don't try to do those kinds of optimizations,
;; so it is safe to list such functions here.
;; Some of these functions return values that depend on environment
;; state, so that constant folding them would be wrong,
;; but we don't do constant folding based on this list.

;; However, at present the only optimization we normally do
;; is delete calls that need not occur, and we only do that
;; with the error-free functions.

;; I wonder if I missed any :-\)
Jim Blandy's avatar
Jim Blandy committed
1215
(let ((side-effect-free-fns
1216 1217 1218
       '(% * + - / /= 1+ 1- < <= = > >= abs acos append aref ash asin atan
	 assoc assq
	 boundp buffer-file-name buffer-local-variables buffer-modified-p
1219
	 buffer-substring byte-code-function-p
1220
	 capitalize car-less-than-car car cdr ceiling char-after char-before
1221 1222 1223 1224 1225 1226
	 char-equal char-to-string char-width
	 compare-strings concat coordinates-in-window-p
	 copy-alist copy-sequence copy-marker cos count-lines
	 decode-time default-boundp default-value documentation downcase
	 elt exp expt encode-time error-message-string
	 fboundp fceiling featurep ffloor
Jim Blandy's avatar
Jim Blandy committed
1227 1228
	 file-directory-p file-exists-p file-locked-p file-name-absolute-p
	 file-newer-than-file-p file-readable-p file-symlink-p file-writable-p
1229 1230
	 float float-time floor format format-time-string frame-visible-p
	 fround ftruncate
1231 1232
	 get gethash get-buffer get-buffer-window getenv get-file-buffer
	 hash-table-count
1233
	 int-to-string intern-soft
1234
	 keymap-parent
Dave Love's avatar
Dave Love committed
1235 1236
	 length local-variable-if-set-p local-variable-p log log10 logand
	 logb logior lognot logxor lsh
1237
	 make-list make-string make-symbol
Dave Love's avatar
Dave Love committed
1238
	 marker-buffer max member memq min mod multibyte-char-to-unibyte
1239
	 next-window nth nthcdr number-to-string
1240 1241 1242 1243
	 parse-colon-path plist-get plist-member
	 prefix-numeric-value previous-window prin1-to-string propertize
	 radians-to-degrees rassq rassoc read-from-string regexp-quote
	 region-beginning region-end reverse round
1244
	 sin sqrt string string< string= string-equal string-lessp string-to-char
1245
	 string-to-int string-to-number substring sxhash symbol-function
Dave Love's avatar
Dave Love committed
1246 1247
	 symbol-name symbol-plist symbol-value string-make-unibyte
	 string-make-multibyte string-as-multibyte string-as-unibyte
1248 1249 1250 1251
	 tan truncate
	 unibyte-char-to-multibyte upcase user-full-name
	 user-login-name user-original-login-name user-variable-p
	 vconcat
1252 1253
	 window-buffer window-dedicated-p window-edges window-height
	 window-hscroll window-minibuffer-p window-width
Jim Blandy's avatar
Jim Blandy committed
1254 1255
	 zerop))
      (side-effect-and-error-free-fns
1256
       '(arrayp atom
1257
	 bobp bolp bool-vector-p
1258
	 buffer-end buffer-list buffer-size buffer-string bufferp
1259
	 car-safe case-table-p cdr-safe char-or-string-p commandp cons consp
1260
	 current-buffer current-global-map current-indentation
1261 1262 1263
	 current-local-map current-minor-mode-maps current-time
	 current-time-string current-time-zone
	 eobp eolp eq equal eventp
1264
	 floatp following-char framep
1265
	 get-largest-window get-lru-window
1266
	 hash-table-p
1267 1268
	 identity ignore integerp integer-or-marker-p interactive-p
	 invocation-directory invocation-name
1269 1270
	 keymapp
	 line-beginning-position line-end-position list listp
1271 1272 1273 1274
	 make-marker mark mark-marker markerp memory-limit minibuffer-window
	 mouse-movement-p
	 natnump nlistp not null number-or-marker-p numberp
	 one-window-p overlayp
1275
	 point point-marker point-min point-max preceding-char processp
1276
	 recent-keys recursion-depth
1277 1278 1279
	 safe-length selected-frame selected-window sequencep
	 standard-case-table standard-syntax-table stringp subrp symbolp
	 syntax-table syntax-table-p
1280 1281
	 this-command-keys this-command-keys-vector this-single-command-keys
	 this-single-command-raw-keys
1282
	 user-real-login-name user-real-uid user-uid
1283
	 vector vectorp visible-frame-list
1284
	 wholenump window-configuration-p window-live-p windowp)))
Jim Blandy's avatar
Jim Blandy committed
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
  (while side-effect-free-fns
    (put (car side-effect-free-fns) 'side-effect-free t)
    (setq side-effect-free-fns (cdr side-effect-free-fns)))
  (while side-effect-and-error-free-fns
    (put (car side-effect-and-error-free-fns) 'side-effect-free 'error-free)
    (setq side-effect-and-error-free-fns (cdr side-effect-and-error-free-fns)))
  nil)


(defun byte-compile-splice-in-already-compiled-code (form)
  ;; form is (byte-code "..." [...] n)
  (if (not (memq byte-optimize '(t lap)))
      (byte-compile-normal-call form)
    (byte-inline-lapcode
     (byte-decompile-bytecode-1 (nth 1 form) (nth 2 form) t))
    (setq byte-compile-maxdepth (max (+ byte-compile-depth (nth 3 form))
				     byte-compile-maxdepth))
    (setq byte-compile-depth (1+ byte-compile-depth))))

(put 'byte-code 'byte-compile 'byte-compile-splice-in-already-compiled-code)


(defconst byte-constref-ops
  '(byte-constant byte-constant2 byte-varref byte-varset byte-varbind))

1310 1311
;; This function extracts the bitfields from variable-length opcodes.
;; Originally defined in disass.el (which no longer uses it.)
Jim Blandy's avatar
Jim Blandy committed
1312 1313 1314 1315

(defun disassemble-offset ()
  "Don't call this!"
  ;; fetch and return the offset for the current opcode.
Pavel Janík's avatar
Pavel Janík committed
1316
  ;; return nil if this opcode has no offset
Jim Blandy's avatar
Jim Blandy committed
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
  ;; OP, PTR and BYTES are used and set dynamically
  (defvar op)
  (defvar ptr)
  (defvar bytes)
  (cond ((< op byte-nth)
	 (let ((tem (logand op 7)))
	   (setq op (logand op 248))
	   (cond ((eq tem 6)
		  (setq ptr (1+ ptr))	;offset in next byte
		  (aref bytes ptr))
		 ((eq tem 7)
		  (setq ptr (1+ ptr))	;offset in next 2 bytes
		  (+ (aref bytes ptr)
		     (progn (setq ptr (1+ ptr))
			    (lsh (aref bytes ptr) 8))))
		 (t tem))))		;offset was in opcode
	((>= op byte-constant)
	 (prog1 (- op byte-constant)	;offset in opcode
	   (setq op byte-constant)))
	((and (>= op byte-constant2)
	      (<= op byte-goto-if-not-nil-else-pop))
	 (setq ptr (1+ ptr))		;offset in next 2 bytes
	 (+ (aref bytes ptr)
	    (progn (setq ptr (1+ ptr))
		   (lsh (aref bytes ptr) 8))))
Jim Blandy's avatar
Jim Blandy committed
1342
	((and (>= op byte-listN)
Jim Blandy's avatar
Jim Blandy committed
1343 1344 1345 1346 1347
	      (<= op byte-insertN))
	 (setq ptr (1+ ptr))		;offset in next byte
	 (aref bytes ptr))))


1348 1349 1350 1351 1352
;; This de-compiler is used for inline expansion of compiled functions,
;; and by the disassembler.
;;
;; This list contains numbers, which are pc values,
;; before each instruction.
Jim Blandy's avatar
Jim Blandy committed
1353
(defun byte-decompile-bytecode (bytes constvec)
1354
  "Turns BYTECODE into lapcode, referring to CONSTVEC."
Jim Blandy's avatar
Jim Blandy committed
1355 1356 1357 1358 1359
  (let ((byte-compile-constants nil)
	(byte-compile-variables nil)
	(byte-compile-tag-number 0))
    (byte-decompile-bytecode-1 bytes constvec)))

1360 1361
;; As byte-decompile-bytecode, but updates
;; byte-compile-{constants, variables, tag-number}.
1362
;; If MAKE-SPLICEABLE is true, then `return' opcodes are replaced
1363
;; with `goto's destined for the end of the code.
1364 1365 1366 1367 1368
;; That is for use by the compiler.
;; If MAKE-SPLICEABLE is nil, we are being called for the disassembler.
;; In that case, we put a pc value into the list
;; before each insn (or its label).
(defun byte-decompile-bytecode-1 (bytes constvec &optional make-spliceable)
Jim Blandy's avatar
Jim Blandy committed
1369
  (let ((length (length bytes))
1370
	(ptr 0) optr tags op offset
Jim Blandy's avatar
Jim Blandy committed
1371
	lap tmp
1372
	endtag)
Jim Blandy's avatar
Jim Blandy committed
1373
    (while (not (= ptr length))
1374 1375
      (or make-spliceable
	  (setq lap (cons ptr lap)))
Jim Blandy's avatar
Jim Blandy committed
1376 1377 1378 1379
      (setq op (aref bytes ptr)
	    optr ptr
	    offset (disassemble-offset)) ; this does dynamic-scope magic
      (setq op (aref byte-code-vector op))
Jim Blandy's avatar
Jim Blandy committed
1380
      (cond ((memq op byte-goto-ops)
Jim Blandy's avatar
Jim Blandy committed
1381 1382 1383 1384 1385 1386 1387 1388 1389
	     ;; it's a pc
	     (setq offset
		   (cdr (or (assq offset tags)
			    (car (setq tags
				       (cons (cons offset
						   (byte-compile-make-tag))
					     tags)))))))
	    ((cond ((eq op 'byte-constant2) (setq op 'byte-constant) t)
		   ((memq op byte-constref-ops)))
1390 1391 1392
	     (setq tmp (if (>= offset (length constvec))
			   (list 'out-of-range offset)
			 (aref constvec offset))
Jim Blandy's avatar
Jim Blandy committed
1393 1394 1395 1396 1397 1398
		   offset (if (eq op 'byte-constant)
			      (byte-compile-get-constant tmp)
			    (or (assq tmp byte-compile-variables)
				(car (setq byte-compile-variables
					   (cons (list tmp)
						 byte-compile-variables)))))))
1399
	    ((and make-spliceable