bytecomp.el 152 KB
Newer Older
1
;;; bytecomp.el --- compilation of Lisp code into byte code
2

3
;; Copyright (C) 1985,86,87,92,94,1998,2000,01,02,03,2004
Dave Love's avatar
Dave Love committed
4
;;   Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6 7
;; Author: Jamie Zawinski <jwz@lucid.com>
;;	Hallvard Furuseth <hbf@ulrik.uio.no>
8
;; Maintainer: FSF
Richard M. Stallman's avatar
Richard M. Stallman committed
9
;; Keywords: lisp
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
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 25 26
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
27

28 29 30
;;; Commentary:

;; The Emacs Lisp byte compiler.  This crunches lisp source into a sort
31 32
;; of p-code (`lapcode') which takes up less space and can be interpreted
;; faster.  [`LAP' == `Lisp Assembly Program'.]
33 34
;; The user entry points are byte-compile-file and byte-recompile-directory.

35 36
;;; Code:

Erik Naggum's avatar
Erik Naggum committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
;; ========================================================================
;; Entry points:
;;	byte-recompile-directory, byte-compile-file,
;;     batch-byte-compile, batch-byte-recompile-directory,
;;	byte-compile, compile-defun,
;;	display-call-tree
;; (byte-compile-buffer and byte-compile-and-load-file were turned off
;;  because they are not terribly useful and get in the way of completion.)

;; This version of the byte compiler has the following improvements:
;;  + optimization of compiled code:
;;    - removal of unreachable code;
;;    - removal of calls to side-effectless functions whose return-value
;;      is unused;
;;    - compile-time evaluation of safe constant forms, such as (consp nil)
;;      and (ash 1 6);
;;    - open-coding of literal lambdas;
;;    - peephole optimization of emitted code;
;;    - trivial functions are left uncompiled for speed.
;;  + support for inline functions;
;;  + compile-time evaluation of arbitrary expressions;
;;  + compile-time warning messages for:
;;    - functions being redefined with incompatible arglists;
;;    - functions being redefined as macros, or vice-versa;
;;    - functions or macros defined multiple times in the same file;
;;    - functions being called with the incorrect number of arguments;
Dave Love's avatar
Dave Love committed
63
;;    - functions being called which are not defined globally, in the
Erik Naggum's avatar
Erik Naggum committed
64 65 66 67 68 69 70 71 72 73
;;      file, or as autoloads;
;;    - assignment and reference of undeclared free variables;
;;    - various syntax errors;
;;  + correct compilation of nested defuns, defmacros, defvars and defsubsts;
;;  + correct compilation of top-level uses of macros;
;;  + the ability to generate a histogram of functions called.

;; User customization variables:
;;
;; byte-compile-verbose	Whether to report the function currently being
Luc Teirlinck's avatar
Luc Teirlinck committed
74
;;				compiled in the echo area;
Dave Love's avatar
Dave Love committed
75
;; byte-optimize		Whether to do optimizations; this may be
Erik Naggum's avatar
Erik Naggum committed
76
;;				t, nil, 'source, or 'byte;
Dave Love's avatar
Dave Love committed
77
;; byte-optimize-log		Whether to report (in excruciating detail)
Erik Naggum's avatar
Erik Naggum committed
78 79 80 81 82 83 84 85
;;				exactly which optimizations have been made.
;;				This may be t, nil, 'source, or 'byte;
;; byte-compile-error-on-warn	Whether to stop compilation when a warning is
;;				produced;
;; byte-compile-delete-errors	Whether the optimizer may delete calls or
;;				variable references that are side-effect-free
;;				except that they may return an error.
;; byte-compile-generate-call-tree	Whether to generate a histogram of
Dave Love's avatar
Dave Love committed
86
;;				function calls.  This can be useful for
Erik Naggum's avatar
Erik Naggum committed
87 88 89
;;				finding unused functions, as well as simple
;;				performance metering.
;; byte-compile-warnings	List of warnings to issue, or t.  May contain
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91 92 93 94 95 96 97 98 99 100
;;				`free-vars' (references to variables not in the
;;					     current lexical scope)
;;				`unresolved' (calls to unknown functions)
;;				`callargs'  (lambda calls with args that don't
;;					     match the lambda's definition)
;;				`redefine'  (function cell redefined from
;;					     a macro to a lambda or vice versa,
;;					     or redefined to take other args)
;;				`obsolete'  (obsolete variables and functions)
;;				`noruntime' (calls to functions only defined
;;					     within `eval-when-compile')
Erik Naggum's avatar
Erik Naggum committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
;; byte-compile-compatibility	Whether the compiler should
;;				generate .elc files which can be loaded into
;;				generic emacs 18.
;; emacs-lisp-file-regexp	Regexp for the extension of source-files;
;;				see also the function byte-compile-dest-file.

;; New Features:
;;
;;  o	The form `defsubst' is just like `defun', except that the function
;;	generated will be open-coded in compiled code which uses it.  This
;;	means that no function call will be generated, it will simply be
;;	spliced in.  Lisp functions calls are very slow, so this can be a
;;	big win.
;;
;;	You can generally accomplish the same thing with `defmacro', but in
;;	that case, the defined procedure can't be used as an argument to
;;	mapcar, etc.
;;
;;  o	You can also open-code one particular call to a function without
;;	open-coding all calls.  Use the 'inline' form to do this, like so:
;;
;;		(inline (foo 1 2 3))	;; `foo' will be open-coded
;;	or...
Dave Love's avatar
Dave Love committed
124
;;		(inline			;;  `foo' and `baz' will be
Erik Naggum's avatar
Erik Naggum committed
125 126 127 128
;;		 (foo 1 2 3 (bar 5))	;; open-coded, but `bar' will not.
;;		 (baz 0))
;;
;;  o	It is possible to open-code a function in the same file it is defined
Luc Teirlinck's avatar
Luc Teirlinck committed
129
;;	in without having to load that file before compiling it.  The
Erik Naggum's avatar
Erik Naggum committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
;;	byte-compiler has been modified to remember function definitions in
;;	the compilation environment in the same way that it remembers macro
;;	definitions.
;;
;;  o  Forms like ((lambda ...) ...) are open-coded.
;;
;;  o  The form `eval-when-compile' is like progn, except that the body
;;     is evaluated at compile-time.  When it appears at top-level, this
;;     is analogous to the Common Lisp idiom (eval-when (compile) ...).
;;     When it does not appear at top-level, it is similar to the
;;     Common Lisp #. reader macro (but not in interpreted code).
;;
;;  o  The form `eval-and-compile' is similar to eval-when-compile, but
;;	the whole form is evalled both at compile-time and at run-time.
;;
;;  o  The command compile-defun is analogous to eval-defun.
;;
Dave Love's avatar
Dave Love committed
147
;;  o  If you run byte-compile-file on a filename which is visited in a
Erik Naggum's avatar
Erik Naggum committed
148 149 150 151 152
;;     buffer, and that buffer is modified, you are asked whether you want
;;     to save the buffer before compiling.
;;
;;  o  byte-compiled files now start with the string `;ELC'.
;;     Some versions of `file' can be customized to recognize that.
Jim Blandy's avatar
Jim Blandy committed
153

154 155
(require 'backquote)

Jim Blandy's avatar
Jim Blandy committed
156 157
(or (fboundp 'defsubst)
    ;; This really ought to be loaded already!
158
    (load "byte-run"))
Jim Blandy's avatar
Jim Blandy committed
159

160 161
;; The feature of compiling in a specific target Emacs version
;; has been turned off because compile time options are a bad idea.
162 163
(defmacro byte-compile-single-version () nil)
(defmacro byte-compile-version-cond (cond) cond)
Jim Blandy's avatar
Jim Blandy committed
164

165 166 167 168 169
;; The crud you see scattered through this file of the form
;;   (or (and (boundp 'epoch::version) epoch::version)
;;	  (string-lessp emacs-version "19"))
;; is because the Epoch folks couldn't be bothered to follow the
;; normal emacs version numbering convention.
Jim Blandy's avatar
Jim Blandy committed
170

171 172 173 174 175 176
;; (if (byte-compile-version-cond
;;      (or (and (boundp 'epoch::version) epoch::version)
;; 	 (string-lessp emacs-version "19")))
;;     (progn
;;       ;; emacs-18 compatibility.
;;       (defvar baud-rate (baud-rate))	;Define baud-rate if it's undefined
177
;;
178
;;       (if (byte-compile-single-version)
179 180
;; 	  (defmacro byte-code-function-p (x) "Emacs 18 doesn't have these." nil)
;; 	(defun byte-code-function-p (x) "Emacs 18 doesn't have these." nil))
181
;;
182 183 184 185 186 187 188 189 190 191
;;       (or (and (fboundp 'member)
;; 	       ;; avoid using someone else's possibly bogus definition of this.
;; 	       (subrp (symbol-function 'member)))
;; 	  (defun member (elt list)
;; 	    "like memq, but uses equal instead of eq.  In v19, this is a subr."
;; 	    (while (and list (not (equal elt (car list))))
;; 	      (setq list (cdr list)))
;; 	    list))))


Richard M. Stallman's avatar
Richard M. Stallman committed
192 193 194 195 196 197 198
(defgroup bytecomp nil
  "Emacs Lisp byte-compiler"
  :group 'lisp)

(defcustom emacs-lisp-file-regexp (if (eq system-type 'vax-vms)
				      "\\.EL\\(;[0-9]+\\)?$"
				    "\\.el$")
199
  "*Regexp which matches Emacs Lisp source files.
Richard M. Stallman's avatar
Richard M. Stallman committed
200 201 202 203
You may want to redefine the function `byte-compile-dest-file'
if you change this variable."
  :group 'bytecomp
  :type 'regexp)
Jim Blandy's avatar
Jim Blandy committed
204

205 206 207 208 209 210 211 212 213 214
;; This enables file name handlers such as jka-compr
;; to remove parts of the file name that should not be copied
;; through to the output file name.
(defun byte-compiler-base-file-name (filename)
  (let ((handler (find-file-name-handler filename
					 'byte-compiler-base-file-name)))
    (if handler
	(funcall handler 'byte-compiler-base-file-name filename)
      filename)))

Jim Blandy's avatar
Jim Blandy committed
215
(or (fboundp 'byte-compile-dest-file)
216
    ;; The user may want to redefine this along with emacs-lisp-file-regexp,
Jim Blandy's avatar
Jim Blandy committed
217 218
    ;; so only define it if it is undefined.
    (defun byte-compile-dest-file (filename)
219
      "Convert an Emacs Lisp source file name to a compiled file name."
220
      (setq filename (byte-compiler-base-file-name filename))
Jim Blandy's avatar
Jim Blandy committed
221 222
      (setq filename (file-name-sans-versions filename))
      (cond ((eq system-type 'vax-vms)
Richard M. Stallman's avatar
Richard M. Stallman committed
223 224 225 226
	     (concat (substring filename 0 (string-match ";" filename)) "c"))
	    ((string-match emacs-lisp-file-regexp filename)
	     (concat (substring filename 0 (match-beginning 0)) ".elc"))
	    (t (concat filename ".elc")))))
Jim Blandy's avatar
Jim Blandy committed
227 228

;; This can be the 'byte-compile property of any symbol.
229
(autoload 'byte-compile-inline-expand "byte-opt")
Jim Blandy's avatar
Jim Blandy committed
230 231

;; This is the entrypoint to the lapcode optimizer pass1.
232
(autoload 'byte-optimize-form "byte-opt")
Jim Blandy's avatar
Jim Blandy committed
233
;; This is the entrypoint to the lapcode optimizer pass2.
234 235
(autoload 'byte-optimize-lapcode "byte-opt")
(autoload 'byte-compile-unfold-lambda "byte-opt")
Jim Blandy's avatar
Jim Blandy committed
236

237 238 239 240 241 242
;; This is the entry point to the decompiler, which is used by the
;; disassembler.  The disassembler just requires 'byte-compile, but
;; that doesn't define this function, so this seems to be a reasonable
;; thing to do.
(autoload 'byte-decompile-bytecode "byte-opt")

Richard M. Stallman's avatar
Richard M. Stallman committed
243
(defcustom byte-compile-verbose
Jim Blandy's avatar
Jim Blandy committed
244
  (and (not noninteractive) (> baud-rate search-slow-speed))
Richard M. Stallman's avatar
Richard M. Stallman committed
245 246 247
  "*Non-nil means print messages describing progress of byte-compiler."
  :group 'bytecomp
  :type 'boolean)
Jim Blandy's avatar
Jim Blandy committed
248

Richard M. Stallman's avatar
Richard M. Stallman committed
249
(defcustom byte-compile-compatibility nil
250 251 252
  "*Non-nil means generate output that can run in Emacs 18.
This only means that it can run in principle, if it doesn't require
facilities that have been added more recently."
Richard M. Stallman's avatar
Richard M. Stallman committed
253 254
  :group 'bytecomp
  :type 'boolean)
255 256 257 258

;; (defvar byte-compile-generate-emacs19-bytecodes
;;         (not (or (and (boundp 'epoch::version) epoch::version)
;; 		 (string-lessp emacs-version "19")))
Dave Love's avatar
Dave Love committed
259
;;   "*If this is true, then the byte-compiler will generate bytecode which
260 261
;; makes use of byte-ops which are present only in Emacs 19.  Code generated
;; this way can never be run in Emacs 18, and may even cause it to crash.")
Jim Blandy's avatar
Jim Blandy committed
262

Richard M. Stallman's avatar
Richard M. Stallman committed
263
(defcustom byte-optimize t
Richard M. Stallman's avatar
Richard M. Stallman committed
264 265 266 267
  "*Enables optimization in the byte compiler.
nil means don't do any optimization.
t means do all optimizations.
`source' means do source-level optimizations only.
Richard M. Stallman's avatar
Richard M. Stallman committed
268 269 270 271 272 273 274
`byte' means do code-level optimizations only."
  :group 'bytecomp
  :type '(choice (const :tag "none" nil)
		 (const :tag "all" t)
		 (const :tag "source-level" source)
		 (const :tag "byte-level" byte)))

275
(defcustom byte-compile-delete-errors nil
Richard M. Stallman's avatar
Richard M. Stallman committed
276
  "*If non-nil, the optimizer may delete forms that may signal an error.
Richard M. Stallman's avatar
Richard M. Stallman committed
277 278 279
This includes variable references and calls to functions such as `car'."
  :group 'bytecomp
  :type 'boolean)
Jim Blandy's avatar
Jim Blandy committed
280

281
(defvar byte-compile-dynamic nil
Richard M. Stallman's avatar
Richard M. Stallman committed
282
  "If non-nil, compile function bodies so they load lazily.
283 284
They are hidden in comments in the compiled file,
and each one is brought into core when the
285 286 287 288 289 290 291 292 293
function is called.

To enable this option, make it a file-local variable
in the source file you want it to apply to.
For example, add  -*-byte-compile-dynamic: t;-*- on the first line.

When this option is true, if you load the compiled file and then move it,
the functions you loaded will not be able to run.")

Richard M. Stallman's avatar
Richard M. Stallman committed
294
(defcustom byte-compile-dynamic-docstrings t
295 296 297 298 299 300 301 302
  "*If non-nil, compile doc strings for lazy access.
We bury the doc strings of functions and variables
inside comments in the file, and bring them into core only when they
are actually needed.

When this option is true, if you load the compiled file and then move it,
you won't be able to find the documentation of anything in that file.

303 304 305 306 307
To disable this option for a certain file, make it a file-local variable
in the source file.  For example, add this to the first line:
  -*-byte-compile-dynamic-docstrings:nil;-*-
You can also set the variable globally.

Richard M. Stallman's avatar
Richard M. Stallman committed
308 309 310
This option is enabled by default because it reduces Emacs memory usage."
  :group 'bytecomp
  :type 'boolean)
311

Richard M. Stallman's avatar
Richard M. Stallman committed
312
(defcustom byte-optimize-log nil
Jim Blandy's avatar
Jim Blandy committed
313 314
  "*If true, the byte-compiler will log its optimizations into *Compile-Log*.
If this is 'source, then only source-level optimizations will be logged.
Richard M. Stallman's avatar
Richard M. Stallman committed
315 316 317 318 319 320 321 322 323 324 325
If it is 'byte, then only byte-level optimizations will be logged."
  :group 'bytecomp
  :type '(choice (const :tag "none" nil)
		 (const :tag "all" t)
		 (const :tag "source-level" source)
		 (const :tag "byte-level" byte)))

(defcustom byte-compile-error-on-warn nil
  "*If true, the byte-compiler reports warnings with `error'."
  :group 'bytecomp
  :type 'boolean)
Jim Blandy's avatar
Jim Blandy committed
326

327
(defconst byte-compile-warning-types
328 329
  '(redefine callargs free-vars unresolved obsolete noruntime cl-functions)
  "The list of warning types used when `byte-compile-warnings' is t.")
Richard M. Stallman's avatar
Richard M. Stallman committed
330
(defcustom byte-compile-warnings t
Jim Blandy's avatar
Jim Blandy committed
331
  "*List of warnings that the byte-compiler should issue (t for all).
332

Jim Blandy's avatar
Jim Blandy committed
333 334 335 336 337 338 339
Elements of the list may be be:

  free-vars   references to variables not in the current lexical scope.
  unresolved  calls to unknown functions.
  callargs    lambda calls with args that don't match the definition.
  redefine    function cell redefined from a macro to a lambda or vice
              versa, or redefined to take a different number of arguments.
340 341 342
  obsolete    obsolete variables and functions.
  noruntime   functions that may not be defined at runtime (typically
              defined only under `eval-when-compile').
Juanma Barranquero's avatar
Juanma Barranquero committed
343
  cl-functions    calls to runtime functions from the CL package (as
344
		  distinguished from macros and aliases)."
Richard M. Stallman's avatar
Richard M. Stallman committed
345
  :group 'bytecomp
346
  :type `(choice (const :tag "All" t)
347 348
		 (set :menu-tag "Some"
		      (const free-vars) (const unresolved)
349 350
		      (const callargs) (const redefine)
		      (const obsolete) (const noruntime) (const cl-functions))))
Jim Blandy's avatar
Jim Blandy committed
351

352 353 354
(defvar byte-compile-not-obsolete-var nil
  "If non-nil, this is a variable that shouldn't be reported as obsolete.")

Richard M. Stallman's avatar
Richard M. Stallman committed
355
(defcustom byte-compile-generate-call-tree nil
356 357 358 359 360
  "*Non-nil means collect call-graph information when compiling.
This records functions were called and from where.
If the value is t, compilation displays the call graph when it finishes.
If the value is neither t nor nil, compilation asks you whether to display
the graph.
Jim Blandy's avatar
Jim Blandy committed
361 362 363 364 365 366

The call tree only lists functions called, not macros used. Those functions
which the byte-code interpreter knows about directly (eq, cons, etc.) are
not reported.

The call tree also lists those functions which are not known to be called
Karl Heuer's avatar
Karl Heuer committed
367
\(that is, to which no calls have been compiled).  Functions which can be
Richard M. Stallman's avatar
Richard M. Stallman committed
368 369 370
invoked interactively are excluded from this list."
  :group 'bytecomp
  :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
371
		 (other :tag "Ask" lambda)))
Jim Blandy's avatar
Jim Blandy committed
372

373
(defvar byte-compile-call-tree nil "Alist of functions and their call tree.
Jim Blandy's avatar
Jim Blandy committed
374 375 376 377 378 379 380 381
Each element looks like

  \(FUNCTION CALLERS CALLS\)

where CALLERS is a list of functions that call FUNCTION, and CALLS
is a list of functions for which calls were generated while compiling
FUNCTION.")

Richard M. Stallman's avatar
Richard M. Stallman committed
382
(defcustom byte-compile-call-tree-sort 'name
383 384
  "*If non-nil, sort the call tree.
The values `name', `callers', `calls', `calls+callers'
Richard M. Stallman's avatar
Richard M. Stallman committed
385 386 387 388
specify different fields to sort on."
  :group 'bytecomp
  :type '(choice (const name) (const callers) (const calls)
		 (const calls+callers) (const nil)))
389

390 391
(defvar byte-compile-debug nil)

392 393 394 395
;; (defvar byte-compile-overwrite-file t
;;   "If nil, old .elc files are deleted before the new is saved, and .elc
;; files will have the same modes as the corresponding .el file.  Otherwise,
;; existing .elc files will simply be overwritten, and the existing modes
Dave Love's avatar
Dave Love committed
396
;; will not be changed.  If this variable is nil, then an .elc file which
397 398
;; is a symbolic link will be turned into a normal file, instead of the file
;; which the link points to being overwritten.")
Jim Blandy's avatar
Jim Blandy committed
399 400

(defvar byte-compile-constants nil
401
  "List of all constants encountered during compilation of this form.")
Jim Blandy's avatar
Jim Blandy committed
402
(defvar byte-compile-variables nil
403
  "List of all variables encountered during compilation of this form.")
Jim Blandy's avatar
Jim Blandy committed
404
(defvar byte-compile-bound-variables nil
405 406
  "List of variables bound in the context of the current form.
This list lives partly on the stack.")
407 408
(defvar byte-compile-const-variables nil
  "List of variables declared as constants during compilation of this file.")
Jim Blandy's avatar
Jim Blandy committed
409 410 411
(defvar byte-compile-free-references)
(defvar byte-compile-free-assignments)

Richard M. Stallman's avatar
Richard M. Stallman committed
412 413
(defvar byte-compiler-error-flag)

Jim Blandy's avatar
Jim Blandy committed
414
(defconst byte-compile-initial-macro-environment
415 416 417
  '(
;;     (byte-compiler-options . (lambda (&rest forms)
;; 			       (apply 'byte-compiler-options-handler forms)))
Jim Blandy's avatar
Jim Blandy committed
418
    (eval-when-compile . (lambda (&rest body)
419 420 421
			   (list 'quote
				 (byte-compile-eval (byte-compile-top-level
						     (cons 'progn body))))))
Jim Blandy's avatar
Jim Blandy committed
422
    (eval-and-compile . (lambda (&rest body)
423
			  (byte-compile-eval-before-compile (cons 'progn body))
Jim Blandy's avatar
Jim Blandy committed
424 425 426 427 428 429
			  (cons 'progn body))))
  "The default macro-environment passed to macroexpand by the compiler.
Placing a macro here will cause a macro to have different semantics when
expanded by the compiler as when expanded by the interpreter.")

(defvar byte-compile-macro-environment byte-compile-initial-macro-environment
430 431
  "Alist of macros defined in the file being compiled.
Each element looks like (MACRONAME . DEFINITION).  It is
432
\(MACRONAME . nil) when a macro is redefined as a function.")
Jim Blandy's avatar
Jim Blandy committed
433 434

(defvar byte-compile-function-environment nil
435 436 437 438
  "Alist of functions defined in the file being compiled.
This is so we can inline them when necessary.
Each element looks like (FUNCTIONNAME . DEFINITION).  It is
\(FUNCTIONNAME . nil) when a function is redefined as a macro.")
Jim Blandy's avatar
Jim Blandy committed
439 440

(defvar byte-compile-unresolved-functions nil
441 442 443
  "Alist of undefined functions to which calls have been compiled.
Used for warnings when the function is not known to be defined or is later
defined with incorrect args.")
Jim Blandy's avatar
Jim Blandy committed
444

445 446 447 448 449
(defvar byte-compile-noruntime-functions nil
  "Alist of functions called that may not be defined when the compiled code is run.
Used for warnings about calling a function that is defined during compilation
but won't necessarily be defined when the compiled file is loaded.")

Jim Blandy's avatar
Jim Blandy committed
450 451 452 453 454 455 456 457 458 459
(defvar byte-compile-tag-number 0)
(defvar byte-compile-output nil
  "Alist describing contents to put in byte code string.
Each element is (INDEX . VALUE)")
(defvar byte-compile-depth 0 "Current depth of execution stack.")
(defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")


;;; The byte codes; this information is duplicated in bytecomp.c

460
(defvar byte-code-vector nil
Jim Blandy's avatar
Jim Blandy committed
461 462
  "An array containing byte-code names indexed by byte-code values.")

463
(defvar byte-stack+-info nil
Jim Blandy's avatar
Jim Blandy committed
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
  "An array with the stack adjustment for each byte-code.")

(defmacro byte-defop (opcode stack-adjust opname &optional docstring)
  ;; This is a speed-hack for building the byte-code-vector at compile-time.
  ;; We fill in the vector at macroexpand-time, and then after the last call
  ;; to byte-defop, we write the vector out as a constant instead of writing
  ;; out a bunch of calls to aset.
  ;; Actually, we don't fill in the vector itself, because that could make
  ;; it problematic to compile big changes to this compiler; we store the
  ;; values on its plist, and remove them later in -extrude.
  (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
		(put 'byte-code-vector 'tmp-compile-time-value
		     (make-vector 256 nil))))
	(v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
		(put 'byte-stack+-info 'tmp-compile-time-value
		     (make-vector 256 nil)))))
    (aset v1 opcode opname)
    (aset v2 opcode stack-adjust))
  (if docstring
      (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
      (list 'defconst opname opcode)))

(defmacro byte-extrude-byte-code-vectors ()
  (prog1 (list 'setq 'byte-code-vector
		     (get 'byte-code-vector 'tmp-compile-time-value)
		     'byte-stack+-info
		     (get 'byte-stack+-info 'tmp-compile-time-value))
491 492
    (put 'byte-code-vector 'tmp-compile-time-value nil)
    (put 'byte-stack+-info 'tmp-compile-time-value nil)))
Jim Blandy's avatar
Jim Blandy committed
493 494 495 496 497 498 499 500 501 502 503 504


;; unused: 0-7

;; These opcodes are special in that they pack their argument into the
;; opcode word.
;;
(byte-defop   8  1 byte-varref	"for variable reference")
(byte-defop  16 -1 byte-varset	"for setting a variable")
(byte-defop  24 -1 byte-varbind	"for binding a variable")
(byte-defop  32  0 byte-call	"for calling a function")
(byte-defop  40  0 byte-unbind	"for unbinding special bindings")
505
;; codes 8-47 are consumed by the preceding opcodes
Jim Blandy's avatar
Jim Blandy committed
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

;; unused: 48-55

(byte-defop  56 -1 byte-nth)
(byte-defop  57  0 byte-symbolp)
(byte-defop  58  0 byte-consp)
(byte-defop  59  0 byte-stringp)
(byte-defop  60  0 byte-listp)
(byte-defop  61 -1 byte-eq)
(byte-defop  62 -1 byte-memq)
(byte-defop  63  0 byte-not)
(byte-defop  64  0 byte-car)
(byte-defop  65  0 byte-cdr)
(byte-defop  66 -1 byte-cons)
(byte-defop  67  0 byte-list1)
(byte-defop  68 -1 byte-list2)
(byte-defop  69 -2 byte-list3)
(byte-defop  70 -3 byte-list4)
(byte-defop  71  0 byte-length)
(byte-defop  72 -1 byte-aref)
(byte-defop  73 -2 byte-aset)
(byte-defop  74  0 byte-symbol-value)
(byte-defop  75  0 byte-symbol-function) ; this was commented out
(byte-defop  76 -1 byte-set)
(byte-defop  77 -1 byte-fset) ; this was commented out
(byte-defop  78 -1 byte-get)
(byte-defop  79 -2 byte-substring)
(byte-defop  80 -1 byte-concat2)
(byte-defop  81 -2 byte-concat3)
(byte-defop  82 -3 byte-concat4)
(byte-defop  83  0 byte-sub1)
(byte-defop  84  0 byte-add1)
(byte-defop  85 -1 byte-eqlsign)
(byte-defop  86 -1 byte-gtr)
(byte-defop  87 -1 byte-lss)
(byte-defop  88 -1 byte-leq)
(byte-defop  89 -1 byte-geq)
(byte-defop  90 -1 byte-diff)
(byte-defop  91  0 byte-negate)
(byte-defop  92 -1 byte-plus)
(byte-defop  93 -1 byte-max)
(byte-defop  94 -1 byte-min)
(byte-defop  95 -1 byte-mult) ; v19 only
(byte-defop  96  1 byte-point)
(byte-defop  98  0 byte-goto-char)
(byte-defop  99  0 byte-insert)
(byte-defop 100  1 byte-point-max)
(byte-defop 101  1 byte-point-min)
(byte-defop 102  0 byte-char-after)
(byte-defop 103  1 byte-following-char)
(byte-defop 104  1 byte-preceding-char)
(byte-defop 105  1 byte-current-column)
(byte-defop 106  0 byte-indent-to)
(byte-defop 107  0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
(byte-defop 108  1 byte-eolp)
(byte-defop 109  1 byte-eobp)
(byte-defop 110  1 byte-bolp)
(byte-defop 111  1 byte-bobp)
(byte-defop 112  1 byte-current-buffer)
(byte-defop 113  0 byte-set-buffer)
566 567
(byte-defop 114  0 byte-save-current-buffer
  "To make a binding to record the current buffer")
Jim Blandy's avatar
Jim Blandy committed
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
(byte-defop 115  0 byte-set-mark-OBSOLETE)
(byte-defop 116  1 byte-interactive-p)

;; These ops are new to v19
(byte-defop 117  0 byte-forward-char)
(byte-defop 118  0 byte-forward-word)
(byte-defop 119 -1 byte-skip-chars-forward)
(byte-defop 120 -1 byte-skip-chars-backward)
(byte-defop 121  0 byte-forward-line)
(byte-defop 122  0 byte-char-syntax)
(byte-defop 123 -1 byte-buffer-substring)
(byte-defop 124 -1 byte-delete-region)
(byte-defop 125 -1 byte-narrow-to-region)
(byte-defop 126  1 byte-widen)
(byte-defop 127  0 byte-end-of-line)

;; unused: 128

;; These store their argument in the next two bytes
(byte-defop 129  1 byte-constant2
   "for reference to a constant with vector index >= byte-constant-limit")
(byte-defop 130  0 byte-goto "for unconditional jump")
(byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
(byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
(byte-defop 133 -1 byte-goto-if-nil-else-pop
Dave Love's avatar
Dave Love committed
593
  "to examine top-of-stack, jump and don't pop it if it's nil,
Jim Blandy's avatar
Jim Blandy committed
594 595
otherwise pop it")
(byte-defop 134 -1 byte-goto-if-not-nil-else-pop
Dave Love's avatar
Dave Love committed
596
  "to examine top-of-stack, jump and don't pop it if it's non nil,
Jim Blandy's avatar
Jim Blandy committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
otherwise pop it")

(byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
(byte-defop 136 -1 byte-discard "to discard one value from stack")
(byte-defop 137  1 byte-dup     "to duplicate the top of the stack")

(byte-defop 138  0 byte-save-excursion
  "to make a binding to record the buffer, point and mark")
(byte-defop 139  0 byte-save-window-excursion
  "to make a binding to record entire window configuration")
(byte-defop 140  0 byte-save-restriction
  "to make a binding to record the current buffer clipping restrictions")
(byte-defop 141 -1 byte-catch
  "for catch.  Takes, on stack, the tag and an expression for the body")
(byte-defop 142 -1 byte-unwind-protect
  "for unwind-protect.  Takes, on stack, an expression for the unwind-action")

Dave Love's avatar
Dave Love committed
614
;; For condition-case.  Takes, on stack, the variable to bind,
615 616
;; an expression for the body, and a list of clauses.
(byte-defop 143 -2 byte-condition-case)
Jim Blandy's avatar
Jim Blandy committed
617

618 619 620 621 622
;; For entry to with-output-to-temp-buffer.
;; Takes, on stack, the buffer name.
;; Binds standard-output and does some other things.
;; Returns with temp buffer on the stack in place of buffer name.
(byte-defop 144  0 byte-temp-output-buffer-setup)
Jim Blandy's avatar
Jim Blandy committed
623

624 625 626 627 628
;; For exit from with-output-to-temp-buffer.
;; Expects the temp buffer on the stack underneath value to return.
;; Pops them both, then pushes the value back on.
;; Unbinds standard-output and makes the temp buffer visible.
(byte-defop 145 -1 byte-temp-output-buffer-show)
Jim Blandy's avatar
Jim Blandy committed
629 630

;; these ops are new to v19
631 632

;; To unbind back to the beginning of this frame.
633
;; Not used yet, but will be needed for tail-recursion elimination.
634
(byte-defop 146  0 byte-unbind-all)
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659

;; these ops are new to v19
(byte-defop 147 -2 byte-set-marker)
(byte-defop 148  0 byte-match-beginning)
(byte-defop 149  0 byte-match-end)
(byte-defop 150  0 byte-upcase)
(byte-defop 151  0 byte-downcase)
(byte-defop 152 -1 byte-string=)
(byte-defop 153 -1 byte-string<)
(byte-defop 154 -1 byte-equal)
(byte-defop 155 -1 byte-nthcdr)
(byte-defop 156 -1 byte-elt)
(byte-defop 157 -1 byte-member)
(byte-defop 158 -1 byte-assq)
(byte-defop 159  0 byte-nreverse)
(byte-defop 160 -1 byte-setcar)
(byte-defop 161 -1 byte-setcdr)
(byte-defop 162  0 byte-car-safe)
(byte-defop 163  0 byte-cdr-safe)
(byte-defop 164 -1 byte-nconc)
(byte-defop 165 -1 byte-quo)
(byte-defop 166 -1 byte-rem)
(byte-defop 167  0 byte-numberp)
(byte-defop 168  0 byte-integerp)

Jim Blandy's avatar
Jim Blandy committed
660
;; unused: 169-174
Jim Blandy's avatar
Jim Blandy committed
661 662 663 664 665 666 667 668 669 670 671 672 673 674
(byte-defop 175 nil byte-listN)
(byte-defop 176 nil byte-concatN)
(byte-defop 177 nil byte-insertN)

;; unused: 178-191

(byte-defop 192  1 byte-constant	"for reference to a constant")
;; codes 193-255 are consumed by byte-constant.
(defconst byte-constant-limit 64
  "Exclusive maximum index usable in the `byte-constant' opcode.")

(defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
			  byte-goto-if-nil-else-pop
			  byte-goto-if-not-nil-else-pop)
675
  "List of byte-codes whose offset is a pc.")
Jim Blandy's avatar
Jim Blandy committed
676 677 678 679 680 681

(defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))

(byte-extrude-byte-code-vectors)

;;; lapcode generator
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
;;
;; the byte-compiler now does source -> lapcode -> bytecode instead of
;; source -> bytecode, because it's a lot easier to make optimizations
;; on lapcode than on bytecode.
;;
;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
;; where instruction is a symbol naming a byte-code instruction,
;; and parameter is an argument to that instruction, if any.
;;
;; The instruction can be the pseudo-op TAG, which means that this position
;; in the instruction stream is a target of a goto.  (car PARAMETER) will be
;; the PC for this location, and the whole instruction "(TAG pc)" will be the
;; parameter for some goto op.
;;
;; If the operation is varbind, varref, varset or push-constant, then the
;; parameter is (variable/constant . index_in_constant_vector).
;;
;; First, the source code is macroexpanded and optimized in various ways.
;; Then the resultant code is compiled into lapcode.  Another set of
;; optimizations are then run over the lapcode.  Then the variables and
;; constants referenced by the lapcode are collected and placed in the
;; constants-vector.  (This happens now so that variables referenced by dead
;; code don't consume space.)  And finally, the lapcode is transformed into
;; compacted byte-code.
;;
;; A distinction is made between variables and constants because the variable-
;; referencing instructions are more sensitive to the variables being near the
;; front of the constants-vector than the constant-referencing instructions.
;; Also, this lets us notice references to free variables.
Jim Blandy's avatar
Jim Blandy committed
711 712 713 714 715 716 717

(defun byte-compile-lapcode (lap)
  "Turns lapcode into bytecode.  The lapcode is destroyed."
  ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
  (let ((pc 0)			; Program counter
	op off			; Operation & offset
	(bytes '())		; Put the output bytes here
718
	(patchlist nil))	; List of tags and goto's to patch
Jim Blandy's avatar
Jim Blandy committed
719 720 721 722
    (while lap
      (setq op (car (car lap))
	    off (cdr (car lap)))
      (cond ((not (symbolp op))
723
	     (error "Non-symbolic opcode `%s'" op))
Jim Blandy's avatar
Jim Blandy committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
	    ((eq op 'TAG)
	     (setcar off pc)
	     (setq patchlist (cons off patchlist)))
	    ((memq op byte-goto-ops)
	     (setq pc (+ pc 3))
	     (setq bytes (cons (cons pc (cdr off))
			       (cons nil
				     (cons (symbol-value op) bytes))))
	     (setq patchlist (cons bytes patchlist)))
	    (t
	     (setq bytes
		   (cond ((cond ((consp off)
				 ;; Variable or constant reference
				 (setq off (cdr off))
				 (eq op 'byte-constant)))
			  (cond ((< off byte-constant-limit)
				 (setq pc (1+ pc))
				 (cons (+ byte-constant off) bytes))
				(t
				 (setq pc (+ 3 pc))
				 (cons (lsh off -8)
				       (cons (logand off 255)
					     (cons byte-constant2 bytes))))))
			 ((<= byte-listN (symbol-value op))
			  (setq pc (+ 2 pc))
			  (cons off (cons (symbol-value op) bytes)))
			 ((< off 6)
			  (setq pc (1+ pc))
			  (cons (+ (symbol-value op) off) bytes))
			 ((< off 256)
			  (setq pc (+ 2 pc))
			  (cons off (cons (+ (symbol-value op) 6) bytes)))
			 (t
			  (setq pc (+ 3 pc))
			  (cons (lsh off -8)
				(cons (logand off 255)
				      (cons (+ (symbol-value op) 7)
					    bytes))))))))
      (setq lap (cdr lap)))
    ;;(if (not (= pc (length bytes)))
764
    ;;    (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
Jim Blandy's avatar
Jim Blandy committed
765 766 767 768 769 770 771 772 773 774 775 776
    ;; Patch PC into jumps
    (let (bytes)
      (while patchlist
	(setq bytes (car patchlist))
	(cond ((atom (car bytes)))	; Tag
	      (t			; Absolute jump
	       (setq pc (car (cdr (car bytes))))	; Pick PC from tag
	       (setcar (cdr bytes) (logand pc 255))
	       (setcar bytes (lsh pc -8))))
	(setq patchlist (cdr patchlist))))
    (concat (nreverse bytes))))

777 778 779

;;; compile-time evaluation

780 781
(defun byte-compile-eval (form)
  "Eval FORM and mark the functions defined therein.
782
Each function's symbol gets added to `byte-compile-noruntime-functions'."
783 784
  (let ((hist-orig load-history)
	(hist-nil-orig current-load-list))
785 786
    (prog1 (eval form)
      (when (memq 'noruntime byte-compile-warnings)
787 788
	(let ((hist-new load-history)
	      (hist-nil-new current-load-list))
789 790 791
	  ;; Go through load-history, look for newly loaded files
	  ;; and mark all the functions defined therein.
	  (while (and hist-new (not (eq hist-new hist-orig)))
792 793
	    (let ((xs (pop hist-new))
		  old-autoloads)
794 795 796 797
	      ;; Make sure the file was not already loaded before.
	      (unless (assoc (car xs) hist-orig)
		(dolist (s xs)
		  (cond
798 799
		   ((symbolp s)
		    (unless (memq s old-autoloads)
800
		      (push s byte-compile-noruntime-functions)))
801
		   ((and (consp s) (eq t (car s)))
802
		    (push (cdr s) old-autoloads))
803
		   ((and (consp s) (eq 'autoload (car s)))
804
		    (push (cdr s) byte-compile-noruntime-functions)))))))
805
	  ;; Go through current-load-list for the locally defined funs.
806 807 808 809
	  (let (old-autoloads)
	    (while (and hist-nil-new (not (eq hist-nil-new hist-nil-orig)))
	      (let ((s (pop hist-nil-new)))
		(when (and (symbolp s) (not (memq s old-autoloads)))
810
		  (push s byte-compile-noruntime-functions))
811
		(when (and (consp s) (eq t (car s)))
812
		  (push (cdr s) old-autoloads))))))))))
813

814 815 816 817 818 819 820 821 822 823 824
(defun byte-compile-eval-before-compile (form)
  "Evaluate FORM for `eval-and-compile'."
  (let ((hist-nil-orig current-load-list))
    (prog1 (eval form)
      ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
      (let ((tem current-load-list))
	(while (not (eq tem hist-nil-orig))
	  (when (equal (car tem) '(require . cl))
	    (setq byte-compile-warnings
		  (remq 'cl-functions byte-compile-warnings)))
	  (setq tem (cdr tem)))))))
Jim Blandy's avatar
Jim Blandy committed
825 826 827

;;; byte compiler messages

828 829
(defvar byte-compile-current-form nil)
(defvar byte-compile-dest-file nil)
830
(defvar byte-compile-current-file nil)
831
(defvar byte-compile-current-buffer nil)
832

Richard M. Stallman's avatar
Richard M. Stallman committed
833
;; Log something that isn't a warning.
Jim Blandy's avatar
Jim Blandy committed
834 835 836 837 838 839 840 841 842 843 844
(defmacro byte-compile-log (format-string &rest args)
  (list 'and
	'byte-optimize
	'(memq byte-optimize-log '(t source))
	(list 'let '((print-escape-newlines t)
		     (print-level 4)
		     (print-length 4))
	      (list 'byte-compile-log-1
		    (cons 'format
		      (cons format-string
			(mapcar
845 846
			 (lambda (x)
			   (if (symbolp x) (list 'prin1-to-string x) x))
Jim Blandy's avatar
Jim Blandy committed
847 848
			 args)))))))

Richard M. Stallman's avatar
Richard M. Stallman committed
849 850 851 852 853 854 855 856 857 858
;; Log something that isn't a warning.
(defun byte-compile-log-1 (string)
  (save-excursion
    (byte-goto-log-buffer)
    (goto-char (point-max))
    (byte-compile-warning-prefix nil nil)
    (cond (noninteractive
	   (message " %s" string))
	  (t
	   (insert (format "%s\n" string))))))
Jim Blandy's avatar
Jim Blandy committed
859

860 861 862 863 864 865
(defvar byte-compile-read-position nil
  "Character position we began the last `read' from.")
(defvar byte-compile-last-position nil
  "Last known character position in the input.")

;; copied from gnus-util.el
866
(defsubst byte-compile-delete-first (elt list)
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
  (if (eq (car list) elt)
      (cdr list)
    (let ((total list))
      (while (and (cdr list)
		  (not (eq (cadr list) elt)))
	(setq list (cdr list)))
      (when (cdr list)
	(setcdr list (cddr list)))
      total)))

;; The purpose of this function is to iterate through the
;; `read-symbol-positions-list'.  Each time we process, say, a
;; function definition (`defun') we remove `defun' from
;; `read-symbol-positions-list', and set `byte-compile-last-position'
;; to that symbol's character position.  Similarly, if we encounter a
;; variable reference, like in (1+ foo), we remove `foo' from the
;; list.  If our current position is after the symbol's position, we
;; assume we've already passed that point, and look for the next
Juanma Barranquero's avatar
Juanma Barranquero committed
885 886
;; occurrence of the symbol.
;; So your're probably asking yourself: Isn't this function a
887 888 889
;; gross hack?  And the answer, of course, would be yes.
(defun byte-compile-set-symbol-position (sym &optional allow-previous)
  (when byte-compile-read-position
890
    (let (last entry)
891
      (while (progn
892 893 894 895 896 897 898 899
           (setq last byte-compile-last-position
             entry (assq sym read-symbol-positions-list))
           (when entry
           (setq byte-compile-last-position
             (+ byte-compile-read-position (cdr entry))
             read-symbol-positions-list
             (byte-compile-delete-first
              entry read-symbol-positions-list)))
900 901
	       (or (and allow-previous (not (= last byte-compile-last-position)))
		   (> last byte-compile-last-position)))))))
902

Richard M. Stallman's avatar
Richard M. Stallman committed
903 904 905
(defvar byte-compile-last-warned-form nil)
(defvar byte-compile-last-logged-file nil)

906 907 908 909
(defun byte-goto-log-buffer ()
  (set-buffer (get-buffer-create "*Compile-Log*"))
  (unless (eq major-mode 'compilation-mode)
    (compilation-mode)))
910

Richard M. Stallman's avatar
Richard M. Stallman committed
911
;; This is used as warning-prefix for the compiler.
912
;; It is always called with the warnings buffer current.
Richard M. Stallman's avatar
Richard M. Stallman committed
913
(defun byte-compile-warning-prefix (level entry)
914 915 916
  (let* ((dir default-directory)
	 (file (cond ((stringp byte-compile-current-file)
		      (format "%s:" (file-relative-name byte-compile-current-file dir)))
917
		     ((bufferp byte-compile-current-file)
918
		      (format "Buffer %s:"
919 920
			      (buffer-name byte-compile-current-file)))
		     (t "")))
921
	 (pos (if (and byte-compile-current-file
922 923 924 925 926 927 928
		       (integerp byte-compile-read-position))
		  (with-current-buffer byte-compile-current-buffer
		    (format "%d:%d:" (count-lines (point-min)
						  byte-compile-last-position)
			    (save-excursion
			      (goto-char byte-compile-last-position)
			      (1+ (current-column)))))
929
		""))
930 931 932 933 934
	 (form (if (eq byte-compile-current-form :end) "end of data"
		 (or byte-compile-current-form "toplevel form"))))
    (when (or (and byte-compile-current-file
		   (not (equal byte-compile-current-file
			       byte-compile-last-logged-file)))
935
	      (and byte-compile-current-form
936 937
		   (not (eq byte-compile-current-form
			    byte-compile-last-warned-form))))
Richard M. Stallman's avatar
Richard M. Stallman committed
938
      (insert (format "\nIn %s:\n" form)))
939 940
    (when level
      (insert (format "%s%s" file pos))))
941
  (setq byte-compile-last-logged-file byte-compile-current-file
Richard M. Stallman's avatar
Richard M. Stallman committed
942 943
	byte-compile-last-warned-form byte-compile-current-form)
  entry)
Jim Blandy's avatar
Jim Blandy committed
944

945 946 947 948 949 950
;; This no-op function is used as the value of warning-series
;; to tell inner calls to displaying-byte-compile-warnings
;; not to bind warning-series.
(defun byte-compile-warning-series (&rest ignore)
  nil)

951
;; Log the start of a file in *Compile-Log*, and mark it as done.
Richard M. Stallman's avatar
Richard M. Stallman committed
952
;; Return the position of the start of the page in the log buffer.
953 954
;; But do nothing in batch mode.
(defun byte-compile-log-file ()
955
  (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
956
       (not noninteractive)
957
       (save-excursion
958
	 (set-buffer (get-buffer-create "*Compile-Log*"))
959
	 (goto-char (point-max))
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
	 (let* ((dir (and byte-compile-current-file
			  (file-name-directory byte-compile-current-file)))
		(was-same (equal default-directory dir))
		pt)
	   (when dir
	     (unless was-same
	       (insert (format "Leaving directory `%s'\n" default-directory))))
	   (unless (bolp)
	     (insert "\n"))
	   (setq pt (point-marker))
	   (if byte-compile-current-file
	       (insert "\f\nCompiling "
		       (if (stringp byte-compile-current-file)
			   (concat "file " byte-compile-current-file)
			 (concat "buffer " (buffer-name byte-compile-current-file)))
		       " at " (current-time-string) "\n")
	     (insert "\f\nCompiling no file at " (current-time-string) "\n"))
	   (when dir
	     (setq default-directory dir)
	     (unless was-same
	       (insert (format "Entering directory `%s'\n" default-directory))))
981 982
	   (setq byte-compile-last-logged-file byte-compile-current-file
		 byte-compile-last-warned-form nil)
983 984 985
	   ;; Do this after setting default-directory.
	   (unless (eq major-mode 'compilation-mode)
	     (compilation-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
986 987 988 989 990 991
	   pt))))

;; Log a message STRING in *Compile-Log*.
;; Also log the current function and file if not already done.
(defun byte-compile-log-warning (string &optional fill level)
  (let ((warning-prefix-function 'byte-compile-warning-prefix)
992
	(warning-type-format "")
Richard M. Stallman's avatar
Richard M. Stallman committed
993 994
	(warning-fill-prefix (if fill "    ")))
    (display-warning 'bytecomp string level "*Compile-Log*")))
995

Jim Blandy's avatar
Jim Blandy committed
996
(defun byte-compile-warn (format &rest args)
Richard M. Stallman's avatar
Richard M. Stallman committed
997
  "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
Jim Blandy's avatar
Jim Blandy committed
998 999 1000
  (setq format (apply 'format format args))
  (if byte-compile-error-on-warn
      (error "%s" format)		; byte-compile-file catches and logs it
Richard M. Stallman's avatar
Richard M. Stallman committed
1001 1002
    (byte-compile-log-warning format t :warning)))

Jim Blandy's avatar
Jim Blandy committed
1003
(defun byte-compile-report-error (error-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
1004
  "Report Lisp error in compilation.  ERROR-INFO is the error data."
Richard M. Stallman's avatar
Richard M. Stallman committed
1005
  (setq byte-compiler-error-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
1006 1007 1008
  (byte-compile-log-warning
   (error-message-string error-info)
   nil :error))
Jim Blandy's avatar
Jim Blandy committed
1009

Jim Blandy's avatar
Jim Blandy committed
1010 1011
;;; Used by make-obsolete.
(defun byte-compile-obsolete (form)
1012 1013 1014
  (let* ((new (get (car form) 'byte-obsolete-info))
	 (handler (nth 1 new))
	 (when (nth 2 new)))
1015
    (byte-compile-set-symbol-position (car form))
1016
    (if (memq 'obsolete byte-compile-warnings)
1017 1018
	(byte-compile-warn "%s is an obsolete function%s; %s" (car form)
			   (if when (concat " since " when) "")
1019 1020
			   (if (stringp (car new))
			       (car new)
1021 1022
			     (format "use %s instead." (car new)))))
    (funcall (or handler 'byte-compile-normal-call) form)))
Jim Blandy's avatar
Jim Blandy committed
1023 1024 1025

;; Compiler options

1026 1027 1028 1029 1030 1031 1032 1033 1034
;; (defvar byte-compiler-valid-options
;;   '((optimize byte-optimize (t nil source byte) val)
;;     (file-format byte-compile-compatibility (emacs18 emacs19)
;; 		 (eq val 'emacs18))
;; ;;     (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
;;     (delete-errors byte-compile-delete-errors (t nil) val)
;;     (verbose byte-compile-verbose (t nil) val)
;;     (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
;; 	      val)))
Jim Blandy's avatar
Jim Blandy committed
1035 1036

;; Inhibit v18/v19 selectors if the version is hardcoded.
Dave Love's avatar
Dave Love committed
1037
;; #### This should print a warning if the user tries to change something
Jim Blandy's avatar
Jim Blandy committed
1038
;; than can't be changed because the running compiler doesn't support it.
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
;; (cond
;;  ((byte-compile-single-version)
;;   (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
;; 	  (list (byte-compile-version-cond
;; 		 byte-compile-generate-emacs19-bytecodes)))
;;   (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
;; 	  (if (byte-compile-version-cond byte-compile-compatibility)
;; 	      '(emacs18) '(emacs19)))))

;; (defun byte-compiler-options-handler (&rest args)
;;   (let (key val desc choices)
;;     (while args
;;       (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
;; 	  (error "Malformed byte-compiler option `%s'" (car args)))
;;       (setq key (car (car args))
;; 	    val (car (cdr (car args)))
;; 	    desc (assq key byte-compiler-valid-options))
;;       (or desc
;; 	  (error "Unknown byte-compiler option `%s'" key))
;;       (setq choices (nth 2 desc))
;;       (if (consp (car choices))
;; 	  (let (this
;; 		(handler 'cons)
;; 		(ret (and (memq (car val) '(+ -))
;; 			  (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
;; 					     choices
;; 					   (symbol-value (nth 1 desc)))))))
;; 	    (setq choices (car  choices))
;; 	    (while val
;; 	      (setq this (car val))
;; 	      (cond ((memq this choices)
;; 		     (setq ret (funcall handler this ret)))
;; 		    ((eq this '+) (setq handler 'cons))
;; 		    ((eq this '-) (setq handler 'delq))
;; 		    ((error "`%s' only accepts %s" key choices)))
;; 	      (setq val (cdr val)))
;; 	    (set (nth 1 desc) ret))
;; 	(or (memq val choices)
;; 	    (error "`%s' must be one of `%s'" key choices))
;; 	(set (nth 1 desc) (eval (nth 3 desc))))
;;       (setq args (cdr args)))
;;     nil))
Jim Blandy's avatar
Jim Blandy committed
1081 1082 1083 1084 1085 1086

;;; sanity-checking arglists

(defun byte-compile-fdefinition (name macro-p)
  (let* ((list (if macro-p
		   byte-compile-macro-environment
1087
		 byte-compile-function-environment))
Jim Blandy's avatar
Jim Blandy committed
1088 1089 1090 1091 1092 1093 1094 1095
	 (env (cdr (assq name list))))
    (or env
	(let ((fn name))
	  (while (and (symbolp fn)
		      (fboundp fn)
		      (or (symbolp (symbol-function fn))
			  (consp (symbol-function fn))
			  (and (not macro-p)
1096
			       (byte-code-function-p (symbol-function fn)))))
Jim Blandy's avatar
Jim Blandy committed
1097
	    (setq fn (symbol-function fn)))
1098
	  (if (and (not macro-p) (byte-code-function-p fn))
Jim Blandy's avatar
Jim Blandy committed
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
	      fn
	    (and (consp fn)
		 (if (eq 'macro (car fn))
		     (cdr fn)
		   (if macro-p
		       nil
		     (if (eq 'autoload (car fn))
			 nil
		       fn)))))))))

(defun byte-compile-arglist-signature (arglist)
  (let ((args 0)
	opts
	restp)
    (while arglist
      (cond ((eq (car arglist) '&optional)
	     (or opts (setq opts 0)))
	    ((eq (car arglist) '&rest)
	     (if (cdr arglist)
		 (setq restp t
		       arglist nil)))
	    (t
	     (if opts
		 (setq opts (1+ opts))
		 (setq args (1+ args)))))
      (setq arglist (cdr arglist)))
    (cons args (if restp nil (if opts (+ args opts) args)))))


(defun byte-compile-arglist-signatures-congruent-p (old new)
  (not (or
	 (> (car new) (car old))  ; requires more args now
Karl Heuer's avatar
Karl Heuer committed
1131
	 (and (null (cdr old))    ; took rest-args, doesn't any more
Jim Blandy's avatar
Jim Blandy committed
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
	      (cdr new))
	 (and (cdr new) (cdr old) ; can't take as many args now
	      (< (cdr new) (cdr old)))
	 )))

(defun byte-compile-arglist-signature-string (signature)
  (cond ((null (cdr signature))
	 (format "%d+" (car signature)))
	((= (car signature) (cdr signature))
	 (format "%d" (car signature)))
	(t (format "%d-%d" (car signature) (cdr signature)))))


1145
;; Warn if the form is calling a function with the wrong number of arguments.
Jim Blandy's avatar
Jim Blandy committed
1146 1147 1148
(defun byte-compile-callargs-warn (form)
  (let* ((def (or (byte-compile-fdefinition (car form) nil)
		  (byte-compile-fdefinition (car form) t)))
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
	 (sig (if def
		  (byte-compile-arglist-signature
		   (if (eq 'lambda (car-safe def))
		       (nth 1 def)
		     (if (byte-code-function-p def)
			 (aref def 0)
		       '(&rest def))))
		(if (and (fboundp (car form))
			 (subrp (symbol-function (car form))))
		    (subr-arity (symbol-function (car form))))))
Jim Blandy's avatar
Jim Blandy committed
1159
	 (ncall (length (cdr form))))
1160 1161 1162 1163
    ;; Check many or unevalled from subr-arity.
    (if (and (cdr-safe sig)
	     (not (numberp (cdr sig))))
	(setcdr sig nil))
Jim Blandy's avatar
Jim Blandy committed
1164
    (if sig
1165
	(when (or (< ncall (car sig))
Jim Blandy's avatar
Jim Blandy committed
1166
		(and (cdr sig) (> ncall (cdr sig))))
1167 1168 1169 1170 1171 1172 1173 1174
	  (byte-compile-set-symbol-position (car form))
	  (byte-compile-warn
	   "%s called with %d argument%s, but %s %s"
	   (car form) ncall
	   (if (= 1 ncall) "" "s")
	   (if (< ncall (car sig))
	       "requires"
	     "accepts only")
Stefan Monnier's avatar
Stefan Monnier committed
1175
	   (byte-compile-arglist-signature-string sig))))
1176
    (byte-compile-format-warn form)
Stefan Monnier's avatar
Stefan Monnier committed
1177 1178 1179
    ;; Check to see if the function will be available at runtime
    ;; and/or remember its arity if it's unknown.
    (or (and (or sig (fboundp (car form))) ; might be a subr or autoload.
1180
	     (not (memq (car form) byte-compile-noruntime-functions)))
Stefan Monnier's avatar
Stefan Monnier committed
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
	(eq (car form) byte-compile-current-form) ; ## this doesn't work
					; with recursion.
	;; It's a currently-undefined function.
	;; Remember number of args in call.
	(let ((cons (assq (car form) byte-compile-unresolved-functions))
	      (n (length (cdr form))))
	  (if cons
	      (or (memq n (cdr cons))
		  (setcdr cons (cons n (cdr cons))))
	    (setq byte-compile-unresolved-functions
		  (cons (list (car form) n)
			byte-compile-unresolved-functions)))))))
Jim Blandy's avatar
Jim Blandy committed
1193

1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
(defun byte-compile-format-warn (form)
  "Warn if FORM is `format'-like with inconsistent args.
Applies if head of FORM is a symbol with non-nil property
`byte-compile-format-like' and first arg is a constant string.
Then check the number of format fields matches the number of
extra args."
  (when (and (symbolp (car form))
	     (stringp (nth 1 form))
	     (get (car form) 'byte-compile-format-like))
    (let ((nfields (with-temp-buffer
		     (insert (nth 1 form))
		     (goto-char 1)
		     (let ((n 0))
		       (while (re-search-forward "%." nil t)
			 (unless (eq ?% (char-after (1+ (match-beginning 0))))
			   (setq n (1+ n))))
		       n)))
	  (nargs (- (length form) 2)))
      (unless (= nargs nfields)
	(byte-compile-warn
	 "`%s' called with %d args to fill %d format field(s)" (car form)
	 nargs nfields)))))

(dolist (elt '(format message error))
  (put elt 'byte-compile-format-like t))

1220 1221
;; Warn if the function or macro is being redefined with a different
;; number of arguments.
Jim Blandy's avatar
Jim Blandy committed
1222 1223 1224 1225 1226 1227
(defun byte-compile-arglist-warn (form macrop)
  (let ((old (byte-compile-fdefinition (nth 1 form) macrop)))
    (if old
	(let ((sig1 (byte-compile-arglist-signature
		      (if (eq 'lambda (car-safe old))
			  (nth 1 old)
1228
			(if (byte-code-function-p old)
1229 1230
			    (aref old 0)
			  '(&rest def)))))
Jim Blandy's avatar
Jim Blandy committed
1231
	      (sig2 (byte-compile-arglist-signature (nth 2 form))))
1232 1233 1234 1235 1236 1237 1238 1239 1240
	  (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
	    (byte-compile-set-symbol-position (nth 1 form))
	    (byte-compile-warn
	     "%s %s used to take %s %s, now takes %s"
	     (if (eq (car form) 'defun) "function" "macro")
	     (nth 1 form)
	     (byte-compile-arglist-signature-string sig1)
	     (if (equal sig1 '(1 . 1)) "argument" "arguments")
	     (byte-compile-arglist-signature-string sig2))))
Jim Blandy's avatar
Jim Blandy committed
1241 1242 1243 1244 1245 1246 1247 1248 1249
      ;; This is the first definition.  See if previous calls are compatible.
      (let ((calls (assq (nth 1 form) byte-compile-unresolved-functions))
	    nums sig min max)
	(if calls
	    (progn
	      (setq sig (byte-compile-arglist-signature (nth 2 form))
		    nums (sort (copy-sequence (cdr calls)) (function <))
		    min (car nums)
		    max (car (nreverse nums)))
1250
	      (when (or (< min (car sig))
Jim Blandy's avatar
Jim Blandy committed
1251
		      (and (cdr sig) (> max (cdr sig))))
1252 1253 1254 1255 1256 1257 1258
		(byte-compile-set-symbol-position (nth 1 form))
		(byte-compile-warn
		 "%s being defined to take %s%s, but was previously called with %s"
		 (nth 1 form)
		 (byte-compile-arglist-signature-string sig)
		 (if (equal sig '(1 . 1)) " arg" " args")
		 (byte-compile-arglist-signature-string (cons min max))))
1259

Jim Blandy's avatar
Jim Blandy committed
1260 1261 1262 1263
	      (setq byte-compile-unresolved-functions
		    (delq calls byte-compile-unresolved-functions)))))
      )))

1264 1265 1266 1267 1268 1269
(defvar byte-compile-cl-functions nil
  "List of functions defined in CL.")

(defun byte-compile-find-cl-functions ()
  (unless byte-compile-cl-functions
    (dolist (elt load-history)
1270 1271
      (when (and (stringp (car elt))
		 (string-match "^cl\\>" (car elt)))
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
	(setq byte-compile-cl-functions
	      (append byte-compile-cl-functions
		      (cdr elt)))))
    (let ((tail byte-compile-cl-functions))
      (while tail
	(if (and (consp (car tail))
		 (eq (car (car tail)) 'autoload))
	    (setcar tail (cdr (car tail))))
	(setq tail (cdr tail))))))

1282 1283
(defun byte-compile-cl-warn (form)
  "Warn if FORM is a call of a function from the CL package."
1284 1285 1286
  (let ((func (car-safe form)))
    (if (and byte-compile-cl-functions
	     (memq func byte-compile-cl-functions)
1287
	     ;; Aliases which won't have been expanded at this point.
1288 1289 1290
	     ;; These aren't all aliases of subrs, so not trivial to
	     ;; avoid hardwiring the list.
	     (not (memq func
1291 1292
			'(cl-block-wrapper cl-block-throw
			  multiple-value-call nth-value
1293
			  copy-seq first second rest endp cl-member
1294 1295 1296 1297
			  ;; These are included in generated code
			  ;; that can't be called except at compile time
			  ;; or unless cl is loaded anyway.
			  cl-defsubst-expand cl-struct-setf-expander
Richard M. Stallman's avatar