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

3
;; Copyright (C) 1985-1987, 1992, 1994, 1998, 2000-2011
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
10
;; Package: emacs
Jim Blandy's avatar
Jim Blandy committed
11 12 13

;; This file is part of GNU Emacs.

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

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

27 28 29
;;; Commentary:

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

34 35
;;; Code:

Erik Naggum's avatar
Erik Naggum committed
36 37 38
;; ========================================================================
;; Entry points:
;;	byte-recompile-directory, byte-compile-file,
39
;;      byte-recompile-file,
Erik Naggum's avatar
Erik Naggum committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
;;     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
;;      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.

71
;; User customization variables: M-x customize-group bytecomp
Erik Naggum's avatar
Erik Naggum committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

;; 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
90
;;		(inline			;;  `foo' and `baz' will be
Erik Naggum's avatar
Erik Naggum committed
91 92 93 94
;;		 (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
95
;;	in without having to load that file before compiling it.  The
Erik Naggum's avatar
Erik Naggum committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
;;	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
113
;;  o  If you run byte-compile-file on a filename which is visited in a
Erik Naggum's avatar
Erik Naggum committed
114 115 116 117 118
;;     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
119

120
(require 'backquote)
121
(require 'macroexp)
122
(require 'cconv)
123
(eval-when-compile (require 'cl))
124

Jim Blandy's avatar
Jim Blandy committed
125 126
(or (fboundp 'defsubst)
    ;; This really ought to be loaded already!
127
    (load "byte-run"))
Jim Blandy's avatar
Jim Blandy committed
128

129 130 131 132 133 134
;; The feature of compiling in a specific target Emacs version
;; has been turned off because compile time options are a bad idea.
(defmacro byte-compile-single-version () nil)
(defmacro byte-compile-version-cond (cond) cond)


Richard M. Stallman's avatar
Richard M. Stallman committed
135
(defgroup bytecomp nil
136
  "Emacs Lisp byte-compiler."
Richard M. Stallman's avatar
Richard M. Stallman committed
137 138
  :group 'lisp)

139
(defcustom emacs-lisp-file-regexp "\\.el\\'"
140
  "Regexp which matches Emacs Lisp source files.
141
If you change this, you might want to set `byte-compile-dest-file-function'."
Richard M. Stallman's avatar
Richard M. Stallman committed
142 143
  :group 'bytecomp
  :type 'regexp)
Jim Blandy's avatar
Jim Blandy committed
144

145 146 147 148 149 150 151 152
(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")

153 154 155 156 157 158 159 160 161 162
;; 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
163
(or (fboundp 'byte-compile-dest-file)
164
    ;; The user may want to redefine this along with emacs-lisp-file-regexp,
Jim Blandy's avatar
Jim Blandy committed
165
    ;; so only define it if it is undefined.
166 167
    ;; Note - redefining this function is obsolete as of 23.2.
    ;; Customize byte-compile-dest-file-function instead.
Jim Blandy's avatar
Jim Blandy committed
168
    (defun byte-compile-dest-file (filename)
169
      "Convert an Emacs Lisp source file name to a compiled file name.
170 171 172 173 174 175 176 177 178 179 180
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
181 182

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

;; This is the entrypoint to the lapcode optimizer pass1.
186
(autoload 'byte-optimize-form "byte-opt")
Jim Blandy's avatar
Jim Blandy committed
187
;; This is the entrypoint to the lapcode optimizer pass2.
188 189
(autoload 'byte-optimize-lapcode "byte-opt")
(autoload 'byte-compile-unfold-lambda "byte-opt")
Jim Blandy's avatar
Jim Blandy committed
190

191 192 193 194 195 196
;; 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
197
(defcustom byte-compile-verbose
Jim Blandy's avatar
Jim Blandy committed
198
  (and (not noninteractive) (> baud-rate search-slow-speed))
199
  "Non-nil means print messages describing progress of byte-compiler."
Richard M. Stallman's avatar
Richard M. Stallman committed
200 201
  :group 'bytecomp
  :type 'boolean)
Jim Blandy's avatar
Jim Blandy committed
202

Richard M. Stallman's avatar
Richard M. Stallman committed
203
(defcustom byte-optimize t
204
  "Enable optimization in the byte compiler.
205 206 207 208 209
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
210 211 212 213 214 215
  :group 'bytecomp
  :type '(choice (const :tag "none" nil)
		 (const :tag "all" t)
		 (const :tag "source-level" source)
		 (const :tag "byte-level" byte)))

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

222
(defvar byte-compile-dynamic nil
Richard M. Stallman's avatar
Richard M. Stallman committed
223
  "If non-nil, compile function bodies so they load lazily.
224 225
They are hidden in comments in the compiled file,
and each one is brought into core when the
226 227 228 229 230 231 232 233
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.")
234
;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
235

236 237 238 239
(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
240
(defcustom byte-compile-dynamic-docstrings t
241 242 243
  "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.
244 245 246 247

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.

248 249 250 251 252
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
253 254 255
This option is enabled by default because it reduces Emacs memory usage."
  :group 'bytecomp
  :type 'boolean)
256
;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
257

Glenn Morris's avatar
Glenn Morris committed
258 259 260
(defconst byte-compile-log-buffer "*Compile-Log*"
  "Name of the byte-compiler's log buffer.")

Richard M. Stallman's avatar
Richard M. Stallman committed
261
(defcustom byte-optimize-log nil
Glenn Morris's avatar
Glenn Morris committed
262
  "If non-nil, the byte-compiler will log its optimizations.
Jim Blandy's avatar
Jim Blandy committed
263
If this is 'source, then only source-level optimizations will be logged.
Glenn Morris's avatar
Glenn Morris committed
264 265
If it is 'byte, then only byte-level optimizations will be logged.
The information is logged to `byte-compile-log-buffer'."
Richard M. Stallman's avatar
Richard M. Stallman committed
266 267 268 269 270 271 272
  :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
273
  "If true, the byte-compiler reports warnings with `error'."
Richard M. Stallman's avatar
Richard M. Stallman committed
274 275
  :group 'bytecomp
  :type 'boolean)
Jim Blandy's avatar
Jim Blandy committed
276

277
(defconst byte-compile-warning-types
278
  '(redefine callargs free-vars unresolved
279
	     obsolete noruntime cl-functions interactive-only
280
	     make-local mapcar constants suspicious lexical)
281
  "The list of warning types used when `byte-compile-warnings' is t.")
Richard M. Stallman's avatar
Richard M. Stallman committed
282
(defcustom byte-compile-warnings t
283
  "List of warnings that the byte-compiler should issue (t for all).
284

285
Elements of the list may be:
Jim Blandy's avatar
Jim Blandy committed
286 287 288

  free-vars   references to variables not in the current lexical scope.
  unresolved  calls to unknown functions.
289 290
  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
291
              versa, or redefined to take a different number of arguments.
292 293 294
  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
295
  cl-functions    calls to runtime functions from the CL package (as
296 297
		  distinguished from macros and aliases).
  interactive-only
298
	      commands that normally shouldn't be called from Lisp code.
Glenn Morris's avatar
Glenn Morris committed
299
  make-local  calls to make-variable-buffer-local that may be incorrect.
300
  mapcar      mapcar called for effect.
301
  constants   let-binding of, or assignment to, constants/nonvariables.
302
  suspicious  constructs that usually don't do what the coder wanted.
303 304 305

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
306
  :group 'bytecomp
307
  :type `(choice (const :tag "All" t)
308
		 (set :menu-tag "Some"
309 310
                      ,@(mapcar (lambda (x) `(const ,x))
                                byte-compile-warning-types))))
311

312
;;;###autoload
313 314 315 316
(put 'byte-compile-warnings 'safe-local-variable
     (lambda (v)
       (or (symbolp v)
           (null (delq nil (mapcar (lambda (x) (not (symbolp x))) v))))))
317

318 319 320 321 322 323 324 325 326 327 328
(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
329 330 331
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."
332 333 334 335 336 337 338 339 340 341 342 343 344 345
  (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
346 347 348
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."
349 350 351 352 353 354 355 356 357
  (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)))))))

358 359
(defvar byte-compile-interactive-only-functions
  '(beginning-of-buffer end-of-buffer replace-string replace-regexp
360
    insert-file insert-buffer insert-file-literally previous-line next-line
361
    goto-line comint-run delete-backward-char)
362
  "List of commands that are not meant to be called from Lisp.")
Jim Blandy's avatar
Jim Blandy committed
363

364 365 366 367 368
(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
369

Richard M. Stallman's avatar
Richard M. Stallman committed
370
(defcustom byte-compile-generate-call-tree nil
371
  "Non-nil means collect call-graph information when compiling.
372
This records which functions were called and from where.
373 374 375
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
376 377 378 379 380 381

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

388 389
(defvar byte-compile-call-tree nil
  "Alist of functions and their call tree.
Jim Blandy's avatar
Jim Blandy committed
390 391 392 393 394 395 396 397
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
398
(defcustom byte-compile-call-tree-sort 'name
399
  "If non-nil, sort the call tree.
400
The values `name', `callers', `calls', `calls+callers'
Richard M. Stallman's avatar
Richard M. Stallman committed
401 402 403 404
specify different fields to sort on."
  :group 'bytecomp
  :type '(choice (const name) (const callers) (const calls)
		 (const calls+callers) (const nil)))
405

406
(defvar byte-compile-debug t)
407
(setq debug-on-error t)
408

Jim Blandy's avatar
Jim Blandy committed
409
(defvar byte-compile-constants nil
410
  "List of all constants encountered during compilation of this form.")
Jim Blandy's avatar
Jim Blandy committed
411
(defvar byte-compile-variables nil
412
  "List of all variables encountered during compilation of this form.")
Jim Blandy's avatar
Jim Blandy committed
413
(defvar byte-compile-bound-variables nil
414
  "List of dynamic variables bound in the context of the current form.
415
This list lives partly on the stack.")
416 417
(defvar byte-compile-const-variables nil
  "List of variables declared as constants during compilation of this file.")
Jim Blandy's avatar
Jim Blandy committed
418 419 420
(defvar byte-compile-free-references)
(defvar byte-compile-free-assignments)

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

Jim Blandy's avatar
Jim Blandy committed
423
(defconst byte-compile-initial-macro-environment
424 425 426
  '(
;;     (byte-compiler-options . (lambda (&rest forms)
;; 			       (apply 'byte-compiler-options-handler forms)))
Jim Blandy's avatar
Jim Blandy committed
427
    (eval-when-compile . (lambda (&rest body)
428 429 430 431 432 433 434
			   (list
			    'quote
			    (byte-compile-eval
			      (byte-compile-top-level
			       (macroexpand-all
				(cons 'progn body)
				byte-compile-initial-macro-environment))))))
Jim Blandy's avatar
Jim Blandy committed
435
    (eval-and-compile . (lambda (&rest body)
436
			  (byte-compile-eval-before-compile (cons 'progn body))
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440 441 442
			  (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
443 444
  "Alist of macros defined in the file being compiled.
Each element looks like (MACRONAME . DEFINITION).  It is
445
\(MACRONAME . nil) when a macro is redefined as a function.")
Jim Blandy's avatar
Jim Blandy committed
446 447

(defvar byte-compile-function-environment nil
448 449 450
  "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
451 452
\(FUNCTIONNAME . nil) when a function is redefined as a macro.
It is \(FUNCTIONNAME . t) when all we know is that it was defined,
453 454
and we don't know the definition.  For an autoloaded function, DEFINITION
has the form (autoload . FILENAME).")
Jim Blandy's avatar
Jim Blandy committed
455 456

(defvar byte-compile-unresolved-functions nil
457
  "Alist of undefined functions to which calls have been compiled.
458 459
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
460
defined with incorrect args.")
Jim Blandy's avatar
Jim Blandy committed
461

Kenichi Handa's avatar
Kenichi Handa committed
462 463 464 465 466
(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.")

467 468 469 470
;; Variables for lexical binding
(defvar byte-compile-lexical-environment nil
  "The current lexical environment.")

Jim Blandy's avatar
Jim Blandy committed
471 472 473 474 475 476 477 478 479 480
(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

481
(defvar byte-code-vector nil
Jim Blandy's avatar
Jim Blandy committed
482 483
  "An array containing byte-code names indexed by byte-code values.")

484
(defvar byte-stack+-info nil
Jim Blandy's avatar
Jim Blandy committed
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
  "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))
512 513
    (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
514 515 516 517 518


;; These opcodes are special in that they pack their argument into the
;; opcode word.
;;
519
(byte-defop   0  1 byte-stack-ref "for stack reference")
Jim Blandy's avatar
Jim Blandy committed
520 521 522 523 524
(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")
525
;; codes 8-47 are consumed by the preceding opcodes
Jim Blandy's avatar
Jim Blandy committed
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 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585

;; 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)
586 587
(byte-defop 114  0 byte-save-current-buffer
  "To make a binding to record the current buffer")
Jim Blandy's avatar
Jim Blandy committed
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
(byte-defop 115  0 byte-set-mark-OBSOLETE)

;; 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
612
  "to examine top-of-stack, jump and don't pop it if it's nil,
Jim Blandy's avatar
Jim Blandy committed
613 614
otherwise pop it")
(byte-defop 134 -1 byte-goto-if-not-nil-else-pop
Dave Love's avatar
Dave Love committed
615
  "to examine top-of-stack, jump and don't pop it if it's non nil,
Jim Blandy's avatar
Jim Blandy committed
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
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 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
631
;; For condition-case.  Takes, on stack, the variable to bind,
632 633
;; an expression for the body, and a list of clauses.
(byte-defop 143 -2 byte-condition-case)
Jim Blandy's avatar
Jim Blandy committed
634

635 636 637 638
;; 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.
639
;; (byte-defop 144  0 byte-temp-output-buffer-setup)
Jim Blandy's avatar
Jim Blandy committed
640

641 642 643 644
;; 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.
645
;; (byte-defop 145 -1 byte-temp-output-buffer-show)
Jim Blandy's avatar
Jim Blandy committed
646 647

;; these ops are new to v19
648 649

;; To unbind back to the beginning of this frame.
650
;; Not used yet, but will be needed for tail-recursion elimination.
651
(byte-defop 146  0 byte-unbind-all)
Jim Blandy's avatar
Jim Blandy committed
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676

;; 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
677
;; unused: 169-174
678

Jim Blandy's avatar
Jim Blandy committed
679 680 681 682
(byte-defop 175 nil byte-listN)
(byte-defop 176 nil byte-concatN)
(byte-defop 177 nil byte-insertN)

683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
(byte-defop 178 -1 byte-stack-set)	; stack offset in following one byte
(byte-defop 179 -1 byte-stack-set2)	; stack offset in following two bytes

;; if (following one byte & 0x80) == 0
;;    discard (following one byte & 0x7F) stack entries
;; else
;;    discard (following one byte & 0x7F) stack entries _underneath_ the top of stack
;;    (that is, if the operand = 0x83,  ... X Y Z T  =>  ... T)
(byte-defop 182 nil byte-discardN)
;; `byte-discardN-preserve-tos' is a pseudo-op that gets turned into
;; `byte-discardN' with the high bit in the operand set (by
;; `byte-compile-lapcode').
(defconst byte-discardN-preserve-tos byte-discardN)

;; unused: 182-191
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701 702 703 704 705 706

(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)
707
  "List of byte-codes whose offset is a pc.")
Jim Blandy's avatar
Jim Blandy committed
708 709 710 711 712 713

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

(byte-extrude-byte-code-vectors)

;;; lapcode generator
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
;;
;; 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
743

744 745 746 747 748 749 750 751
(defmacro byte-compile-push-bytecodes (&rest args)
  "Push BYTE... onto BYTES, and increment PC by the number of bytes pushed.
ARGS is of the form (BYTE... BYTES PC), where BYTES and PC are variable names.
BYTES and PC are updated after evaluating all the arguments."
  (let ((byte-exprs (butlast args 2))
	(bytes-var (car (last args 2)))
	(pc-var (car (last args))))
    `(setq ,bytes-var ,(if (null (cdr byte-exprs))
752 753 754 755
                           `(progn (assert (<= 0 ,(car byte-exprs)))
                                   (cons ,@byte-exprs ,bytes-var))
                         `(nconc (list ,@(reverse byte-exprs)) ,bytes-var))
           ,pc-var (+ ,(length byte-exprs) ,pc-var))))
756 757 758 759 760 761 762

(defmacro byte-compile-push-bytecode-const2 (opcode const2 bytes pc)
  "Push OPCODE and the two-byte constant CONST2 onto BYTES, and add 3 to PC.
CONST2 may be evaulated multiple times."
  `(byte-compile-push-bytecodes ,opcode (logand ,const2 255) (lsh ,const2 -8)
				,bytes ,pc))

Jim Blandy's avatar
Jim Blandy committed
763 764 765 766 767
(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
768
	opcode			; numeric value of OP
Jim Blandy's avatar
Jim Blandy committed
769
	(bytes '())		; Put the output bytes here
770 771 772 773
	(patchlist nil))	; List of gotos to patch
    (dolist (lap-entry lap)
      (setq op (car lap-entry)
	    off (cdr lap-entry))
774 775 776 777 778 779 780 781 782 783 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 813 814 815 816 817
      (cond
       ((not (symbolp op))
        (error "Non-symbolic opcode `%s'" op))
       ((eq op 'TAG)
        (setcar off pc))
       ((null op)
        ;; a no-op added by `byte-compile-delay-out'
        (unless (zerop off)
          (error
           "Placeholder added by `byte-compile-delay-out' not filled in.")
          ))
       (t
        (setq opcode
              (if (eq op 'byte-discardN-preserve-tos)
                  ;; byte-discardN-preserve-tos is a pseudo op, which
                  ;; is actually the same as byte-discardN
                  ;; with a modified argument.
                  byte-discardN
                (symbol-value op)))
        (cond ((memq op byte-goto-ops)
               ;; goto
               (byte-compile-push-bytecodes opcode nil (cdr off) bytes pc)
               (push bytes patchlist)) 
              ((and (consp off)
                    ;; Variable or constant reference
                    (progn (setq off (cdr off))
                           (eq op 'byte-constant)))
               ;; constant ref
               (if (< off byte-constant-limit)
                   (byte-compile-push-bytecodes (+ byte-constant off)
                                                bytes pc)
                 (byte-compile-push-bytecode-const2 byte-constant2 off
                                                    bytes pc)))
              ((and (= opcode byte-stack-set)
                    (> off 255))
               ;; Use the two-byte version of byte-stack-set if the
               ;; offset is too large for the normal version.
               (byte-compile-push-bytecode-const2 byte-stack-set2 off
                                                  bytes pc))
              ((and (>= opcode byte-listN)
                    (< opcode byte-discardN))
               ;; These insns all put their operand into one extra byte.
               (byte-compile-push-bytecodes opcode off bytes pc))
              ((= opcode byte-discardN)
818
               ;; byte-discardN is weird in that it encodes a flag in the
819 820 821 822 823 824 825 826 827 828
               ;; top bit of its one-byte argument.  If the argument is
               ;; too large to fit in 7 bits, the opcode can be repeated.
               (let ((flag (if (eq op 'byte-discardN-preserve-tos) #x80 0)))
                 (while (> off #x7f)
                   (byte-compile-push-bytecodes opcode (logior #x7f flag) bytes pc)
                   (setq off (- off #x7f)))
                 (byte-compile-push-bytecodes opcode (logior off flag) bytes pc)))
              ((null off)
               ;; opcode that doesn't use OFF
               (byte-compile-push-bytecodes opcode bytes pc))
829 830 831 832
              ((and (eq opcode byte-stack-ref) (eq off 0))
               ;; (stack-ref 0) is really just another name for `dup'.
               (debug)                 ;FIXME: When would this happen?
               (byte-compile-push-bytecodes byte-dup bytes pc))
833 834 835 836 837 838 839 840 841 842
              ;; The following three cases are for the special
              ;; insns that encode their operand into 0, 1, or 2
              ;; extra bytes depending on its magnitude.
              ((< off 6)
               (byte-compile-push-bytecodes (+ opcode off) bytes pc))
              ((< off 256)
               (byte-compile-push-bytecodes (+ opcode 6) off bytes pc))
              (t
               (byte-compile-push-bytecode-const2 (+ opcode 7) off
                                                  bytes pc))))))
Jim Blandy's avatar
Jim Blandy committed
843
    ;;(if (not (= pc (length bytes)))
844
    ;;    (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
845 846 847 848 849 850 851 852 853

    ;; Patch tag PCs into absolute jumps
    (dolist (bytes-tail patchlist)
      (setq pc (caar bytes-tail))	; Pick PC from goto's tag
      (setcar (cdr bytes-tail) (logand pc 255))
      (setcar bytes-tail (lsh pc -8))
      ;; FIXME: Replace this by some workaround.
      (if (> (car bytes) 255) (error "Bytecode overflow")))

Kenichi Handa's avatar
Kenichi Handa committed
854
    (apply 'unibyte-string (nreverse bytes))))
Jim Blandy's avatar
Jim Blandy committed
855

856 857 858

;;; compile-time evaluation

859 860 861 862 863
(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))))

864 865
(defun byte-compile-eval (form)
  "Eval FORM and mark the functions defined therein.
Kenichi Handa's avatar
Kenichi Handa committed
866
Each function's symbol gets added to `byte-compile-noruntime-functions'."
867 868
  (let ((hist-orig load-history)
	(hist-nil-orig current-load-list))
869
    (prog1 (eval form)
870
      (when (byte-compile-warning-enabled-p 'noruntime)
871 872
	(let ((hist-new load-history)
	      (hist-nil-new current-load-list))
873 874 875
	  ;; 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)))
876 877
	    (let ((xs (pop hist-new))
		  old-autoloads)
878
	      ;; Make sure the file was not already loaded before.
879
	      (unless (or (assoc (car xs) hist-orig)
880 881 882 883 884 885 886 887 888
			  ;; 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))))
889 890
		(dolist (s xs)
		  (cond
891 892
		   ((symbolp s)
		    (unless (memq s old-autoloads)
Kenichi Handa's avatar
Kenichi Handa committed
893
		      (push s byte-compile-noruntime-functions)))
894
		   ((and (consp s) (eq t (car s)))
895
		    (push (cdr s) old-autoloads))
896
		   ((and (consp s) (eq 'autoload (car s)))
Kenichi Handa's avatar
Kenichi Handa committed
897
		    (push (cdr s) byte-compile-noruntime-functions)))))))
898
	  ;; Go through current-load-list for the locally defined funs.
899 900 901 902
	  (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
903
		  (push s byte-compile-noruntime-functions))
904
		(when (and (consp s) (eq t (car s)))
905
		  (push (cdr s) old-autoloads)))))))
906
      (when (byte-compile-warning-enabled-p 'cl-functions)
907
	(let ((hist-new load-history))
908 909 910 911 912 913 914 915 916
	  ;; 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))))))))
917

918 919 920 921 922
(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.
923 924
      ;; FIXME Why does it do that - just as a hack?
      ;; There are other ways to do this nowadays.
925 926 927
      (let ((tem current-load-list))
	(while (not (eq tem hist-nil-orig))
	  (when (equal (car tem) '(require . cl))
928
            (byte-compile-disable-warning 'cl-functions))
929
	  (setq tem (cdr tem)))))))
Jim Blandy's avatar
Jim Blandy committed
930 931 932

;;; byte compiler messages

933 934
(defvar byte-compile-current-form nil)
(defvar byte-compile-dest-file nil)
935
(defvar byte-compile-current-file nil)
936
(defvar byte-compile-current-group nil)
937
(defvar byte-compile-current-buffer nil)
938

Richard M. Stallman's avatar
Richard M. Stallman committed
939
;; Log something that isn't a warning.
Jim Blandy's avatar
Jim Blandy committed
940
(defmacro byte-compile-log (format-string &rest args)
941 942 943 944 945 946 947 948 949 950 951 952
  `(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
953

Richard M. Stallman's avatar
Richard M. Stallman committed
954 955
;; Log something that isn't a warning.
(defun byte-compile-log-1 (string)
Glenn Morris's avatar
Glenn Morris committed
956
  (with-current-buffer byte-compile-log-buffer
957 958 959 960 961 962 963
    (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
964

965 966 967 968 969 970
(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
971
(defsubst byte-compile-delete-first (elt list)
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
  (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
990
;; occurrence of the symbol.
991 992 993 994 995 996 997
;;
;; 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
998
;; So your're probably asking yourself: Isn't this function a
999 1000 1001
;; 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
1002
    (let (last entry)
1003
      (while (progn
1004 1005 1006 1007 1008 1009 1010 1011
	       (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)))
1012 1013
	       (or (and allow-previous (not (= last byte-compile-last-position)))
		   (> last byte-compile-last-position)))))))
1014

Richard M. Stallman's avatar
Richard M. Stallman committed
1015 1016 1017 1018
(defvar byte-compile-last-warned-form nil)
(defvar byte-compile-last-logged-file nil)

;; This is used as warning-prefix for the compiler.
1019
;; It is always called with the warnings buffer current.
Richard M. Stallman's avatar
Richard M. Stallman committed
1020
(defun byte-compile-warning-prefix (level entry)
1021 1022
  (let* ((inhibit-read-only t)
	 (dir default-directory)
1023 1024
	 (file (cond ((stringp byte-compile-current-file)
		      (format "%s:" (file-relative-name byte-compile-current-file dir)))
1025
		     ((bufferp byte-compile-current-file)
1026
		      (format "Buffer %s:"
1027 1028
			      (buffer-name byte-compile-current-file)))
		     (t "")))
1029
	 (pos (if (and byte-compile-current-file
1030 1031
		       (integerp byte-compile-read-position))
		  (with-current-buffer byte-compile-current-buffer
1032
		    (format "%d:%d:"
1033 1034 1035
			    (save-excursion
			      (goto-char byte-compile-last-position)
			      (1+ (count-lines (point-min) (point-at-bol))))
1036 1037 1038
			    (save-excursion
			      (goto-char byte-compile-last-position)
			      (1+ (current-column)))))
1039
		""))
1040 1041 1042 1043 1044
	 (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
1045
	      (and byte-compile-current-form
1046 1047
		   (not (eq byte-compile-current-form
			    byte-compile-last-warned-form))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1048
      (insert (format "\nIn %s:\n" form)))
1049 1050
    (when level
      (insert (format "%s%s" file pos))))
1051
  (setq byte-compile-last-logged-file byte-compile-current-file
Richard M. Stallman's avatar
Richard M. Stallman committed
1052 1053
	byte-compile-last-warned-form byte-compile-current-form)
  entry)
Jim Blandy's avatar
Jim Blandy committed
1054

1055 1056 1057 1058 1059 1060
;; 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)

1061
;; (compile-mode) will cause this to be loaded.
1062
(declare-function compilation-forget-errors "compile" ())
1063

Glenn Morris's avatar
Glenn Morris committed
1064
;; Log the start of a file in `byte-compile-log-buffer', and mark it as done.
Richard M. Stallman's avatar
Richard M. Stallman committed
1065
;; Return the position of the start of the page in the log buffer.
1066 1067
;; But do nothing in batch mode.
(defun byte-compile-log-file ()
1068
  (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
1069
       (not noninteractive)
Glenn Morris's avatar
Glenn Morris committed
1070
       (with-current-buffer (get-buffer-create byte-compile-log-buffer)
1071
	 (goto-char (point-max))
1072 1073
	 (let* ((inhibit-read-only t)
		(dir (and byte-compile-current-file
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
			  (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))))
Kenichi Handa's avatar
Kenichi Handa committed
1094 1095
	   (setq byte-compile-last-logged-file byte-compile-current-file
		 byte-compile-last-warned-form nil)
1096
	   ;; Do this after setting default-directory.
1097
	   (unless (derived-mode-p 'compilation-mode) (compilation-mode))
1098
	   (compilation-forget-errors)
Richard M. Stallman's avatar
Richard M. Stallman committed
1099 1100
	   pt))))

Glenn Morris's avatar
Glenn Morris committed
1101
;; Log a message STRING in `byte-compile-log-buffer'.
Richard M. Stallman's avatar
Richard M. Stallman committed
1102 1103 1104
;; 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)
Kenichi Handa's avatar
Kenichi Handa committed
1105
	(warning-type-format "")
1106 1107
	(warning-fill-prefix (if fill "    "))
	(inhibit-read-only t))
Glenn Morris's avatar
Glenn Morris committed
1108
    (display-warning 'bytecomp string level byte-compile-log-buffer)))
1109

Jim Blandy's avatar
Jim Blandy committed
1110
(defun byte-compile-warn (format &rest args)
Richard M. Stallman's avatar
Richard M. Stallman committed
1111
  "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
Jim Blandy's avatar
Jim Blandy committed
1112 1113 1114
  (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
1115 1116
    (byte-compile-log-warning format t :warning)))

1117 1118 1119 1120 1121 1122 1123
(defun byte-compile-warn-obsolete (symbol)
  "Warn that SYMBOL (a variable or function) is obsolete."
  (when (byte-compile-warning-enabled-p 'obsolete)
    (let* ((funcp (get symbol 'byte-obsolete-info))
	   (obsolete (or funcp (get symbol 'byte-obsolete-variable)))
	   (instead (car obsolete))
	   (asof (if funcp (nth 2 obsolete) (cdr obsolete))))
1124 1125 1126 1127 1128 1129 1130 1131 1132
      (unless (and funcp (memq symbol byte-compile-not-obsolete-funcs))
	(byte-compile-warn "`%s' is an obsolete %s%s%s" symbol
			   (if funcp "function" "variable")
			   (if asof (concat " (as of Emacs " asof ")") "")
			   (cond ((stringp instead)
				  (concat "; " instead))
				 (instead
				  (format "; use `%s' instead." instead))
				 (t ".")))))))
1133

Jim Blandy's avatar
Jim Blandy committed
1134
(defun byte-compile-report-error (error-info)
Richard M. Stallman's avatar
Richard M. Stallman committed
1135
  "Report Lisp error in compilation.  ERROR-INFO is the error data."
Richard M. Stallman's avatar
Richard M. Stallman committed
1136
  (setq byte-compiler-error-flag t)
Richard M. Stallman's avatar
Richard M. Stallman committed
1137 1138 1139
  (byte-compile-log-warning
   (error-message-string error-info)
   nil :error))
Jim Blandy's avatar
Jim Blandy committed
1140

Jim Blandy's avatar
Jim Blandy committed
1141 1142
;;; Used by make-obsolete.
(defun byte-compile-obsolete (form)
1143 1144 1145 1146
  (byte-compile-set-symbol-position (car form))
  (byte-compile-warn-obsolete (car form))
  (funcall (or (cadr (get (car form) 'byte-obsolete-info)) ; handler
	       'byte-compile-normal-call) form))
Jim Blandy's avatar
Jim Blandy committed
1147 1148 1149 1150

;;; sanity-checking arglists

(defun byte-compile-fdefinition (name macro-p)
1151 1152 1153 1154
  ;; If a function has an entry saying (FUNCTION . t).
  ;; that means we know it is defined but we don't know how.
  ;; If a function has an entry saying (FUNCTION . nil),
  ;; that means treat it as not defined.
Jim Blandy's avatar
Jim Blandy committed
1155 1156
  (let* ((list (if macro-p
		   byte-compile-macro-environment
1157
		 byte-compile-function-environment))
Jim Blandy's avatar
Jim Blandy committed
1158 1159 1160 1161 1162 1163 1164