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

Stefan Monnier's avatar
Stefan Monnier committed
3
;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1998, 2000, 2001, 2002,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2003, 2004, 2005, 2006, 2007, 2008, 2009 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

;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
17 18 19 20 21 22 23

;; 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
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Jim Blandy's avatar
Jim Blandy committed
25

26 27 28
;;; Commentary:

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

33 34
;;; Code:

Erik Naggum's avatar
Erik Naggum committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
;; ========================================================================
;; 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
61
;;    - functions being called which are not defined globally, in the
Erik Naggum's avatar
Erik Naggum committed
62 63 64 65 66 67 68 69 70 71
;;      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
Kenichi Handa's avatar
Kenichi Handa committed
72
;;				compiled in the echo area;
Dave Love's avatar
Dave Love committed
73
;; byte-optimize		Whether to do optimizations; this may be
Erik Naggum's avatar
Erik Naggum committed
74
;;				t, nil, 'source, or 'byte;
Dave Love's avatar
Dave Love committed
75
;; byte-optimize-log		Whether to report (in excruciating detail)
Erik Naggum's avatar
Erik Naggum committed
76 77 78 79 80 81 82 83
;;				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
84
;;				function calls.  This can be useful for
Erik Naggum's avatar
Erik Naggum committed
85 86 87
;;				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
88 89 90 91 92 93 94 95 96 97 98
;;				`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')
99
;;				`cl-functions' (calls to CL functions)
100 101
;;				`interactive-only' (calls to commands that are
;;						   not good to call from Lisp)
102 103
;;				`make-local' (dubious calls to
;;					      `make-variable-buffer-local')
Glenn Morris's avatar
Glenn Morris committed
104
;;                              `mapcar'     (mapcar called for effect)
Erik Naggum's avatar
Erik Naggum committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
;; 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
128
;;		(inline			;;  `foo' and `baz' will be
Erik Naggum's avatar
Erik Naggum committed
129 130 131 132
;;		 (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
Kenichi Handa's avatar
Kenichi Handa committed
133
;;	in without having to load that file before compiling it.  The
Erik Naggum's avatar
Erik Naggum committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
;;	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
151
;;  o  If you run byte-compile-file on a filename which is visited in a
Erik Naggum's avatar
Erik Naggum committed
152 153 154 155 156
;;     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
157

158
(require 'backquote)
159
(eval-when-compile (require 'cl))
160

Jim Blandy's avatar
Jim Blandy committed
161 162
(or (fboundp 'defsubst)
    ;; This really ought to be loaded already!
163
    (load "byte-run"))
Jim Blandy's avatar
Jim Blandy committed
164

165 166
;; The feature of compiling in a specific target Emacs version
;; has been turned off because compile time options are a bad idea.
167 168
(defmacro byte-compile-single-version () nil)
(defmacro byte-compile-version-cond (cond) cond)
Jim Blandy's avatar
Jim Blandy committed
169

170 171 172 173 174
;; 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
175

176 177 178 179 180 181
;; (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
182
;;
183
;;       (if (byte-compile-single-version)
184 185
;; 	  (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))
186
;;
187 188 189 190 191 192 193 194 195 196
;;       (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
197
(defgroup bytecomp nil
198
  "Emacs Lisp byte-compiler."
Richard M. Stallman's avatar
Richard M. Stallman committed
199 200
  :group 'lisp)

201
(defcustom emacs-lisp-file-regexp "\\.el\\'"
202
  "Regexp which matches Emacs Lisp source files.
203
If you change this, you might want to set `byte-compile-dest-file-function'."
Richard M. Stallman's avatar
Richard M. Stallman committed
204 205
  :group 'bytecomp
  :type 'regexp)
Jim Blandy's avatar
Jim Blandy committed
206

207 208 209 210 211 212 213 214
(defcustom byte-compile-dest-file-function nil
  "Function for the function `byte-compile-dest-file' to call.
It should take one argument, the name of an Emacs Lisp source
file name, and return the name of the compiled file."
  :group 'bytecomp
  :type '(choice (const nil) function)
  :version "23.2")

215 216 217 218 219 220 221 222 223 224
;; 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
225
(or (fboundp 'byte-compile-dest-file)
226
    ;; The user may want to redefine this along with emacs-lisp-file-regexp,
Jim Blandy's avatar
Jim Blandy committed
227
    ;; so only define it if it is undefined.
228 229
    ;; Note - redefining this function is obsolete as of 23.2.
    ;; Customize byte-compile-dest-file-function instead.
Jim Blandy's avatar
Jim Blandy committed
230
    (defun byte-compile-dest-file (filename)
231
      "Convert an Emacs Lisp source file name to a compiled file name.
232 233 234 235 236 237 238 239 240 241 242
If `byte-compile-dest-file-function' is non-nil, uses that
function to do the work.  Otherwise, if FILENAME matches
`emacs-lisp-file-regexp' (by default, files with the extension `.el'),
adds `c' to it; otherwise adds `.elc'."
      (if byte-compile-dest-file-function
	  (funcall byte-compile-dest-file-function filename)
	(setq filename (file-name-sans-versions
			(byte-compiler-base-file-name filename)))
	(cond ((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
243 244

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

;; This is the entrypoint to the lapcode optimizer pass1.
248
(autoload 'byte-optimize-form "byte-opt")
Jim Blandy's avatar
Jim Blandy committed
249
;; This is the entrypoint to the lapcode optimizer pass2.
250 251
(autoload 'byte-optimize-lapcode "byte-opt")
(autoload 'byte-compile-unfold-lambda "byte-opt")
Jim Blandy's avatar
Jim Blandy committed
252

253 254 255 256 257 258
;; 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
259
(defcustom byte-compile-verbose
Jim Blandy's avatar
Jim Blandy committed
260
  (and (not noninteractive) (> baud-rate search-slow-speed))
261
  "Non-nil means print messages describing progress of byte-compiler."
Richard M. Stallman's avatar
Richard M. Stallman committed
262 263
  :group 'bytecomp
  :type 'boolean)
Jim Blandy's avatar
Jim Blandy committed
264

Richard M. Stallman's avatar
Richard M. Stallman committed
265
(defcustom byte-compile-compatibility nil
266
  "Non-nil means generate output that can run in Emacs 18.
Kenichi Handa's avatar
Kenichi Handa committed
267 268
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
269 270
  :group 'bytecomp
  :type 'boolean)
271 272 273 274

;; (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
275
;;   "*If this is true, then the byte-compiler will generate bytecode which
276 277
;; 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
278

Richard M. Stallman's avatar
Richard M. Stallman committed
279
(defcustom byte-optimize t
280
  "Enable optimization in the byte compiler.
281 282 283 284 285
Possible values are:
  nil      - no optimization
  t        - all optimizations
  `source' - source-level optimizations only
  `byte'   - code-level optimizations only"
Richard M. Stallman's avatar
Richard M. Stallman committed
286 287 288 289 290 291
  :group 'bytecomp
  :type '(choice (const :tag "none" nil)
		 (const :tag "all" t)
		 (const :tag "source-level" source)
		 (const :tag "byte-level" byte)))

292
(defcustom byte-compile-delete-errors nil
293
  "If non-nil, the optimizer may delete forms that may signal an error.
Richard M. Stallman's avatar
Richard M. Stallman committed
294 295 296
This includes variable references and calls to functions such as `car'."
  :group 'bytecomp
  :type 'boolean)
Jim Blandy's avatar
Jim Blandy committed
297

298
(defvar byte-compile-dynamic nil
Richard M. Stallman's avatar
Richard M. Stallman committed
299
  "If non-nil, compile function bodies so they load lazily.
300 301
They are hidden in comments in the compiled file,
and each one is brought into core when the
302 303 304 305 306 307 308 309
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.")
310
;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
311

312 313 314 315
(defvar byte-compile-disable-print-circle nil
  "If non-nil, disable `print-circle' on printing a byte-compiled code.")
;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)

Richard M. Stallman's avatar
Richard M. Stallman committed
316
(defcustom byte-compile-dynamic-docstrings t
317 318 319
  "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.
320 321 322 323

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.

324 325 326 327 328
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
329 330 331
This option is enabled by default because it reduces Emacs memory usage."
  :group 'bytecomp
  :type 'boolean)
332
;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
333

Richard M. Stallman's avatar
Richard M. Stallman committed
334
(defcustom byte-optimize-log nil
335
  "If true, the byte-compiler will log its optimizations into *Compile-Log*.
Jim Blandy's avatar
Jim Blandy committed
336
If this is 'source, then only source-level optimizations will be logged.
Richard M. Stallman's avatar
Richard M. Stallman committed
337 338 339 340 341 342 343 344
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
345
  "If true, the byte-compiler reports warnings with `error'."
Richard M. Stallman's avatar
Richard M. Stallman committed
346 347
  :group 'bytecomp
  :type 'boolean)
Jim Blandy's avatar
Jim Blandy committed
348

349
(defconst byte-compile-warning-types
350
  '(redefine callargs free-vars unresolved
351 352
	     obsolete noruntime cl-functions interactive-only
	     make-local mapcar)
353
  "The list of warning types used when `byte-compile-warnings' is t.")
Richard M. Stallman's avatar
Richard M. Stallman committed
354
(defcustom byte-compile-warnings t
355
  "List of warnings that the byte-compiler should issue (t for all).
356

357
Elements of the list may be:
Jim Blandy's avatar
Jim Blandy committed
358 359 360

  free-vars   references to variables not in the current lexical scope.
  unresolved  calls to unknown functions.
361 362
  callargs    function calls with args that don't match the definition.
  redefine    function name redefined from a macro to ordinary function or vice
Jim Blandy's avatar
Jim Blandy committed
363
              versa, or redefined to take a different number of arguments.
364 365 366
  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
367
  cl-functions    calls to runtime functions from the CL package (as
368 369
		  distinguished from macros and aliases).
  interactive-only
370
	      commands that normally shouldn't be called from Lisp code.
Glenn Morris's avatar
Glenn Morris committed
371
  make-local  calls to make-variable-buffer-local that may be incorrect.
372 373 374 375
  mapcar      mapcar called for effect.

If the list begins with `not', then the remaining elements specify warnings to
suppress.  For example, (not mapcar) will suppress warnings about mapcar."
Richard M. Stallman's avatar
Richard M. Stallman committed
376
  :group 'bytecomp
377
  :type `(choice (const :tag "All" t)
378 379
		 (set :menu-tag "Some"
		      (const free-vars) (const unresolved)
380
		      (const callargs) (const redefine)
381
		      (const obsolete) (const noruntime)
382
		      (const cl-functions) (const interactive-only)
Glenn Morris's avatar
Glenn Morris committed
383
		      (const make-local) (const mapcar))))
384 385
;;;###autoload(put 'byte-compile-warnings 'safe-local-variable 'byte-compile-warnings-safe-p)

386 387
;;;###autoload
(defun byte-compile-warnings-safe-p (x)
388
  "Return non-nil if X is valid as a value of `byte-compile-warnings'."
389 390
  (or (booleanp x)
      (and (listp x)
391 392
           (if (eq (car x) 'not) (setq x (cdr x))
             t)
393 394
	   (equal (mapcar
		   (lambda (e)
395
		     (when (memq e byte-compile-warning-types)
396 397 398
		       e))
		   x)
		  x))))
399

400 401 402 403 404 405 406 407 408 409 410
(defun byte-compile-warning-enabled-p (warning)
  "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
  (or (eq byte-compile-warnings t)
      (if (eq (car byte-compile-warnings) 'not)
          (not (memq warning byte-compile-warnings))
        (memq warning byte-compile-warnings))))

;;;###autoload
(defun byte-compile-disable-warning (warning)
  "Change `byte-compile-warnings' to disable WARNING.
If `byte-compile-warnings' is t, set it to `(not WARNING)'.
Glenn Morris's avatar
Glenn Morris committed
411 412 413
Otherwise, if the first element is `not', add WARNING, else remove it.
Normally you should let-bind `byte-compile-warnings' before calling this,
else the global value will be modified."
414 415 416 417 418 419 420 421 422 423 424 425 426 427
  (setq byte-compile-warnings
        (cond ((eq byte-compile-warnings t)
               (list 'not warning))
              ((eq (car byte-compile-warnings) 'not)
               (if (memq warning byte-compile-warnings)
                   byte-compile-warnings
                 (append byte-compile-warnings (list warning))))
              (t
               (delq warning byte-compile-warnings)))))

;;;###autoload
(defun byte-compile-enable-warning (warning)
  "Change `byte-compile-warnings' to enable WARNING.
If `byte-compile-warnings' is `t', do nothing.  Otherwise, if the
Glenn Morris's avatar
Glenn Morris committed
428 429 430
first element is `not', remove WARNING, else add it.
Normally you should let-bind `byte-compile-warnings' before calling this,
else the global value will be modified."
431 432 433 434 435 436 437 438 439
  (or (eq byte-compile-warnings t)
      (setq byte-compile-warnings
            (cond ((eq (car byte-compile-warnings) 'not)
                   (delq warning byte-compile-warnings))
                  ((memq warning byte-compile-warnings)
                   byte-compile-warnings)
                  (t
                   (append byte-compile-warnings (list warning)))))))

440 441
(defvar byte-compile-interactive-only-functions
  '(beginning-of-buffer end-of-buffer replace-string replace-regexp
442
    insert-file insert-buffer insert-file-literally previous-line next-line
443
    goto-line comint-run)
444
  "List of commands that are not meant to be called from Lisp.")
Jim Blandy's avatar
Jim Blandy committed
445

446 447 448 449 450
(defvar byte-compile-not-obsolete-vars nil
  "If non-nil, a list of variables that shouldn't be reported as obsolete.")

(defvar byte-compile-not-obsolete-funcs nil
  "If non-nil, a list of functions that shouldn't be reported as obsolete.")
Kenichi Handa's avatar
Kenichi Handa committed
451

Richard M. Stallman's avatar
Richard M. Stallman committed
452
(defcustom byte-compile-generate-call-tree nil
453
  "Non-nil means collect call-graph information when compiling.
454
This records which functions were called and from where.
455 456 457
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
458 459 460 461 462 463

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
464
\(that is, to which no calls have been compiled).  Functions which can be
Richard M. Stallman's avatar
Richard M. Stallman committed
465 466 467
invoked interactively are excluded from this list."
  :group 'bytecomp
  :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
468
		 (other :tag "Ask" lambda)))
Jim Blandy's avatar
Jim Blandy committed
469

470 471
(defvar byte-compile-call-tree nil
  "Alist of functions and their call tree.
Jim Blandy's avatar
Jim Blandy committed
472 473 474 475 476 477 478 479
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
480
(defcustom byte-compile-call-tree-sort 'name
481
  "If non-nil, sort the call tree.
482
The values `name', `callers', `calls', `calls+callers'
Richard M. Stallman's avatar
Richard M. Stallman committed
483 484 485 486
specify different fields to sort on."
  :group 'bytecomp
  :type '(choice (const name) (const callers) (const calls)
		 (const calls+callers) (const nil)))
487

488 489
(defvar byte-compile-debug nil)

490 491 492 493
;; (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
494
;; will not be changed.  If this variable is nil, then an .elc file which
495 496
;; 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
497 498

(defvar byte-compile-constants nil
499
  "List of all constants encountered during compilation of this form.")
Jim Blandy's avatar
Jim Blandy committed
500
(defvar byte-compile-variables nil
501
  "List of all variables encountered during compilation of this form.")
Jim Blandy's avatar
Jim Blandy committed
502
(defvar byte-compile-bound-variables nil
503 504
  "List of variables bound in the context of the current form.
This list lives partly on the stack.")
505 506
(defvar byte-compile-const-variables nil
  "List of variables declared as constants during compilation of this file.")
Jim Blandy's avatar
Jim Blandy committed
507 508 509
(defvar byte-compile-free-references)
(defvar byte-compile-free-assignments)

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

Jim Blandy's avatar
Jim Blandy committed
512
(defconst byte-compile-initial-macro-environment
513 514 515
  '(
;;     (byte-compiler-options . (lambda (&rest forms)
;; 			       (apply 'byte-compiler-options-handler forms)))
Jim Blandy's avatar
Jim Blandy committed
516
    (eval-when-compile . (lambda (&rest body)
517 518 519
			   (list 'quote
				 (byte-compile-eval (byte-compile-top-level
						     (cons 'progn body))))))
Jim Blandy's avatar
Jim Blandy committed
520
    (eval-and-compile . (lambda (&rest body)
521
			  (byte-compile-eval-before-compile (cons 'progn body))
Jim Blandy's avatar
Jim Blandy committed
522 523 524 525 526 527
			  (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
528 529
  "Alist of macros defined in the file being compiled.
Each element looks like (MACRONAME . DEFINITION).  It is
530
\(MACRONAME . nil) when a macro is redefined as a function.")
Jim Blandy's avatar
Jim Blandy committed
531 532

(defvar byte-compile-function-environment nil
533 534 535
  "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
Richard M. Stallman's avatar
Richard M. Stallman committed
536 537
\(FUNCTIONNAME . nil) when a function is redefined as a macro.
It is \(FUNCTIONNAME . t) when all we know is that it was defined,
538 539
and we don't know the definition.  For an autoloaded function, DEFINITION
has the form (autoload . FILENAME).")
Jim Blandy's avatar
Jim Blandy committed
540 541

(defvar byte-compile-unresolved-functions nil
542
  "Alist of undefined functions to which calls have been compiled.
543 544
This variable is only significant whilst compiling an entire buffer.
Used for warnings when a function is not known to be defined or is later
545
defined with incorrect args.")
Jim Blandy's avatar
Jim Blandy committed
546

Kenichi Handa's avatar
Kenichi Handa committed
547 548 549 550 551
(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
552 553 554 555 556 557 558 559 560 561
(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

562
(defvar byte-code-vector nil
Jim Blandy's avatar
Jim Blandy committed
563 564
  "An array containing byte-code names indexed by byte-code values.")

565
(defvar byte-stack+-info nil
Jim Blandy's avatar
Jim Blandy committed
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
  "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))
593 594
    (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
595 596 597 598 599 600 601 602 603 604 605 606


;; 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")
607
;; codes 8-47 are consumed by the preceding opcodes
Jim Blandy's avatar
Jim Blandy committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 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 660 661 662 663 664 665 666 667

;; 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)
668 669
(byte-defop 114  0 byte-save-current-buffer
  "To make a binding to record the current buffer")
Jim Blandy's avatar
Jim Blandy committed
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
(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
695
  "to examine top-of-stack, jump and don't pop it if it's nil,
Jim Blandy's avatar
Jim Blandy committed
696 697
otherwise pop it")
(byte-defop 134 -1 byte-goto-if-not-nil-else-pop
Dave Love's avatar
Dave Love committed
698
  "to examine top-of-stack, jump and don't pop it if it's non nil,
Jim Blandy's avatar
Jim Blandy committed
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
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
716
;; For condition-case.  Takes, on stack, the variable to bind,
717 718
;; an expression for the body, and a list of clauses.
(byte-defop 143 -2 byte-condition-case)
Jim Blandy's avatar
Jim Blandy committed
719

720 721 722 723 724
;; 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
725

726 727 728 729 730
;; 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
731 732

;; these ops are new to v19
733 734

;; To unbind back to the beginning of this frame.
735
;; Not used yet, but will be needed for tail-recursion elimination.
736
(byte-defop 146  0 byte-unbind-all)
Jim Blandy's avatar
Jim Blandy committed
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

;; 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
762
;; unused: 169-174
Jim Blandy's avatar
Jim Blandy committed
763 764 765 766 767 768 769 770 771 772 773 774 775 776
(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)
777
  "List of byte-codes whose offset is a pc.")
Jim Blandy's avatar
Jim Blandy committed
778 779 780 781 782 783

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

(byte-extrude-byte-code-vectors)

;;; lapcode generator
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
;;
;; 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
813 814 815 816 817 818 819

(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
820
	(patchlist nil))	; List of tags and goto's to patch
Jim Blandy's avatar
Jim Blandy committed
821 822 823 824
    (while lap
      (setq op (car (car lap))
	    off (cdr (car lap)))
      (cond ((not (symbolp op))
825
	     (error "Non-symbolic opcode `%s'" op))
Jim Blandy's avatar
Jim Blandy committed
826 827 828 829 830 831 832 833 834 835 836 837 838 839 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
	    ((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)))
866
    ;;    (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
Jim Blandy's avatar
Jim Blandy committed
867 868 869 870 871 872 873 874
    ;; 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))
875 876
	       (setcar bytes (lsh pc -8))
               ;; FIXME: Replace this by some workaround.
877
               (if (> (car bytes) 255) (error "Bytecode overflow"))))
Jim Blandy's avatar
Jim Blandy committed
878
	(setq patchlist (cdr patchlist))))
Kenichi Handa's avatar
Kenichi Handa committed
879
    (apply 'unibyte-string (nreverse bytes))))
Jim Blandy's avatar
Jim Blandy committed
880

881 882 883

;;; compile-time evaluation

884 885 886 887 888
(defun byte-compile-cl-file-p (file)
  "Return non-nil if FILE is one of the CL files."
  (and (stringp file)
       (string-match "^cl\\>" (file-name-nondirectory file))))

889 890
(defun byte-compile-eval (form)
  "Eval FORM and mark the functions defined therein.
Kenichi Handa's avatar
Kenichi Handa committed
891
Each function's symbol gets added to `byte-compile-noruntime-functions'."
892 893
  (let ((hist-orig load-history)
	(hist-nil-orig current-load-list))
894
    (prog1 (eval form)
895
      (when (byte-compile-warning-enabled-p 'noruntime)
896 897
	(let ((hist-new load-history)
	      (hist-nil-new current-load-list))
898 899 900
	  ;; 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)))
901 902
	    (let ((xs (pop hist-new))
		  old-autoloads)
903
	      ;; Make sure the file was not already loaded before.
904
	      (unless (or (assoc (car xs) hist-orig)
905 906 907 908 909 910 911 912 913
			  ;; Don't give both the "noruntime" and
			  ;; "cl-functions" warning for the same function.
			  ;; FIXME This seems incorrect - these are two
			  ;; independent warnings.  For example, you may be
			  ;; choosing to see the cl warnings but ignore them.
			  ;; You probably don't want to ignore noruntime in the
			  ;; same way.
			  (and (byte-compile-warning-enabled-p 'cl-functions)
			       (byte-compile-cl-file-p (car xs))))
914 915
		(dolist (s xs)
		  (cond
916 917
		   ((symbolp s)
		    (unless (memq s old-autoloads)
Kenichi Handa's avatar
Kenichi Handa committed
918
		      (push s byte-compile-noruntime-functions)))
919
		   ((and (consp s) (eq t (car s)))
920
		    (push (cdr s) old-autoloads))
921
		   ((and (consp s) (eq 'autoload (car s)))
Kenichi Handa's avatar
Kenichi Handa committed
922
		    (push (cdr s) byte-compile-noruntime-functions)))))))
923
	  ;; Go through current-load-list for the locally defined funs.
924 925 926 927
	  (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)))
Kenichi Handa's avatar
Kenichi Handa committed
928
		  (push s byte-compile-noruntime-functions))
929
		(when (and (consp s) (eq t (car s)))
930
		  (push (cdr s) old-autoloads)))))))
931
      (when (byte-compile-warning-enabled-p 'cl-functions)
932
	(let ((hist-new load-history))
933 934 935 936 937 938 939 940 941
	  ;; Go through load-history, looking for the cl files.
	  ;; Since new files are added at the start of load-history,
	  ;; we scan the new history until the tail matches the old.
	  (while (and (not byte-compile-cl-functions)
		      hist-new (not (eq hist-new hist-orig)))
	    ;; We used to check if the file had already been loaded,
	    ;; but it is better to check non-nil byte-compile-cl-functions.
	    (and (byte-compile-cl-file-p (car (pop hist-new)))
		 (byte-compile-find-cl-functions))))))))
942

943 944 945 946 947
(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.
948 949
      ;; FIXME Why does it do that - just as a hack?
      ;; There are other ways to do this nowadays.
950 951 952
      (let ((tem current-load-list))
	(while (not (eq tem hist-nil-orig))
	  (when (equal (car tem) '(require . cl))
953
            (byte-compile-disable-warning 'cl-functions))
954
	  (setq tem (cdr tem)))))))
Jim Blandy's avatar
Jim Blandy committed
955 956 957

;;; byte compiler messages

958 959
(defvar byte-compile-current-form nil)
(defvar byte-compile-dest-file nil)
960
(defvar byte-compile-current-file nil)
961
(defvar byte-compile-current-group nil)
962
(defvar byte-compile-current-buffer nil)
963

Richard M. Stallman's avatar
Richard M. Stallman committed
964
;; Log something that isn't a warning.
Jim Blandy's avatar
Jim Blandy committed
965
(defmacro byte-compile-log (format-string &rest args)
966 967 968 969 970 971 972 973 974 975 976 977
  `(and
    byte-optimize
    (memq byte-optimize-log '(t source))
    (let ((print-escape-newlines t)
	  (print-level 4)
	  (print-length 4))
      (byte-compile-log-1
       (format
	,format-string
	,@(mapcar
	   (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
	   args))))))
Jim Blandy's avatar
Jim Blandy committed
978

Richard M. Stallman's avatar
Richard M. Stallman committed
979 980
;; Log something that isn't a warning.
(defun byte-compile-log-1 (string)
981
  (with-current-buffer "*Compile-Log*"
982 983 984 985 986 987 988
    (let ((inhibit-read-only t))
      (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
989

990 991 992 993 994 995
(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
996
(defsubst byte-compile-delete-first (elt list)
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
  (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
1015
;; occurrence of the symbol.
1016 1017 1018 1019 1020 1021 1022
;;
;; This function should not be called twice for the same occurrence of
;; a symbol, and it should not be called for symbols generated by the
;; byte compiler itself; because rather than just fail looking up the
;; symbol, we may find an occurrence of the symbol further ahead, and
;; then `byte-compile-last-position' as advanced too far.
;;
Juanma Barranquero's avatar
Juanma Barranquero committed
1023
;; So your're probably asking yourself: Isn't this function a
1024 1025 1026
;; 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
1027
    (let (last entry)
1028
      (while (progn
1029 1030 1031 1032 1033 1034 1035 1036
	       (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)))
1037 1038
	       (or (and allow-previous (not (= last byte-compile-last-position)))
		   (> last byte-compile-last-position)))))))
1039

Richard M. Stallman's avatar
Richard M. Stallman committed
1040 1041 1042 1043
(defvar byte-compile-last-warned-form nil)
(defvar byte-compile-last-logged-file nil)

;; This is used as warning-prefix for the compiler.
1044
;; It is always called with the warnings buffer current.
Richard M. Stallman's avatar
Richard M. Stallman committed
1045
(defun byte-compile-warning-prefix (level entry)
1046 1047
  (let* ((inhibit-read-only t)
	 (dir default-directory)
1048 1049
	 (file (cond ((stringp byte-compile-current-file)
		      (format "%s:" (file-relative-name byte-compile-current-file dir)))
1050
		     ((bufferp byte-compile-current-file)
1051
		      (format "Buffer %s:"
1052 1053
			      (buffer-name byte-compile-current-file)))
		     (t "")))
1054
	 (pos (if (and byte-compile-current-file
1055 1056
		       (integerp byte-compile-read-position))
		  (with-current-buffer byte-compile-current-buffer
1057
		    (format "%d:%d:"
1058 1059 1060
			    (save-excursion
			      (goto-char byte-compile-last-position)
			      (1+ (count-lines (point-min) (point-at-bol))))
1061 1062 1063
			    (save-excursion
			      (goto-char byte-compile-last-position)
			      (1+ (current-column)))))
1064
		""))
1065 1066 1067 1068 1069
	 (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)))
Kenichi Handa's avatar
Kenichi Handa committed
1070
	      (and byte-compile-current-form