* sysdep.c (emacs_read): Remove unnecessary check vs MAX_RW_COUNT.
[bpt/emacs.git] / lisp / emacs-lisp / bytecomp.el
CommitLineData
9ace101c 1;;; bytecomp.el --- compilation of Lisp code into byte code -*- lexical-binding: t -*-
fd5285f3 2
73b0cd50 3;; Copyright (C) 1985-1987, 1992, 1994, 1998, 2000-2011
e9bffc61 4;; Free Software Foundation, Inc.
3a801d0c 5
fd5285f3
RS
6;; Author: Jamie Zawinski <jwz@lucid.com>
7;; Hallvard Furuseth <hbf@ulrik.uio.no>
74dfd056 8;; Maintainer: FSF
713ea1de 9;; Keywords: lisp
bd78fa1d 10;; Package: emacs
1c393159 11
1c393159
JB
12;; This file is part of GNU Emacs.
13
d6cba7ae 14;; GNU Emacs is free software: you can redistribute it and/or modify
1c393159 15;; it under the terms of the GNU General Public License as published by
d6cba7ae
GM
16;; the Free Software Foundation, either version 3 of the License, or
17;; (at your option) any later version.
1c393159
JB
18
19;; GNU Emacs is distributed in the hope that it will be useful,
20;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22;; GNU General Public License for more details.
23
24;; You should have received a copy of the GNU General Public License
d6cba7ae 25;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
1c393159 26
e41b2db1
ER
27;;; Commentary:
28
29;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
a586093f
SM
30;; of p-code (`lapcode') which takes up less space and can be interpreted
31;; faster. [`LAP' == `Lisp Assembly Program'.]
e41b2db1
ER
32;; The user entry points are byte-compile-file and byte-recompile-directory.
33
fd5285f3
RS
34;;; Code:
35
b578f267
EN
36;; ========================================================================
37;; Entry points:
38;; byte-recompile-directory, byte-compile-file,
430e7297 39;; byte-recompile-file,
b578f267
EN
40;; batch-byte-compile, batch-byte-recompile-directory,
41;; byte-compile, compile-defun,
42;; display-call-tree
43;; (byte-compile-buffer and byte-compile-and-load-file were turned off
44;; because they are not terribly useful and get in the way of completion.)
45
46;; This version of the byte compiler has the following improvements:
47;; + optimization of compiled code:
48;; - removal of unreachable code;
49;; - removal of calls to side-effectless functions whose return-value
50;; is unused;
51;; - compile-time evaluation of safe constant forms, such as (consp nil)
52;; and (ash 1 6);
53;; - open-coding of literal lambdas;
54;; - peephole optimization of emitted code;
55;; - trivial functions are left uncompiled for speed.
56;; + support for inline functions;
57;; + compile-time evaluation of arbitrary expressions;
58;; + compile-time warning messages for:
59;; - functions being redefined with incompatible arglists;
60;; - functions being redefined as macros, or vice-versa;
61;; - functions or macros defined multiple times in the same file;
62;; - functions being called with the incorrect number of arguments;
c5091f25 63;; - functions being called which are not defined globally, in the
b578f267
EN
64;; file, or as autoloads;
65;; - assignment and reference of undeclared free variables;
66;; - various syntax errors;
67;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
68;; + correct compilation of top-level uses of macros;
69;; + the ability to generate a histogram of functions called.
70
416d3588 71;; User customization variables: M-x customize-group bytecomp
b578f267
EN
72
73;; New Features:
74;;
75;; o The form `defsubst' is just like `defun', except that the function
76;; generated will be open-coded in compiled code which uses it. This
77;; means that no function call will be generated, it will simply be
78;; spliced in. Lisp functions calls are very slow, so this can be a
79;; big win.
80;;
81;; You can generally accomplish the same thing with `defmacro', but in
82;; that case, the defined procedure can't be used as an argument to
83;; mapcar, etc.
84;;
85;; o You can also open-code one particular call to a function without
86;; open-coding all calls. Use the 'inline' form to do this, like so:
87;;
88;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
89;; or...
c5091f25 90;; (inline ;; `foo' and `baz' will be
b578f267
EN
91;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
92;; (baz 0))
93;;
94;; o It is possible to open-code a function in the same file it is defined
6b61353c 95;; in without having to load that file before compiling it. The
b578f267
EN
96;; byte-compiler has been modified to remember function definitions in
97;; the compilation environment in the same way that it remembers macro
98;; definitions.
99;;
100;; o Forms like ((lambda ...) ...) are open-coded.
101;;
102;; o The form `eval-when-compile' is like progn, except that the body
103;; is evaluated at compile-time. When it appears at top-level, this
104;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
105;; When it does not appear at top-level, it is similar to the
106;; Common Lisp #. reader macro (but not in interpreted code).
107;;
108;; o The form `eval-and-compile' is similar to eval-when-compile, but
109;; the whole form is evalled both at compile-time and at run-time.
110;;
111;; o The command compile-defun is analogous to eval-defun.
112;;
c5091f25 113;; o If you run byte-compile-file on a filename which is visited in a
b578f267
EN
114;; buffer, and that buffer is modified, you are asked whether you want
115;; to save the buffer before compiling.
116;;
117;; o byte-compiled files now start with the string `;ELC'.
118;; Some versions of `file' can be customized to recognize that.
1c393159 119
79d52eea 120(require 'backquote)
b9598260 121(require 'macroexp)
94d11cb5 122(require 'cconv)
14acf2f5 123(eval-when-compile (require 'cl))
79d52eea 124
1c393159
JB
125(or (fboundp 'defsubst)
126 ;; This really ought to be loaded already!
6c2161c4 127 (load "byte-run"))
1c393159 128
b9598260
SM
129;; The feature of compiling in a specific target Emacs version
130;; has been turned off because compile time options are a bad idea.
713ea1de 131(defgroup bytecomp nil
25d1fc94 132 "Emacs Lisp byte-compiler."
713ea1de
RS
133 :group 'lisp)
134
5692cc8c 135(defcustom emacs-lisp-file-regexp "\\.el\\'"
2b9c3b12 136 "Regexp which matches Emacs Lisp source files.
3f12e5bd 137If you change this, you might want to set `byte-compile-dest-file-function'."
713ea1de
RS
138 :group 'bytecomp
139 :type 'regexp)
1c393159 140
3f12e5bd
GM
141(defcustom byte-compile-dest-file-function nil
142 "Function for the function `byte-compile-dest-file' to call.
143It should take one argument, the name of an Emacs Lisp source
144file name, and return the name of the compiled file."
145 :group 'bytecomp
146 :type '(choice (const nil) function)
147 :version "23.2")
148
2140206e
RS
149;; This enables file name handlers such as jka-compr
150;; to remove parts of the file name that should not be copied
151;; through to the output file name.
152(defun byte-compiler-base-file-name (filename)
153 (let ((handler (find-file-name-handler filename
154 'byte-compiler-base-file-name)))
155 (if handler
156 (funcall handler 'byte-compiler-base-file-name filename)
157 filename)))
158
1c393159 159(or (fboundp 'byte-compile-dest-file)
e27c3564 160 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
1c393159 161 ;; so only define it if it is undefined.
3f12e5bd
GM
162 ;; Note - redefining this function is obsolete as of 23.2.
163 ;; Customize byte-compile-dest-file-function instead.
1c393159 164 (defun byte-compile-dest-file (filename)
f9b4b5d8 165 "Convert an Emacs Lisp source file name to a compiled file name.
3f12e5bd
GM
166If `byte-compile-dest-file-function' is non-nil, uses that
167function to do the work. Otherwise, if FILENAME matches
168`emacs-lisp-file-regexp' (by default, files with the extension `.el'),
169adds `c' to it; otherwise adds `.elc'."
170 (if byte-compile-dest-file-function
171 (funcall byte-compile-dest-file-function filename)
172 (setq filename (file-name-sans-versions
173 (byte-compiler-base-file-name filename)))
174 (cond ((string-match emacs-lisp-file-regexp filename)
175 (concat (substring filename 0 (match-beginning 0)) ".elc"))
176 (t (concat filename ".elc"))))))
1c393159
JB
177
178;; This can be the 'byte-compile property of any symbol.
52799cb8 179(autoload 'byte-compile-inline-expand "byte-opt")
1c393159
JB
180
181;; This is the entrypoint to the lapcode optimizer pass1.
52799cb8 182(autoload 'byte-optimize-form "byte-opt")
1c393159 183;; This is the entrypoint to the lapcode optimizer pass2.
52799cb8
RS
184(autoload 'byte-optimize-lapcode "byte-opt")
185(autoload 'byte-compile-unfold-lambda "byte-opt")
1c393159 186
ed015bdd
JB
187;; This is the entry point to the decompiler, which is used by the
188;; disassembler. The disassembler just requires 'byte-compile, but
189;; that doesn't define this function, so this seems to be a reasonable
190;; thing to do.
191(autoload 'byte-decompile-bytecode "byte-opt")
192
713ea1de 193(defcustom byte-compile-verbose
1c393159 194 (and (not noninteractive) (> baud-rate search-slow-speed))
2b9c3b12 195 "Non-nil means print messages describing progress of byte-compiler."
713ea1de
RS
196 :group 'bytecomp
197 :type 'boolean)
1c393159 198
713ea1de 199(defcustom byte-optimize t
2b9c3b12 200 "Enable optimization in the byte compiler.
9bb2e9f8
JB
201Possible values are:
202 nil - no optimization
203 t - all optimizations
204 `source' - source-level optimizations only
205 `byte' - code-level optimizations only"
713ea1de
RS
206 :group 'bytecomp
207 :type '(choice (const :tag "none" nil)
208 (const :tag "all" t)
209 (const :tag "source-level" source)
210 (const :tag "byte-level" byte)))
211
cd91e34c 212(defcustom byte-compile-delete-errors nil
2b9c3b12 213 "If non-nil, the optimizer may delete forms that may signal an error.
713ea1de
RS
214This includes variable references and calls to functions such as `car'."
215 :group 'bytecomp
216 :type 'boolean)
1c393159 217
d82e848c 218(defvar byte-compile-dynamic nil
713ea1de 219 "If non-nil, compile function bodies so they load lazily.
458f70dc
RS
220They are hidden in comments in the compiled file,
221and each one is brought into core when the
d82e848c
RS
222function is called.
223
224To enable this option, make it a file-local variable
225in the source file you want it to apply to.
226For example, add -*-byte-compile-dynamic: t;-*- on the first line.
227
228When this option is true, if you load the compiled file and then move it,
229the functions you loaded will not be able to run.")
631c8020 230;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
d82e848c 231
0e66b003
KH
232(defvar byte-compile-disable-print-circle nil
233 "If non-nil, disable `print-circle' on printing a byte-compiled code.")
53cfe624 234(make-obsolete-variable 'byte-compile-disable-print-circle nil "24.1")
0e66b003
KH
235;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
236
713ea1de 237(defcustom byte-compile-dynamic-docstrings t
2b9c3b12
JB
238 "If non-nil, compile doc strings for lazy access.
239We bury the doc strings of functions and variables inside comments in
240the file, and bring them into core only when they are actually needed.
d82e848c
RS
241
242When this option is true, if you load the compiled file and then move it,
243you won't be able to find the documentation of anything in that file.
244
1c660f5a
KH
245To disable this option for a certain file, make it a file-local variable
246in the source file. For example, add this to the first line:
247 -*-byte-compile-dynamic-docstrings:nil;-*-
248You can also set the variable globally.
249
713ea1de
RS
250This option is enabled by default because it reduces Emacs memory usage."
251 :group 'bytecomp
252 :type 'boolean)
631c8020 253;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
d82e848c 254
7847454a
GM
255(defconst byte-compile-log-buffer "*Compile-Log*"
256 "Name of the byte-compiler's log buffer.")
257
713ea1de 258(defcustom byte-optimize-log nil
7847454a 259 "If non-nil, the byte-compiler will log its optimizations.
1c393159 260If this is 'source, then only source-level optimizations will be logged.
7847454a
GM
261If it is 'byte, then only byte-level optimizations will be logged.
262The information is logged to `byte-compile-log-buffer'."
713ea1de
RS
263 :group 'bytecomp
264 :type '(choice (const :tag "none" nil)
265 (const :tag "all" t)
266 (const :tag "source-level" source)
267 (const :tag "byte-level" byte)))
268
269(defcustom byte-compile-error-on-warn nil
2b9c3b12 270 "If true, the byte-compiler reports warnings with `error'."
713ea1de
RS
271 :group 'bytecomp
272 :type 'boolean)
1c393159 273
9290191f 274(defconst byte-compile-warning-types
086af77c 275 '(redefine callargs free-vars unresolved
8accceac 276 obsolete noruntime cl-functions interactive-only
4f1e9960 277 make-local mapcar constants suspicious lexical)
4795d1c7 278 "The list of warning types used when `byte-compile-warnings' is t.")
713ea1de 279(defcustom byte-compile-warnings t
2b9c3b12 280 "List of warnings that the byte-compiler should issue (t for all).
4795d1c7 281
9bb2e9f8 282Elements of the list may be:
9e2b097b
JB
283
284 free-vars references to variables not in the current lexical scope.
285 unresolved calls to unknown functions.
11efeb9b
RS
286 callargs function calls with args that don't match the definition.
287 redefine function name redefined from a macro to ordinary function or vice
9e2b097b 288 versa, or redefined to take a different number of arguments.
4795d1c7
RS
289 obsolete obsolete variables and functions.
290 noruntime functions that may not be defined at runtime (typically
291 defined only under `eval-when-compile').
6b8c2efc 292 cl-functions calls to runtime functions from the CL package (as
086af77c
RS
293 distinguished from macros and aliases).
294 interactive-only
15ce9dcf 295 commands that normally shouldn't be called from Lisp code.
86da2828 296 make-local calls to make-variable-buffer-local that may be incorrect.
cf637a34 297 mapcar mapcar called for effect.
416d3588 298 constants let-binding of, or assignment to, constants/nonvariables.
62a258a7 299 suspicious constructs that usually don't do what the coder wanted.
cf637a34
GM
300
301If the list begins with `not', then the remaining elements specify warnings to
302suppress. For example, (not mapcar) will suppress warnings about mapcar."
713ea1de 303 :group 'bytecomp
4795d1c7 304 :type `(choice (const :tag "All" t)
aa635691 305 (set :menu-tag "Some"
62a258a7
SM
306 ,@(mapcar (lambda (x) `(const ,x))
307 byte-compile-warning-types))))
6a831405 308
0027258d 309;;;###autoload
acef0722
SM
310(put 'byte-compile-warnings 'safe-local-variable
311 (lambda (v)
312 (or (symbolp v)
313 (null (delq nil (mapcar (lambda (x) (not (symbolp x))) v))))))
086af77c 314
cf637a34
GM
315(defun byte-compile-warning-enabled-p (warning)
316 "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
317 (or (eq byte-compile-warnings t)
318 (if (eq (car byte-compile-warnings) 'not)
319 (not (memq warning byte-compile-warnings))
320 (memq warning byte-compile-warnings))))
321
322;;;###autoload
323(defun byte-compile-disable-warning (warning)
324 "Change `byte-compile-warnings' to disable WARNING.
325If `byte-compile-warnings' is t, set it to `(not WARNING)'.
798bd437
GM
326Otherwise, if the first element is `not', add WARNING, else remove it.
327Normally you should let-bind `byte-compile-warnings' before calling this,
328else the global value will be modified."
cf637a34
GM
329 (setq byte-compile-warnings
330 (cond ((eq byte-compile-warnings t)
331 (list 'not warning))
332 ((eq (car byte-compile-warnings) 'not)
333 (if (memq warning byte-compile-warnings)
334 byte-compile-warnings
335 (append byte-compile-warnings (list warning))))
336 (t
337 (delq warning byte-compile-warnings)))))
338
339;;;###autoload
340(defun byte-compile-enable-warning (warning)
341 "Change `byte-compile-warnings' to enable WARNING.
342If `byte-compile-warnings' is `t', do nothing. Otherwise, if the
798bd437
GM
343first element is `not', remove WARNING, else add it.
344Normally you should let-bind `byte-compile-warnings' before calling this,
345else the global value will be modified."
cf637a34
GM
346 (or (eq byte-compile-warnings t)
347 (setq byte-compile-warnings
348 (cond ((eq (car byte-compile-warnings) 'not)
349 (delq warning byte-compile-warnings))
350 ((memq warning byte-compile-warnings)
351 byte-compile-warnings)
352 (t
353 (append byte-compile-warnings (list warning)))))))
354
086af77c
RS
355(defvar byte-compile-interactive-only-functions
356 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
dfd4e693 357 insert-file insert-buffer insert-file-literally previous-line next-line
dd9b52a6 358 goto-line comint-run delete-backward-char)
086af77c 359 "List of commands that are not meant to be called from Lisp.")
1c393159 360
8480fc7c
GM
361(defvar byte-compile-not-obsolete-vars nil
362 "If non-nil, a list of variables that shouldn't be reported as obsolete.")
363
364(defvar byte-compile-not-obsolete-funcs nil
365 "If non-nil, a list of functions that shouldn't be reported as obsolete.")
6b61353c 366
713ea1de 367(defcustom byte-compile-generate-call-tree nil
2b9c3b12 368 "Non-nil means collect call-graph information when compiling.
78bba1c8 369This records which functions were called and from where.
52799cb8
RS
370If the value is t, compilation displays the call graph when it finishes.
371If the value is neither t nor nil, compilation asks you whether to display
372the graph.
1c393159
JB
373
374The call tree only lists functions called, not macros used. Those functions
375which the byte-code interpreter knows about directly (eq, cons, etc.) are
376not reported.
377
378The call tree also lists those functions which are not known to be called
5023d9a0 379\(that is, to which no calls have been compiled). Functions which can be
713ea1de
RS
380invoked interactively are excluded from this list."
381 :group 'bytecomp
382 :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
778c7576 383 (other :tag "Ask" lambda)))
1c393159 384
2b9c3b12
JB
385(defvar byte-compile-call-tree nil
386 "Alist of functions and their call tree.
1c393159
JB
387Each element looks like
388
389 \(FUNCTION CALLERS CALLS\)
390
391where CALLERS is a list of functions that call FUNCTION, and CALLS
392is a list of functions for which calls were generated while compiling
393FUNCTION.")
394
713ea1de 395(defcustom byte-compile-call-tree-sort 'name
2b9c3b12 396 "If non-nil, sort the call tree.
52799cb8 397The values `name', `callers', `calls', `calls+callers'
713ea1de
RS
398specify different fields to sort on."
399 :group 'bytecomp
400 :type '(choice (const name) (const callers) (const calls)
401 (const calls+callers) (const nil)))
52799cb8 402
ccb3c8de 403(defvar byte-compile-debug nil)
1c393159 404(defvar byte-compile-constants nil
a586093f 405 "List of all constants encountered during compilation of this form.")
1c393159 406(defvar byte-compile-variables nil
a586093f 407 "List of all variables encountered during compilation of this form.")
1c393159 408(defvar byte-compile-bound-variables nil
ce5b520a 409 "List of dynamic variables bound in the context of the current form.
b92dd692 410This list lives partly on the stack.")
6c2161c4
SM
411(defvar byte-compile-const-variables nil
412 "List of variables declared as constants during compilation of this file.")
1c393159
JB
413(defvar byte-compile-free-references)
414(defvar byte-compile-free-assignments)
415
ab94e6e7
RS
416(defvar byte-compiler-error-flag)
417
1c393159 418(defconst byte-compile-initial-macro-environment
52799cb8
RS
419 '(
420;; (byte-compiler-options . (lambda (&rest forms)
421;; (apply 'byte-compiler-options-handler forms)))
a9de04fa 422 (declare-function . byte-compile-macroexpand-declare-function)
1c393159 423 (eval-when-compile . (lambda (&rest body)
b9598260
SM
424 (list
425 'quote
426 (byte-compile-eval
ba83908c 427 (byte-compile-top-level
2ec42da9 428 (byte-compile-preprocess (cons 'progn body)))))))
1c393159 429 (eval-and-compile . (lambda (&rest body)
4795d1c7 430 (byte-compile-eval-before-compile (cons 'progn body))
1c393159
JB
431 (cons 'progn body))))
432 "The default macro-environment passed to macroexpand by the compiler.
433Placing a macro here will cause a macro to have different semantics when
434expanded by the compiler as when expanded by the interpreter.")
435
436(defvar byte-compile-macro-environment byte-compile-initial-macro-environment
52799cb8
RS
437 "Alist of macros defined in the file being compiled.
438Each element looks like (MACRONAME . DEFINITION). It is
e27c3564 439\(MACRONAME . nil) when a macro is redefined as a function.")
1c393159
JB
440
441(defvar byte-compile-function-environment nil
52799cb8
RS
442 "Alist of functions defined in the file being compiled.
443This is so we can inline them when necessary.
444Each element looks like (FUNCTIONNAME . DEFINITION). It is
a7a7ddf1
RS
445\(FUNCTIONNAME . nil) when a function is redefined as a macro.
446It is \(FUNCTIONNAME . t) when all we know is that it was defined,
cb4fb1d0
GM
447and we don't know the definition. For an autoloaded function, DEFINITION
448has the form (autoload . FILENAME).")
1c393159
JB
449
450(defvar byte-compile-unresolved-functions nil
a586093f 451 "Alist of undefined functions to which calls have been compiled.
2cb63a7c
AM
452This variable is only significant whilst compiling an entire buffer.
453Used for warnings when a function is not known to be defined or is later
a586093f 454defined with incorrect args.")
1c393159 455
6b61353c
KH
456(defvar byte-compile-noruntime-functions nil
457 "Alist of functions called that may not be defined when the compiled code is run.
458Used for warnings about calling a function that is defined during compilation
459but won't necessarily be defined when the compiled file is loaded.")
460
b9598260 461;; Variables for lexical binding
7200d79c 462(defvar byte-compile--lexical-environment nil
b9598260 463 "The current lexical environment.")
b9598260 464
1c393159
JB
465(defvar byte-compile-tag-number 0)
466(defvar byte-compile-output nil
467 "Alist describing contents to put in byte code string.
468Each element is (INDEX . VALUE)")
469(defvar byte-compile-depth 0 "Current depth of execution stack.")
470(defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")
471
472\f
473;;; The byte codes; this information is duplicated in bytecomp.c
474
fef3407e 475(defvar byte-code-vector nil
1c393159
JB
476 "An array containing byte-code names indexed by byte-code values.")
477
fef3407e 478(defvar byte-stack+-info nil
1c393159
JB
479 "An array with the stack adjustment for each byte-code.")
480
481(defmacro byte-defop (opcode stack-adjust opname &optional docstring)
482 ;; This is a speed-hack for building the byte-code-vector at compile-time.
483 ;; We fill in the vector at macroexpand-time, and then after the last call
484 ;; to byte-defop, we write the vector out as a constant instead of writing
485 ;; out a bunch of calls to aset.
486 ;; Actually, we don't fill in the vector itself, because that could make
487 ;; it problematic to compile big changes to this compiler; we store the
488 ;; values on its plist, and remove them later in -extrude.
489 (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
490 (put 'byte-code-vector 'tmp-compile-time-value
491 (make-vector 256 nil))))
492 (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
493 (put 'byte-stack+-info 'tmp-compile-time-value
494 (make-vector 256 nil)))))
495 (aset v1 opcode opname)
496 (aset v2 opcode stack-adjust))
497 (if docstring
498 (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
499 (list 'defconst opname opcode)))
500
501(defmacro byte-extrude-byte-code-vectors ()
502 (prog1 (list 'setq 'byte-code-vector
503 (get 'byte-code-vector 'tmp-compile-time-value)
504 'byte-stack+-info
505 (get 'byte-stack+-info 'tmp-compile-time-value))
fd9b0a6b
DL
506 (put 'byte-code-vector 'tmp-compile-time-value nil)
507 (put 'byte-stack+-info 'tmp-compile-time-value nil)))
1c393159
JB
508
509
1c393159
JB
510;; These opcodes are special in that they pack their argument into the
511;; opcode word.
512;;
b9598260 513(byte-defop 0 1 byte-stack-ref "for stack reference")
1c393159
JB
514(byte-defop 8 1 byte-varref "for variable reference")
515(byte-defop 16 -1 byte-varset "for setting a variable")
516(byte-defop 24 -1 byte-varbind "for binding a variable")
517(byte-defop 32 0 byte-call "for calling a function")
518(byte-defop 40 0 byte-unbind "for unbinding special bindings")
eb8c3be9 519;; codes 8-47 are consumed by the preceding opcodes
1c393159
JB
520
521;; unused: 48-55
522
523(byte-defop 56 -1 byte-nth)
524(byte-defop 57 0 byte-symbolp)
525(byte-defop 58 0 byte-consp)
526(byte-defop 59 0 byte-stringp)
527(byte-defop 60 0 byte-listp)
528(byte-defop 61 -1 byte-eq)
529(byte-defop 62 -1 byte-memq)
530(byte-defop 63 0 byte-not)
531(byte-defop 64 0 byte-car)
532(byte-defop 65 0 byte-cdr)
533(byte-defop 66 -1 byte-cons)
534(byte-defop 67 0 byte-list1)
535(byte-defop 68 -1 byte-list2)
536(byte-defop 69 -2 byte-list3)
537(byte-defop 70 -3 byte-list4)
538(byte-defop 71 0 byte-length)
539(byte-defop 72 -1 byte-aref)
540(byte-defop 73 -2 byte-aset)
541(byte-defop 74 0 byte-symbol-value)
542(byte-defop 75 0 byte-symbol-function) ; this was commented out
543(byte-defop 76 -1 byte-set)
544(byte-defop 77 -1 byte-fset) ; this was commented out
545(byte-defop 78 -1 byte-get)
546(byte-defop 79 -2 byte-substring)
547(byte-defop 80 -1 byte-concat2)
548(byte-defop 81 -2 byte-concat3)
549(byte-defop 82 -3 byte-concat4)
550(byte-defop 83 0 byte-sub1)
551(byte-defop 84 0 byte-add1)
552(byte-defop 85 -1 byte-eqlsign)
553(byte-defop 86 -1 byte-gtr)
554(byte-defop 87 -1 byte-lss)
555(byte-defop 88 -1 byte-leq)
556(byte-defop 89 -1 byte-geq)
557(byte-defop 90 -1 byte-diff)
558(byte-defop 91 0 byte-negate)
559(byte-defop 92 -1 byte-plus)
560(byte-defop 93 -1 byte-max)
561(byte-defop 94 -1 byte-min)
562(byte-defop 95 -1 byte-mult) ; v19 only
563(byte-defop 96 1 byte-point)
1c393159
JB
564(byte-defop 98 0 byte-goto-char)
565(byte-defop 99 0 byte-insert)
566(byte-defop 100 1 byte-point-max)
567(byte-defop 101 1 byte-point-min)
568(byte-defop 102 0 byte-char-after)
569(byte-defop 103 1 byte-following-char)
570(byte-defop 104 1 byte-preceding-char)
571(byte-defop 105 1 byte-current-column)
572(byte-defop 106 0 byte-indent-to)
573(byte-defop 107 0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
574(byte-defop 108 1 byte-eolp)
575(byte-defop 109 1 byte-eobp)
576(byte-defop 110 1 byte-bolp)
577(byte-defop 111 1 byte-bobp)
578(byte-defop 112 1 byte-current-buffer)
579(byte-defop 113 0 byte-set-buffer)
78943c8a
RS
580(byte-defop 114 0 byte-save-current-buffer
581 "To make a binding to record the current buffer")
1c393159 582(byte-defop 115 0 byte-set-mark-OBSOLETE)
7200d79c 583;; (byte-defop 116 1 byte-interactive-p) ;Let's not use it any more.
1c393159
JB
584
585;; These ops are new to v19
586(byte-defop 117 0 byte-forward-char)
587(byte-defop 118 0 byte-forward-word)
588(byte-defop 119 -1 byte-skip-chars-forward)
589(byte-defop 120 -1 byte-skip-chars-backward)
590(byte-defop 121 0 byte-forward-line)
591(byte-defop 122 0 byte-char-syntax)
592(byte-defop 123 -1 byte-buffer-substring)
593(byte-defop 124 -1 byte-delete-region)
594(byte-defop 125 -1 byte-narrow-to-region)
595(byte-defop 126 1 byte-widen)
596(byte-defop 127 0 byte-end-of-line)
597
598;; unused: 128
599
600;; These store their argument in the next two bytes
601(byte-defop 129 1 byte-constant2
602 "for reference to a constant with vector index >= byte-constant-limit")
603(byte-defop 130 0 byte-goto "for unconditional jump")
604(byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
605(byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
606(byte-defop 133 -1 byte-goto-if-nil-else-pop
c5091f25 607 "to examine top-of-stack, jump and don't pop it if it's nil,
1c393159
JB
608otherwise pop it")
609(byte-defop 134 -1 byte-goto-if-not-nil-else-pop
c5091f25 610 "to examine top-of-stack, jump and don't pop it if it's non nil,
1c393159
JB
611otherwise pop it")
612
613(byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
614(byte-defop 136 -1 byte-discard "to discard one value from stack")
615(byte-defop 137 1 byte-dup "to duplicate the top of the stack")
616
617(byte-defop 138 0 byte-save-excursion
618 "to make a binding to record the buffer, point and mark")
7200d79c
SM
619;; (byte-defop 139 0 byte-save-window-excursion ; Obsolete: It's a macro now.
620;; "to make a binding to record entire window configuration")
1c393159
JB
621(byte-defop 140 0 byte-save-restriction
622 "to make a binding to record the current buffer clipping restrictions")
623(byte-defop 141 -1 byte-catch
624 "for catch. Takes, on stack, the tag and an expression for the body")
625(byte-defop 142 -1 byte-unwind-protect
626 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
627
c5091f25 628;; For condition-case. Takes, on stack, the variable to bind,
52799cb8
RS
629;; an expression for the body, and a list of clauses.
630(byte-defop 143 -2 byte-condition-case)
1c393159 631
7200d79c 632;; Obsolete: `with-output-to-temp-buffer' is a macro now.
3e21b6a7 633;; (byte-defop 144 0 byte-temp-output-buffer-setup)
3e21b6a7 634;; (byte-defop 145 -1 byte-temp-output-buffer-show)
1c393159
JB
635
636;; these ops are new to v19
52799cb8
RS
637
638;; To unbind back to the beginning of this frame.
69dc83fd 639;; Not used yet, but will be needed for tail-recursion elimination.
52799cb8 640(byte-defop 146 0 byte-unbind-all)
1c393159
JB
641
642;; these ops are new to v19
643(byte-defop 147 -2 byte-set-marker)
644(byte-defop 148 0 byte-match-beginning)
645(byte-defop 149 0 byte-match-end)
646(byte-defop 150 0 byte-upcase)
647(byte-defop 151 0 byte-downcase)
648(byte-defop 152 -1 byte-string=)
649(byte-defop 153 -1 byte-string<)
650(byte-defop 154 -1 byte-equal)
651(byte-defop 155 -1 byte-nthcdr)
652(byte-defop 156 -1 byte-elt)
653(byte-defop 157 -1 byte-member)
654(byte-defop 158 -1 byte-assq)
655(byte-defop 159 0 byte-nreverse)
656(byte-defop 160 -1 byte-setcar)
657(byte-defop 161 -1 byte-setcdr)
658(byte-defop 162 0 byte-car-safe)
659(byte-defop 163 0 byte-cdr-safe)
660(byte-defop 164 -1 byte-nconc)
661(byte-defop 165 -1 byte-quo)
662(byte-defop 166 -1 byte-rem)
663(byte-defop 167 0 byte-numberp)
664(byte-defop 168 0 byte-integerp)
665
3eac9910 666;; unused: 169-174
1c393159
JB
667(byte-defop 175 nil byte-listN)
668(byte-defop 176 nil byte-concatN)
669(byte-defop 177 nil byte-insertN)
670
7200d79c
SM
671(byte-defop 178 -1 byte-stack-set) ; Stack offset in following one byte.
672(byte-defop 179 -1 byte-stack-set2) ; Stack offset in following two bytes.
b9598260 673
7200d79c 674;; If (following one byte & 0x80) == 0
b9598260
SM
675;; discard (following one byte & 0x7F) stack entries
676;; else
2ec42da9 677;; discard (following one byte & 0x7F) stack entries _underneath_ TOS
b9598260
SM
678;; (that is, if the operand = 0x83, ... X Y Z T => ... T)
679(byte-defop 182 nil byte-discardN)
680;; `byte-discardN-preserve-tos' is a pseudo-op that gets turned into
681;; `byte-discardN' with the high bit in the operand set (by
682;; `byte-compile-lapcode').
683(defconst byte-discardN-preserve-tos byte-discardN)
684
685;; unused: 182-191
1c393159
JB
686
687(byte-defop 192 1 byte-constant "for reference to a constant")
688;; codes 193-255 are consumed by byte-constant.
689(defconst byte-constant-limit 64
690 "Exclusive maximum index usable in the `byte-constant' opcode.")
691
692(defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
693 byte-goto-if-nil-else-pop
694 byte-goto-if-not-nil-else-pop)
52799cb8 695 "List of byte-codes whose offset is a pc.")
1c393159
JB
696
697(defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))
698
1c393159
JB
699(byte-extrude-byte-code-vectors)
700\f
701;;; lapcode generator
3614fc84
GM
702;;
703;; the byte-compiler now does source -> lapcode -> bytecode instead of
704;; source -> bytecode, because it's a lot easier to make optimizations
705;; on lapcode than on bytecode.
706;;
707;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
708;; where instruction is a symbol naming a byte-code instruction,
709;; and parameter is an argument to that instruction, if any.
710;;
711;; The instruction can be the pseudo-op TAG, which means that this position
712;; in the instruction stream is a target of a goto. (car PARAMETER) will be
713;; the PC for this location, and the whole instruction "(TAG pc)" will be the
714;; parameter for some goto op.
715;;
716;; If the operation is varbind, varref, varset or push-constant, then the
717;; parameter is (variable/constant . index_in_constant_vector).
718;;
719;; First, the source code is macroexpanded and optimized in various ways.
720;; Then the resultant code is compiled into lapcode. Another set of
721;; optimizations are then run over the lapcode. Then the variables and
722;; constants referenced by the lapcode are collected and placed in the
723;; constants-vector. (This happens now so that variables referenced by dead
724;; code don't consume space.) And finally, the lapcode is transformed into
725;; compacted byte-code.
726;;
727;; A distinction is made between variables and constants because the variable-
728;; referencing instructions are more sensitive to the variables being near the
729;; front of the constants-vector than the constant-referencing instructions.
730;; Also, this lets us notice references to free variables.
1c393159 731
b9598260
SM
732(defmacro byte-compile-push-bytecodes (&rest args)
733 "Push BYTE... onto BYTES, and increment PC by the number of bytes pushed.
734ARGS is of the form (BYTE... BYTES PC), where BYTES and PC are variable names.
735BYTES and PC are updated after evaluating all the arguments."
736 (let ((byte-exprs (butlast args 2))
737 (bytes-var (car (last args 2)))
738 (pc-var (car (last args))))
739 `(setq ,bytes-var ,(if (null (cdr byte-exprs))
b38b1ec0
SM
740 `(progn (assert (<= 0 ,(car byte-exprs)))
741 (cons ,@byte-exprs ,bytes-var))
742 `(nconc (list ,@(reverse byte-exprs)) ,bytes-var))
743 ,pc-var (+ ,(length byte-exprs) ,pc-var))))
b9598260
SM
744
745(defmacro byte-compile-push-bytecode-const2 (opcode const2 bytes pc)
746 "Push OPCODE and the two-byte constant CONST2 onto BYTES, and add 3 to PC.
747CONST2 may be evaulated multiple times."
748 `(byte-compile-push-bytecodes ,opcode (logand ,const2 255) (lsh ,const2 -8)
749 ,bytes ,pc))
750
1c393159
JB
751(defun byte-compile-lapcode (lap)
752 "Turns lapcode into bytecode. The lapcode is destroyed."
753 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
754 (let ((pc 0) ; Program counter
755 op off ; Operation & offset
b9598260 756 opcode ; numeric value of OP
1c393159 757 (bytes '()) ; Put the output bytes here
b9598260
SM
758 (patchlist nil)) ; List of gotos to patch
759 (dolist (lap-entry lap)
760 (setq op (car lap-entry)
761 off (cdr lap-entry))
ce5b520a
SM
762 (cond
763 ((not (symbolp op))
764 (error "Non-symbolic opcode `%s'" op))
765 ((eq op 'TAG)
766 (setcar off pc))
ce5b520a
SM
767 (t
768 (setq opcode
769 (if (eq op 'byte-discardN-preserve-tos)
770 ;; byte-discardN-preserve-tos is a pseudo op, which
771 ;; is actually the same as byte-discardN
772 ;; with a modified argument.
773 byte-discardN
774 (symbol-value op)))
775 (cond ((memq op byte-goto-ops)
776 ;; goto
777 (byte-compile-push-bytecodes opcode nil (cdr off) bytes pc)
7200d79c 778 (push bytes patchlist))
876c194c
SM
779 ((or (and (consp off)
780 ;; Variable or constant reference
781 (progn
782 (setq off (cdr off))
783 (eq op 'byte-constant)))
7200d79c 784 (and (eq op 'byte-constant)
876c194c 785 (integerp off)))
ce5b520a
SM
786 ;; constant ref
787 (if (< off byte-constant-limit)
788 (byte-compile-push-bytecodes (+ byte-constant off)
789 bytes pc)
790 (byte-compile-push-bytecode-const2 byte-constant2 off
791 bytes pc)))
792 ((and (= opcode byte-stack-set)
793 (> off 255))
794 ;; Use the two-byte version of byte-stack-set if the
795 ;; offset is too large for the normal version.
796 (byte-compile-push-bytecode-const2 byte-stack-set2 off
797 bytes pc))
798 ((and (>= opcode byte-listN)
799 (< opcode byte-discardN))
800 ;; These insns all put their operand into one extra byte.
801 (byte-compile-push-bytecodes opcode off bytes pc))
802 ((= opcode byte-discardN)
b38b1ec0 803 ;; byte-discardN is weird in that it encodes a flag in the
ce5b520a
SM
804 ;; top bit of its one-byte argument. If the argument is
805 ;; too large to fit in 7 bits, the opcode can be repeated.
806 (let ((flag (if (eq op 'byte-discardN-preserve-tos) #x80 0)))
807 (while (> off #x7f)
2ec42da9
SM
808 (byte-compile-push-bytecodes opcode (logior #x7f flag)
809 bytes pc)
ce5b520a 810 (setq off (- off #x7f)))
2ec42da9
SM
811 (byte-compile-push-bytecodes opcode (logior off flag)
812 bytes pc)))
ce5b520a
SM
813 ((null off)
814 ;; opcode that doesn't use OFF
815 (byte-compile-push-bytecodes opcode bytes pc))
3e21b6a7
SM
816 ((and (eq opcode byte-stack-ref) (eq off 0))
817 ;; (stack-ref 0) is really just another name for `dup'.
818 (debug) ;FIXME: When would this happen?
819 (byte-compile-push-bytecodes byte-dup bytes pc))
ce5b520a
SM
820 ;; The following three cases are for the special
821 ;; insns that encode their operand into 0, 1, or 2
822 ;; extra bytes depending on its magnitude.
823 ((< off 6)
824 (byte-compile-push-bytecodes (+ opcode off) bytes pc))
825 ((< off 256)
826 (byte-compile-push-bytecodes (+ opcode 6) off bytes pc))
827 (t
828 (byte-compile-push-bytecode-const2 (+ opcode 7) off
829 bytes pc))))))
1c393159 830 ;;(if (not (= pc (length bytes)))
52799cb8 831 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
7200d79c 832 ;; Patch tag PCs into absolute jumps.
b9598260 833 (dolist (bytes-tail patchlist)
7200d79c 834 (setq pc (caar bytes-tail)) ; Pick PC from goto's tag.
b9598260
SM
835 (setcar (cdr bytes-tail) (logand pc 255))
836 (setcar bytes-tail (lsh pc -8))
837 ;; FIXME: Replace this by some workaround.
838 (if (> (car bytes) 255) (error "Bytecode overflow")))
839
da9e269f 840 (apply 'unibyte-string (nreverse bytes))))
1c393159
JB
841
842\f
a586093f
SM
843;;; compile-time evaluation
844
3f12e5bd
GM
845(defun byte-compile-cl-file-p (file)
846 "Return non-nil if FILE is one of the CL files."
847 (and (stringp file)
848 (string-match "^cl\\>" (file-name-nondirectory file))))
849
ea4b0ca3
SM
850(defun byte-compile-eval (form)
851 "Eval FORM and mark the functions defined therein.
6b61353c 852Each function's symbol gets added to `byte-compile-noruntime-functions'."
a586093f
SM
853 (let ((hist-orig load-history)
854 (hist-nil-orig current-load-list))
2ec42da9 855 (prog1 (eval form lexical-binding)
cf637a34 856 (when (byte-compile-warning-enabled-p 'noruntime)
a586093f
SM
857 (let ((hist-new load-history)
858 (hist-nil-new current-load-list))
ea4b0ca3
SM
859 ;; Go through load-history, look for newly loaded files
860 ;; and mark all the functions defined therein.
861 (while (and hist-new (not (eq hist-new hist-orig)))
d1a57439
RS
862 (let ((xs (pop hist-new))
863 old-autoloads)
ea4b0ca3 864 ;; Make sure the file was not already loaded before.
997011eb 865 (unless (or (assoc (car xs) hist-orig)
3f12e5bd
GM
866 ;; Don't give both the "noruntime" and
867 ;; "cl-functions" warning for the same function.
868 ;; FIXME This seems incorrect - these are two
869 ;; independent warnings. For example, you may be
870 ;; choosing to see the cl warnings but ignore them.
871 ;; You probably don't want to ignore noruntime in the
872 ;; same way.
873 (and (byte-compile-warning-enabled-p 'cl-functions)
874 (byte-compile-cl-file-p (car xs))))
ea4b0ca3
SM
875 (dolist (s xs)
876 (cond
d1a57439
RS
877 ((symbolp s)
878 (unless (memq s old-autoloads)
6b61353c 879 (push s byte-compile-noruntime-functions)))
d1a57439 880 ((and (consp s) (eq t (car s)))
6c2161c4 881 (push (cdr s) old-autoloads))
ea4b0ca3 882 ((and (consp s) (eq 'autoload (car s)))
6b61353c 883 (push (cdr s) byte-compile-noruntime-functions)))))))
ea4b0ca3 884 ;; Go through current-load-list for the locally defined funs.
d1a57439
RS
885 (let (old-autoloads)
886 (while (and hist-nil-new (not (eq hist-nil-new hist-nil-orig)))
887 (let ((s (pop hist-nil-new)))
888 (when (and (symbolp s) (not (memq s old-autoloads)))
6b61353c 889 (push s byte-compile-noruntime-functions))
d1a57439 890 (when (and (consp s) (eq t (car s)))
997011eb 891 (push (cdr s) old-autoloads)))))))
cf637a34 892 (when (byte-compile-warning-enabled-p 'cl-functions)
b8104a2b 893 (let ((hist-new load-history))
3f12e5bd
GM
894 ;; Go through load-history, looking for the cl files.
895 ;; Since new files are added at the start of load-history,
896 ;; we scan the new history until the tail matches the old.
897 (while (and (not byte-compile-cl-functions)
898 hist-new (not (eq hist-new hist-orig)))
899 ;; We used to check if the file had already been loaded,
900 ;; but it is better to check non-nil byte-compile-cl-functions.
901 (and (byte-compile-cl-file-p (car (pop hist-new)))
902 (byte-compile-find-cl-functions))))))))
a586093f 903
4795d1c7
RS
904(defun byte-compile-eval-before-compile (form)
905 "Evaluate FORM for `eval-and-compile'."
906 (let ((hist-nil-orig current-load-list))
2ec42da9 907 (prog1 (eval form lexical-binding)
4795d1c7 908 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
3f12e5bd
GM
909 ;; FIXME Why does it do that - just as a hack?
910 ;; There are other ways to do this nowadays.
4795d1c7
RS
911 (let ((tem current-load-list))
912 (while (not (eq tem hist-nil-orig))
913 (when (equal (car tem) '(require . cl))
cf637a34 914 (byte-compile-disable-warning 'cl-functions))
4795d1c7 915 (setq tem (cdr tem)))))))
a586093f 916\f
1c393159
JB
917;;; byte compiler messages
918
d82e848c 919(defvar byte-compile-current-form nil)
d82e848c 920(defvar byte-compile-dest-file nil)
9985d391 921(defvar byte-compile-current-file nil)
ab5111e3 922(defvar byte-compile-current-group nil)
ccb3c8de 923(defvar byte-compile-current-buffer nil)
6a619620 924
22788fb8 925;; Log something that isn't a warning.
1c393159 926(defmacro byte-compile-log (format-string &rest args)
b88a41d0
SM
927 `(and
928 byte-optimize
929 (memq byte-optimize-log '(t source))
930 (let ((print-escape-newlines t)
931 (print-level 4)
932 (print-length 4))
933 (byte-compile-log-1
934 (format
935 ,format-string
936 ,@(mapcar
937 (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
938 args))))))
1c393159 939
22788fb8
RS
940;; Log something that isn't a warning.
941(defun byte-compile-log-1 (string)
7847454a 942 (with-current-buffer byte-compile-log-buffer
997011eb
RS
943 (let ((inhibit-read-only t))
944 (goto-char (point-max))
945 (byte-compile-warning-prefix nil nil)
946 (cond (noninteractive
947 (message " %s" string))
948 (t
949 (insert (format "%s\n" string)))))))
1c393159 950
ccb3c8de
CW
951(defvar byte-compile-read-position nil
952 "Character position we began the last `read' from.")
953(defvar byte-compile-last-position nil
954 "Last known character position in the input.")
955
956;; copied from gnus-util.el
1fd592a0 957(defsubst byte-compile-delete-first (elt list)
ccb3c8de
CW
958 (if (eq (car list) elt)
959 (cdr list)
960 (let ((total list))
961 (while (and (cdr list)
962 (not (eq (cadr list) elt)))
963 (setq list (cdr list)))
964 (when (cdr list)
965 (setcdr list (cddr list)))
966 total)))
967
968;; The purpose of this function is to iterate through the
969;; `read-symbol-positions-list'. Each time we process, say, a
970;; function definition (`defun') we remove `defun' from
971;; `read-symbol-positions-list', and set `byte-compile-last-position'
972;; to that symbol's character position. Similarly, if we encounter a
973;; variable reference, like in (1+ foo), we remove `foo' from the
974;; list. If our current position is after the symbol's position, we
975;; assume we've already passed that point, and look for the next
6b8c2efc 976;; occurrence of the symbol.
4ec5239c
LH
977;;
978;; This function should not be called twice for the same occurrence of
979;; a symbol, and it should not be called for symbols generated by the
980;; byte compiler itself; because rather than just fail looking up the
981;; symbol, we may find an occurrence of the symbol further ahead, and
982;; then `byte-compile-last-position' as advanced too far.
983;;
6b8c2efc 984;; So your're probably asking yourself: Isn't this function a
ccb3c8de
CW
985;; gross hack? And the answer, of course, would be yes.
986(defun byte-compile-set-symbol-position (sym &optional allow-previous)
987 (when byte-compile-read-position
1fd592a0 988 (let (last entry)
ccb3c8de 989 (while (progn
0b46acbf
RS
990 (setq last byte-compile-last-position
991 entry (assq sym read-symbol-positions-list))
992 (when entry
993 (setq byte-compile-last-position
994 (+ byte-compile-read-position (cdr entry))
995 read-symbol-positions-list
996 (byte-compile-delete-first
997 entry read-symbol-positions-list)))
2ec42da9
SM
998 (or (and allow-previous
999 (not (= last byte-compile-last-position)))
ccb3c8de 1000 (> last byte-compile-last-position)))))))
b8175fe6 1001
22788fb8
RS
1002(defvar byte-compile-last-warned-form nil)
1003(defvar byte-compile-last-logged-file nil)
1004
22788fb8 1005;; This is used as warning-prefix for the compiler.
4390021b 1006;; It is always called with the warnings buffer current.
22788fb8 1007(defun byte-compile-warning-prefix (level entry)
997011eb
RS
1008 (let* ((inhibit-read-only t)
1009 (dir default-directory)
4390021b 1010 (file (cond ((stringp byte-compile-current-file)
2ec42da9
SM
1011 (format "%s:" (file-relative-name
1012 byte-compile-current-file dir)))
b8175fe6 1013 ((bufferp byte-compile-current-file)
1f006824 1014 (format "Buffer %s:"
b8175fe6
GM
1015 (buffer-name byte-compile-current-file)))
1016 (t "")))
1f006824 1017 (pos (if (and byte-compile-current-file
ccb3c8de
CW
1018 (integerp byte-compile-read-position))
1019 (with-current-buffer byte-compile-current-buffer
ea1cb2bd 1020 (format "%d:%d:"
b0aa2c65
RS
1021 (save-excursion
1022 (goto-char byte-compile-last-position)
1023 (1+ (count-lines (point-min) (point-at-bol))))
ccb3c8de
CW
1024 (save-excursion
1025 (goto-char byte-compile-last-position)
1026 (1+ (current-column)))))
b8175fe6 1027 ""))
4390021b
RS
1028 (form (if (eq byte-compile-current-form :end) "end of data"
1029 (or byte-compile-current-form "toplevel form"))))
1030 (when (or (and byte-compile-current-file
1031 (not (equal byte-compile-current-file
1032 byte-compile-last-logged-file)))
6b61353c 1033 (and byte-compile-current-form
4390021b
RS
1034 (not (eq byte-compile-current-form
1035 byte-compile-last-warned-form))))
22788fb8 1036 (insert (format "\nIn %s:\n" form)))
4390021b
RS
1037 (when level
1038 (insert (format "%s%s" file pos))))
cb3069bb 1039 (setq byte-compile-last-logged-file byte-compile-current-file
22788fb8
RS
1040 byte-compile-last-warned-form byte-compile-current-form)
1041 entry)
1c393159 1042
4390021b
RS
1043;; This no-op function is used as the value of warning-series
1044;; to tell inner calls to displaying-byte-compile-warnings
1045;; not to bind warning-series.
9ace101c 1046(defun byte-compile-warning-series (&rest _ignore)
4390021b
RS
1047 nil)
1048
db283402 1049;; (compile-mode) will cause this to be loaded.
2c52d7a3 1050(declare-function compilation-forget-errors "compile" ())
db283402 1051
7847454a 1052;; Log the start of a file in `byte-compile-log-buffer', and mark it as done.
22788fb8 1053;; Return the position of the start of the page in the log buffer.
144b2637
RS
1054;; But do nothing in batch mode.
1055(defun byte-compile-log-file ()
4390021b 1056 (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
cb3069bb 1057 (not noninteractive)
7847454a 1058 (with-current-buffer (get-buffer-create byte-compile-log-buffer)
ca96ae0b 1059 (goto-char (point-max))
997011eb
RS
1060 (let* ((inhibit-read-only t)
1061 (dir (and byte-compile-current-file
4390021b
RS
1062 (file-name-directory byte-compile-current-file)))
1063 (was-same (equal default-directory dir))
1064 pt)
1065 (when dir
1066 (unless was-same
1067 (insert (format "Leaving directory `%s'\n" default-directory))))
1068 (unless (bolp)
1069 (insert "\n"))
1070 (setq pt (point-marker))
1071 (if byte-compile-current-file
1072 (insert "\f\nCompiling "
1073 (if (stringp byte-compile-current-file)
1074 (concat "file " byte-compile-current-file)
2ec42da9
SM
1075 (concat "buffer "
1076 (buffer-name byte-compile-current-file)))
4390021b
RS
1077 " at " (current-time-string) "\n")
1078 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1079 (when dir
1080 (setq default-directory dir)
1081 (unless was-same
2ec42da9
SM
1082 (insert (format "Entering directory `%s'\n"
1083 default-directory))))
6b61353c
KH
1084 (setq byte-compile-last-logged-file byte-compile-current-file
1085 byte-compile-last-warned-form nil)
977f31f8 1086 ;; Do this after setting default-directory.
5c7ffa04 1087 (unless (derived-mode-p 'compilation-mode) (compilation-mode))
b88a41d0 1088 (compilation-forget-errors)
22788fb8
RS
1089 pt))))
1090
7847454a 1091;; Log a message STRING in `byte-compile-log-buffer'.
22788fb8
RS
1092;; Also log the current function and file if not already done.
1093(defun byte-compile-log-warning (string &optional fill level)
1094 (let ((warning-prefix-function 'byte-compile-warning-prefix)
6b61353c 1095 (warning-type-format "")
997011eb
RS
1096 (warning-fill-prefix (if fill " "))
1097 (inhibit-read-only t))
7847454a 1098 (display-warning 'bytecomp string level byte-compile-log-buffer)))
144b2637 1099
1c393159 1100(defun byte-compile-warn (format &rest args)
22788fb8 1101 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1c393159
JB
1102 (setq format (apply 'format format args))
1103 (if byte-compile-error-on-warn
1104 (error "%s" format) ; byte-compile-file catches and logs it
22788fb8
RS
1105 (byte-compile-log-warning format t :warning)))
1106
5791bedf
GM
1107(defun byte-compile-warn-obsolete (symbol)
1108 "Warn that SYMBOL (a variable or function) is obsolete."
1109 (when (byte-compile-warning-enabled-p 'obsolete)
1110 (let* ((funcp (get symbol 'byte-obsolete-info))
1111 (obsolete (or funcp (get symbol 'byte-obsolete-variable)))
1112 (instead (car obsolete))
1113 (asof (if funcp (nth 2 obsolete) (cdr obsolete))))
8480fc7c
GM
1114 (unless (and funcp (memq symbol byte-compile-not-obsolete-funcs))
1115 (byte-compile-warn "`%s' is an obsolete %s%s%s" symbol
1116 (if funcp "function" "variable")
1117 (if asof (concat " (as of Emacs " asof ")") "")
1118 (cond ((stringp instead)
1119 (concat "; " instead))
1120 (instead
1121 (format "; use `%s' instead." instead))
1122 (t ".")))))))
5791bedf 1123
0b030df7 1124(defun byte-compile-report-error (error-info)
22788fb8 1125 "Report Lisp error in compilation. ERROR-INFO is the error data."
ab94e6e7 1126 (setq byte-compiler-error-flag t)
22788fb8
RS
1127 (byte-compile-log-warning
1128 (error-message-string error-info)
1129 nil :error))
1c393159 1130\f
1c393159
JB
1131;;; sanity-checking arglists
1132
1133(defun byte-compile-fdefinition (name macro-p)
ced10a4c
SM
1134 ;; If a function has an entry saying (FUNCTION . t).
1135 ;; that means we know it is defined but we don't know how.
1136 ;; If a function has an entry saying (FUNCTION . nil),
1137 ;; that means treat it as not defined.
1c393159
JB
1138 (let* ((list (if macro-p
1139 byte-compile-macro-environment
5286a842 1140 byte-compile-function-environment))
1c393159
JB
1141 (env (cdr (assq name list))))
1142 (or env
1143 (let ((fn name))
1144 (while (and (symbolp fn)
1145 (fboundp fn)
1146 (or (symbolp (symbol-function fn))
1147 (consp (symbol-function fn))
1148 (and (not macro-p)
ed015bdd 1149 (byte-code-function-p (symbol-function fn)))))
1c393159 1150 (setq fn (symbol-function fn)))
9d28c33e
SM
1151 (let ((advertised (gethash (if (and (symbolp fn) (fboundp fn))
1152 ;; Could be a subr.
1153 (symbol-function fn)
1154 fn)
1155 advertised-signature-table t)))
ced10a4c
SM
1156 (cond
1157 ((listp advertised)
1158 (if macro-p
1159 `(macro lambda ,advertised)
1160 `(lambda ,advertised)))
1161 ((and (not macro-p) (byte-code-function-p fn)) fn)
1162 ((not (consp fn)) nil)
1163 ((eq 'macro (car fn)) (cdr fn))
1164 (macro-p nil)
1165 ((eq 'autoload (car fn)) nil)
1166 (t fn)))))))
1c393159
JB
1167
1168(defun byte-compile-arglist-signature (arglist)
e2abe5a1
SM
1169 (if (integerp arglist)
1170 ;; New style byte-code arglist.
1171 (cons (logand arglist 127) ;Mandatory.
1172 (if (zerop (logand arglist 128)) ;No &rest.
1173 (lsh arglist -8))) ;Nonrest.
1174 ;; Old style byte-code, or interpreted function.
1175 (let ((args 0)
1176 opts
1177 restp)
1178 (while arglist
1179 (cond ((eq (car arglist) '&optional)
1180 (or opts (setq opts 0)))
1181 ((eq (car arglist) '&rest)
1182 (if (cdr arglist)
1183 (setq restp t
1184 arglist nil)))
1185 (t
1186 (if opts
1187 (setq opts (1+ opts))
1c393159 1188 (setq args (1+ args)))))
e2abe5a1
SM
1189 (setq arglist (cdr arglist)))
1190 (cons args (if restp nil (if opts (+ args opts) args))))))
1c393159
JB
1191
1192
1193(defun byte-compile-arglist-signatures-congruent-p (old new)
1194 (not (or
1195 (> (car new) (car old)) ; requires more args now
a7acbbe4 1196 (and (null (cdr old)) ; took rest-args, doesn't any more
1c393159
JB
1197 (cdr new))
1198 (and (cdr new) (cdr old) ; can't take as many args now
1199 (< (cdr new) (cdr old)))
1200 )))
1201
1202(defun byte-compile-arglist-signature-string (signature)
1203 (cond ((null (cdr signature))
1204 (format "%d+" (car signature)))
1205 ((= (car signature) (cdr signature))
1206 (format "%d" (car signature)))
1207 (t (format "%d-%d" (car signature) (cdr signature)))))
1208
1209
52799cb8 1210;; Warn if the form is calling a function with the wrong number of arguments.
1c393159 1211(defun byte-compile-callargs-warn (form)
1c393159
JB
1212 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1213 (byte-compile-fdefinition (car form) t)))
a7a7ddf1 1214 (sig (if (and def (not (eq def t)))
416d3588
GM
1215 (progn
1216 (and (eq (car-safe def) 'macro)
1217 (eq (car-safe (cdr-safe def)) 'lambda)
1218 (setq def (cdr def)))
1219 (byte-compile-arglist-signature
1220 (if (memq (car-safe def) '(declared lambda))
1221 (nth 1 def)
1222 (if (byte-code-function-p def)
1223 (aref def 0)
1224 '(&rest def)))))
ed62683d
DL
1225 (if (and (fboundp (car form))
1226 (subrp (symbol-function (car form))))
1227 (subr-arity (symbol-function (car form))))))
1c393159 1228 (ncall (length (cdr form))))
ed62683d
DL
1229 ;; Check many or unevalled from subr-arity.
1230 (if (and (cdr-safe sig)
1231 (not (numberp (cdr sig))))
1232 (setcdr sig nil))
1c393159 1233 (if sig
ccb3c8de 1234 (when (or (< ncall (car sig))
1c393159 1235 (and (cdr sig) (> ncall (cdr sig))))
ccb3c8de
CW
1236 (byte-compile-set-symbol-position (car form))
1237 (byte-compile-warn
1238 "%s called with %d argument%s, but %s %s"
1239 (car form) ncall
1240 (if (= 1 ncall) "" "s")
1241 (if (< ncall (car sig))
1242 "requires"
1243 "accepts only")
ba76e7fa 1244 (byte-compile-arglist-signature-string sig))))
6b61353c 1245 (byte-compile-format-warn form)
ba76e7fa
SM
1246 ;; Check to see if the function will be available at runtime
1247 ;; and/or remember its arity if it's unknown.
a7a7ddf1 1248 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
6b61353c 1249 (not (memq (car form) byte-compile-noruntime-functions)))
ba76e7fa
SM
1250 (eq (car form) byte-compile-current-form) ; ## this doesn't work
1251 ; with recursion.
1252 ;; It's a currently-undefined function.
1253 ;; Remember number of args in call.
1254 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1255 (n (length (cdr form))))
1256 (if cons
1257 (or (memq n (cdr cons))
1258 (setcdr cons (cons n (cdr cons))))
977b50fb
SM
1259 (push (list (car form) n)
1260 byte-compile-unresolved-functions))))))
1c393159 1261
6b61353c
KH
1262(defun byte-compile-format-warn (form)
1263 "Warn if FORM is `format'-like with inconsistent args.
1264Applies if head of FORM is a symbol with non-nil property
1265`byte-compile-format-like' and first arg is a constant string.
1266Then check the number of format fields matches the number of
1267extra args."
1268 (when (and (symbolp (car form))
1269 (stringp (nth 1 form))
1270 (get (car form) 'byte-compile-format-like))
1271 (let ((nfields (with-temp-buffer
1272 (insert (nth 1 form))
b8104a2b 1273 (goto-char (point-min))
6b61353c
KH
1274 (let ((n 0))
1275 (while (re-search-forward "%." nil t)
1276 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1277 (setq n (1+ n))))
1278 n)))
1279 (nargs (- (length form) 2)))
1280 (unless (= nargs nfields)
1281 (byte-compile-warn
1282 "`%s' called with %d args to fill %d format field(s)" (car form)
1283 nargs nfields)))))
1284
1285(dolist (elt '(format message error))
1286 (put elt 'byte-compile-format-like t))
1287
11efeb9b
RS
1288;; Warn if a custom definition fails to specify :group.
1289(defun byte-compile-nogroup-warn (form)
ab5111e3
SM
1290 (if (and (memq (car form) '(custom-declare-face custom-declare-variable))
1291 byte-compile-current-group)
1292 ;; The group will be provided implicitly.
1293 nil
1294 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1295 (name (cadr form)))
1296 (or (not (eq (car-safe name) 'quote))
3ab6a7ae
SM
1297 (and (eq (car form) 'custom-declare-group)
1298 (equal name ''emacs))
1299 (plist-get keyword-args :group)
1300 (not (and (consp name) (eq (car name) 'quote)))
1301 (byte-compile-warn
1302 "%s for `%s' fails to specify containing group"
1303 (cdr (assq (car form)
ab5111e3
SM
1304 '((custom-declare-group . defgroup)
1305 (custom-declare-face . defface)
1306 (custom-declare-variable . defcustom))))
1307 (cadr name)))
1308 ;; Update the current group, if needed.
2ec42da9 1309 (if (and byte-compile-current-file ;Only when compiling a whole file.
ab5111e3
SM
1310 (eq (car form) 'custom-declare-group)
1311 (eq (car-safe name) 'quote))
1312 (setq byte-compile-current-group (cadr name))))))
11efeb9b 1313
52799cb8
RS
1314;; Warn if the function or macro is being redefined with a different
1315;; number of arguments.
1c393159 1316(defun byte-compile-arglist-warn (form macrop)
a9de04fa
SM
1317 (let* ((name (nth 1 form))
1318 (old (byte-compile-fdefinition name macrop)))
a7a7ddf1 1319 (if (and old (not (eq old t)))
416d3588
GM
1320 (progn
1321 (and (eq 'macro (car-safe old))
1322 (eq 'lambda (car-safe (cdr-safe old)))
1323 (setq old (cdr old)))
1324 (let ((sig1 (byte-compile-arglist-signature
b38b1ec0
SM
1325 (pcase old
1326 (`(lambda ,args . ,_) args)
23aba0ea 1327 (`(closure ,_ ,args . ,_) args)
b38b1ec0
SM
1328 ((pred byte-code-function-p) (aref old 0))
1329 (t '(&rest def)))))
416d3588
GM
1330 (sig2 (byte-compile-arglist-signature (nth 2 form))))
1331 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
a9de04fa 1332 (byte-compile-set-symbol-position name)
416d3588
GM
1333 (byte-compile-warn
1334 "%s %s used to take %s %s, now takes %s"
1335 (if (eq (car form) 'defun) "function" "macro")
a9de04fa 1336 name
416d3588
GM
1337 (byte-compile-arglist-signature-string sig1)
1338 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1339 (byte-compile-arglist-signature-string sig2)))))
1c393159 1340 ;; This is the first definition. See if previous calls are compatible.
a9de04fa 1341 (let ((calls (assq name byte-compile-unresolved-functions))
1c393159 1342 nums sig min max)
a9de04fa
SM
1343 (when calls
1344 (when (and (symbolp name)
1345 (eq (get name 'byte-optimizer)
1346 'byte-compile-inline-expand))
1347 (byte-compile-warn "defsubst `%s' was used before it was defined"
1348 name))
1349 (setq sig (byte-compile-arglist-signature (nth 2 form))
1350 nums (sort (copy-sequence (cdr calls)) (function <))
1351 min (car nums)
1352 max (car (nreverse nums)))
1353 (when (or (< min (car sig))
1354 (and (cdr sig) (> max (cdr sig))))
1355 (byte-compile-set-symbol-position name)
1356 (byte-compile-warn
1357 "%s being defined to take %s%s, but was previously called with %s"
1358 name
1359 (byte-compile-arglist-signature-string sig)
1360 (if (equal sig '(1 . 1)) " arg" " args")
1361 (byte-compile-arglist-signature-string (cons min max))))
1362
1363 (setq byte-compile-unresolved-functions
1364 (delq calls byte-compile-unresolved-functions)))))))
1c393159 1365
95c997fa
RS
1366(defvar byte-compile-cl-functions nil
1367 "List of functions defined in CL.")
1368
3f12e5bd
GM
1369;; Can't just add this to cl-load-hook, because that runs just before
1370;; the forms from cl.el get added to load-history.
95c997fa
RS
1371(defun byte-compile-find-cl-functions ()
1372 (unless byte-compile-cl-functions
1373 (dolist (elt load-history)
3f12e5bd
GM
1374 (and (byte-compile-cl-file-p (car elt))
1375 (dolist (e (cdr elt))
1376 ;; Includes the cl-foo functions that cl autoloads.
1377 (when (memq (car-safe e) '(autoload defun))
1378 (push (cdr e) byte-compile-cl-functions)))))))
95c997fa 1379
4795d1c7
RS
1380(defun byte-compile-cl-warn (form)
1381 "Warn if FORM is a call of a function from the CL package."
95c997fa
RS
1382 (let ((func (car-safe form)))
1383 (if (and byte-compile-cl-functions
1384 (memq func byte-compile-cl-functions)
6b61353c 1385 ;; Aliases which won't have been expanded at this point.
4795d1c7
RS
1386 ;; These aren't all aliases of subrs, so not trivial to
1387 ;; avoid hardwiring the list.
1388 (not (memq func
9cb9a7bc
RS
1389 '(cl-block-wrapper cl-block-throw
1390 multiple-value-call nth-value
95c997fa 1391 copy-seq first second rest endp cl-member
d1a57439
RS
1392 ;; These are included in generated code
1393 ;; that can't be called except at compile time
1394 ;; or unless cl is loaded anyway.
1395 cl-defsubst-expand cl-struct-setf-expander
8f876842
RS
1396 ;; These would sometimes be warned about
1397 ;; but such warnings are never useful,
1398 ;; so don't warn about them.
118861df 1399 macroexpand cl-macroexpand-all
b38b1ec0 1400 cl-compiling-file))))
7a16788b 1401 (byte-compile-warn "function `%s' from cl package called at runtime"
4795d1c7
RS
1402 func)))
1403 form)
1404
a586093f 1405(defun byte-compile-print-syms (str1 strn syms)
ccb3c8de
CW
1406 (when syms
1407 (byte-compile-set-symbol-position (car syms) t))
b8175fe6
GM
1408 (cond ((and (cdr syms) (not noninteractive))
1409 (let* ((str strn)
1410 (L (length str))
1411 s)
1412 (while syms
1413 (setq s (symbol-name (pop syms))
1414 L (+ L (length s) 2))
1415 (if (< L (1- fill-column))
1416 (setq str (concat str " " s (and syms ",")))
1417 (setq str (concat str "\n " s (and syms ","))
1418 L (+ (length s) 4))))
1419 (byte-compile-warn "%s" str)))
1420 ((cdr syms)
1f006824 1421 (byte-compile-warn "%s %s"
b8175fe6
GM
1422 strn
1423 (mapconcat #'symbol-name syms ", ")))
1424
1425 (syms
1426 (byte-compile-warn str1 (car syms)))))
a586093f 1427
1f006824 1428;; If we have compiled any calls to functions which are not known to be
52799cb8
RS
1429;; defined, issue a warning enumerating them.
1430;; `unresolved' in the list `byte-compile-warnings' disables this.
1c393159 1431(defun byte-compile-warn-about-unresolved-functions ()
cf637a34 1432 (when (byte-compile-warning-enabled-p 'unresolved)
b8175fe6 1433 (let ((byte-compile-current-form :end)
a586093f
SM
1434 (noruntime nil)
1435 (unresolved nil))
1436 ;; Separate the functions that will not be available at runtime
1437 ;; from the truly unresolved ones.
1438 (dolist (f byte-compile-unresolved-functions)
1439 (setq f (car f))
1440 (if (fboundp f) (push f noruntime) (push f unresolved)))
1441 ;; Complain about the no-run-time functions
1442 (byte-compile-print-syms
b8175fe6
GM
1443 "the function `%s' might not be defined at runtime."
1444 "the following functions might not be defined at runtime:"
a586093f
SM
1445 noruntime)
1446 ;; Complain about the unresolved functions
1447 (byte-compile-print-syms
b8175fe6
GM
1448 "the function `%s' is not known to be defined."
1449 "the following functions are not known to be defined:"
a586093f 1450 unresolved)))
1c393159
JB
1451 nil)
1452
1453\f
582a857c 1454(defsubst byte-compile-const-symbol-p (symbol &optional any-value)
6c2161c4 1455 "Non-nil if SYMBOL is constant.
582a857c 1456If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
6c2161c4 1457symbol itself."
1639b803 1458 (or (memq symbol '(nil t))
6c2161c4 1459 (keywordp symbol)
d988dbf6
SM
1460 (if any-value
1461 (or (memq symbol byte-compile-const-variables)
1462 ;; FIXME: We should provide a less intrusive way to find out
a9de04fa 1463 ;; if a variable is "constant".
d988dbf6
SM
1464 (and (boundp symbol)
1465 (condition-case nil
1466 (progn (set symbol (symbol-value symbol)) nil)
1467 (setting-constant t)))))))
1639b803 1468
1c393159 1469(defmacro byte-compile-constp (form)
c5091f25 1470 "Return non-nil if FORM is a constant."
1639b803
DL
1471 `(cond ((consp ,form) (eq (car ,form) 'quote))
1472 ((not (symbolp ,form)))
1473 ((byte-compile-const-symbol-p ,form))))
1c393159
JB
1474
1475(defmacro byte-compile-close-variables (&rest body)
876c194c 1476 (declare (debug t))
1c393159
JB
1477 (cons 'let
1478 (cons '(;;
1479 ;; Close over these variables to encapsulate the
1480 ;; compilation state
1481 ;;
1482 (byte-compile-macro-environment
1483 ;; Copy it because the compiler may patch into the
1484 ;; macroenvironment.
1485 (copy-alist byte-compile-initial-macro-environment))
1486 (byte-compile-function-environment nil)
1487 (byte-compile-bound-variables nil)
6c2161c4 1488 (byte-compile-const-variables nil)
1c393159
JB
1489 (byte-compile-free-references nil)
1490 (byte-compile-free-assignments nil)
1491 ;;
1492 ;; Close over these variables so that `byte-compiler-options'
1493 ;; can change them on a per-file basis.
1494 ;;
1495 (byte-compile-verbose byte-compile-verbose)
1496 (byte-optimize byte-optimize)
d82e848c
RS
1497 (byte-compile-dynamic byte-compile-dynamic)
1498 (byte-compile-dynamic-docstrings
1499 byte-compile-dynamic-docstrings)
52799cb8
RS
1500;; (byte-compile-generate-emacs19-bytecodes
1501;; byte-compile-generate-emacs19-bytecodes)
cf637a34 1502 (byte-compile-warnings byte-compile-warnings)
1c393159
JB
1503 )
1504 body)))
1505
1c393159 1506(defmacro displaying-byte-compile-warnings (&rest body)
876c194c 1507 (declare (debug t))
4390021b
RS
1508 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1509 (warning-series-started
1510 (and (markerp warning-series)
1511 (eq (marker-buffer warning-series)
7847454a 1512 (get-buffer byte-compile-log-buffer)))))
95c997fa 1513 (byte-compile-find-cl-functions)
4390021b
RS
1514 (if (or (eq warning-series 'byte-compile-warning-series)
1515 warning-series-started)
1516 ;; warning-series does come from compilation,
1517 ;; so don't bind it, but maybe do set it.
1518 (let (tem)
1519 ;; Log the file name. Record position of that text.
1520 (setq tem (byte-compile-log-file))
1521 (unless warning-series-started
1522 (setq warning-series (or tem 'byte-compile-warning-series)))
1523 (if byte-compile-debug
1524 (funcall --displaying-byte-compile-warnings-fn)
1525 (condition-case error-info
1526 (funcall --displaying-byte-compile-warnings-fn)
1527 (error (byte-compile-report-error error-info)))))
1528 ;; warning-series does not come from compilation, so bind it.
1529 (let ((warning-series
1530 ;; Log the file name. Record position of that text.
1531 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1532 (if byte-compile-debug
22788fb8 1533 (funcall --displaying-byte-compile-warnings-fn)
4390021b
RS
1534 (condition-case error-info
1535 (funcall --displaying-byte-compile-warnings-fn)
1536 (error (byte-compile-report-error error-info))))))))
1c393159 1537\f
fd5285f3 1538;;;###autoload
9742dbc0
RS
1539(defun byte-force-recompile (directory)
1540 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1541Files in subdirectories of DIRECTORY are processed also."
c0f43df5 1542 (interactive "DByte force recompile (directory): ")
9742dbc0
RS
1543 (byte-recompile-directory directory nil t))
1544
1545;;;###autoload
ca105506
SM
1546(defun byte-recompile-directory (directory &optional arg force)
1547 "Recompile every `.el' file in DIRECTORY that needs recompilation.
2b9c3b12 1548This happens when a `.elc' file exists but is older than the `.el' file.
ca105506 1549Files in subdirectories of DIRECTORY are processed also.
1c393159 1550
c4f2cabd 1551If the `.elc' file does not exist, normally this function *does not*
1c3b663f 1552compile the corresponding `.el' file. However, if the prefix argument
ca105506
SM
1553ARG is 0, that means do compile all those files. A nonzero
1554ARG means ask the user, for each such `.el' file, whether to
1555compile it. A nonzero ARG also means ask about each subdirectory
1c3b663f
GM
1556before scanning it.
1557
ca105506 1558If the third argument FORCE is non-nil, recompile every `.el' file
1c3b663f 1559that already has a `.elc' file."
1c393159 1560 (interactive "DByte recompile directory: \nP")
ca105506 1561 (if arg (setq arg (prefix-numeric-value arg)))
e27c3564
JB
1562 (if noninteractive
1563 nil
1564 (save-some-buffers)
ba901388 1565 (force-mode-line-update))
7847454a 1566 (with-current-buffer (get-buffer-create byte-compile-log-buffer)
ca105506 1567 (setq default-directory (expand-file-name directory))
977f31f8
RS
1568 ;; compilation-mode copies value of default-directory.
1569 (unless (eq major-mode 'compilation-mode)
1570 (compilation-mode))
ca105506 1571 (let ((directories (list default-directory))
4eb4926c
RS
1572 (default-directory default-directory)
1573 (skip-count 0)
1574 (fail-count 0)
1575 (file-count 0)
1576 (dir-count 0)
1577 last-dir)
1578 (displaying-byte-compile-warnings
ca105506
SM
1579 (while directories
1580 (setq directory (car directories))
1581 (message "Checking %s..." directory)
1582 (dolist (file (directory-files directory))
1583 (let ((source (expand-file-name file directory)))
1584 (if (and (not (member file '("RCS" "CVS")))
1585 (not (eq ?\. (aref file 0)))
1586 (file-directory-p source)
1587 (not (file-symlink-p source)))
1588 ;; This file is a subdirectory. Handle them differently.
1589 (when (or (null arg) (eq 0 arg)
1590 (y-or-n-p (concat "Check " source "? ")))
1591 (setq directories (nconc directories (list source))))
1592 ;; It is an ordinary file. Decide whether to compile it.
1593 (if (and (string-match emacs-lisp-file-regexp source)
1594 (file-readable-p source)
1595 (not (auto-save-file-name-p source))
1596 (not (string-equal dir-locals-file
1597 (file-name-nondirectory source))))
1598 (progn (case (byte-recompile-file source force arg)
1599 (no-byte-compile (setq skip-count (1+ skip-count)))
1600 ((t) (setq file-count (1+ file-count)))
1601 ((nil) (setq fail-count (1+ fail-count))))
1602 (or noninteractive
1603 (message "Checking %s..." directory))
1604 (if (not (eq last-dir directory))
1605 (setq last-dir directory
1606 dir-count (1+ dir-count)))
1607 )))))
1608 (setq directories (cdr directories))))
4eb4926c
RS
1609 (message "Done (Total of %d file%s compiled%s%s%s)"
1610 file-count (if (= file-count 1) "" "s")
1611 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1612 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1c3b663f
GM
1613 (if (> dir-count 1)
1614 (format " in %d directories" dir-count) "")))))
1c393159 1615
fef3407e 1616(defvar no-byte-compile nil
2b9c3b12 1617 "Non-nil to prevent byte-compiling of Emacs Lisp code.
fef3407e
SM
1618This is normally set in local file variables at the end of the elisp file:
1619
ce5b520a 1620\;; Local Variables:\n;; no-byte-compile: t\n;; End: ") ;Backslash for compile-main.
631c8020 1621;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
fef3407e 1622
ca105506
SM
1623(defun byte-recompile-file (filename &optional force arg load)
1624 "Recompile FILENAME file if it needs recompilation.
430e7297
JD
1625This happens when its `.elc' file is older than itself.
1626
1627If the `.elc' file exists and is up-to-date, normally this
ca105506
SM
1628function *does not* compile FILENAME. However, if the
1629prefix argument FORCE is set, that means do compile
1630FILENAME even if the destination already exists and is
430e7297
JD
1631up-to-date.
1632
1633If the `.elc' file does not exist, normally this function *does
ca105506 1634not* compile FILENAME. If ARG is 0, that means
430e7297 1635compile the file even if it has never been compiled before.
ca105506 1636A nonzero ARG means ask the user.
430e7297
JD
1637
1638If LOAD is set, `load' the file after compiling.
1639
1640The value returned is the value returned by `byte-compile-file',
1641or 'no-byte-compile if the file did not need recompilation."
1642 (interactive
ca105506
SM
1643 (let ((file buffer-file-name)
1644 (file-name nil)
1645 (file-dir nil))
1646 (and file
1647 (derived-mode-p 'emacs-lisp-mode)
1648 (setq file-name (file-name-nondirectory file)
1649 file-dir (file-name-directory file)))
430e7297
JD
1650 (list (read-file-name (if current-prefix-arg
1651 "Byte compile file: "
1652 "Byte recompile file: ")
ca105506 1653 file-dir file-name nil)
430e7297 1654 current-prefix-arg)))
ca105506 1655 (let ((dest (byte-compile-dest-file filename))
430e7297 1656 ;; Expand now so we get the current buffer's defaults
ca105506
SM
1657 (filename (expand-file-name filename)))
1658 (if (if (file-exists-p dest)
430e7297
JD
1659 ;; File was already compiled
1660 ;; Compile if forced to, or filename newer
ca105506
SM
1661 (or force
1662 (file-newer-than-file-p filename dest))
1663 (and arg
1664 (or (eq 0 arg)
fa14dc18 1665 (y-or-n-p (concat "Compile "
ca105506 1666 filename "? ")))))
430e7297
JD
1667 (progn
1668 (if (and noninteractive (not byte-compile-verbose))
ca105506
SM
1669 (message "Compiling %s..." filename))
1670 (byte-compile-file filename load))
1671 (when load (load filename))
430e7297
JD
1672 'no-byte-compile)))
1673
fd5285f3 1674;;;###autoload
ca105506
SM
1675(defun byte-compile-file (filename &optional load)
1676 "Compile a file of Lisp code named FILENAME into a file of byte code.
1677The output file's name is generated by passing FILENAME to the
f279aaab 1678function `byte-compile-dest-file' (which see).
3614fc84 1679With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
d90a41e8 1680The value is non-nil if there were no errors, nil if errors."
1c393159
JB
1681;; (interactive "fByte compile file: \nP")
1682 (interactive
ca105506
SM
1683 (let ((file buffer-file-name)
1684 (file-name nil)
1685 (file-dir nil))
1686 (and file
9ace101c 1687 (derived-mode-p 'emacs-lisp-mode)
ca105506
SM
1688 (setq file-name (file-name-nondirectory file)
1689 file-dir (file-name-directory file)))
52799cb8
RS
1690 (list (read-file-name (if current-prefix-arg
1691 "Byte compile and load file: "
1692 "Byte compile file: ")
ca105506 1693 file-dir file-name nil)
fd5285f3 1694 current-prefix-arg)))
1c393159 1695 ;; Expand now so we get the current buffer's defaults
ca105506 1696 (setq filename (expand-file-name filename))
1c393159
JB
1697
1698 ;; If we're compiling a file that's in a buffer and is modified, offer
1699 ;; to save it first.
1700 (or noninteractive
ca105506 1701 (let ((b (get-file-buffer (expand-file-name filename))))
1c393159 1702 (if (and b (buffer-modified-p b)
a586093f 1703 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
008e2c2a 1704 (with-current-buffer b (save-buffer)))))
1c393159 1705
4390021b
RS
1706 ;; Force logging of the file name for each file compiled.
1707 (setq byte-compile-last-logged-file nil)
ca105506 1708 (let ((byte-compile-current-file filename)
ab5111e3 1709 (byte-compile-current-group nil)
dc14ae36 1710 (set-auto-coding-for-load t)
d82e848c
RS
1711 target-file input-buffer output-buffer
1712 byte-compile-dest-file)
ca105506 1713 (setq target-file (byte-compile-dest-file filename))
d82e848c 1714 (setq byte-compile-dest-file target-file)
ea1cb2bd 1715 (with-current-buffer
008e2c2a 1716 (setq input-buffer (get-buffer-create " *Compiler Input*"))
1c393159 1717 (erase-buffer)
7a28e3b1 1718 (setq buffer-file-coding-system nil)
746dd298 1719 ;; Always compile an Emacs Lisp file as multibyte
b92dd692 1720 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
746dd298 1721 (set-buffer-multibyte t)
ca105506 1722 (insert-file-contents filename)
844da0ff
KH
1723 ;; Mimic the way after-insert-file-set-coding can make the
1724 ;; buffer unibyte when visiting this file.
7a28e3b1
RS
1725 (when (or (eq last-coding-system-used 'no-conversion)
1726 (eq (coding-system-type last-coding-system-used) 5))
1727 ;; For coding systems no-conversion and raw-text...,
1728 ;; edit the buffer as unibyte.
1729 (set-buffer-multibyte nil))
1c393159
JB
1730 ;; Run hooks including the uncompression hook.
1731 ;; If they change the file name, then change it for the output also.
ca105506 1732 (letf ((buffer-file-name filename)
14acf2f5
SM
1733 ((default-value 'major-mode) 'emacs-lisp-mode)
1734 ;; Ignore unsafe local variables.
1735 ;; We only care about a few of them for our purposes.
1736 (enable-local-variables :safe)
1737 (enable-local-eval nil))
aa9addfa
RS
1738 ;; Arg of t means don't alter enable-local-variables.
1739 (normal-mode t)
ca105506 1740 (setq filename buffer-file-name))
cd891e68 1741 ;; Set the default directory, in case an eval-when-compile uses it.
ca105506 1742 (setq default-directory (file-name-directory filename)))
3614fc84
GM
1743 ;; Check if the file's local variables explicitly specify not to
1744 ;; compile this file.
fef3407e 1745 (if (with-current-buffer input-buffer no-byte-compile)
3614fc84 1746 (progn
6b61353c 1747 ;; (message "%s not compiled because of `no-byte-compile: %s'"
ca105506 1748 ;; (file-relative-name filename)
6b61353c
KH
1749 ;; (with-current-buffer input-buffer no-byte-compile))
1750 (when (file-exists-p target-file)
1751 (message "%s deleted because of `no-byte-compile: %s'"
1752 (file-relative-name target-file)
1753 (buffer-local-value 'no-byte-compile input-buffer))
1754 (condition-case nil (delete-file target-file) (error nil)))
82345a9a 1755 ;; We successfully didn't compile this file.
d90a41e8 1756 'no-byte-compile)
ccb3c8de 1757 (when byte-compile-verbose
ca105506 1758 (message "Compiling %s..." filename))
82345a9a
SM
1759 (setq byte-compiler-error-flag nil)
1760 ;; It is important that input-buffer not be current at this call,
1761 ;; so that the value of point set in input-buffer
1762 ;; within byte-compile-from-buffer lingers in that buffer.
4f6d5bf0
SM
1763 (setq output-buffer
1764 (save-current-buffer
9ace101c 1765 (byte-compile-from-buffer input-buffer)))
82345a9a
SM
1766 (if byte-compiler-error-flag
1767 nil
ccb3c8de 1768 (when byte-compile-verbose
ca105506 1769 (message "Compiling %s...done" filename))
82345a9a
SM
1770 (kill-buffer input-buffer)
1771 (with-current-buffer output-buffer
1772 (goto-char (point-max))
1773 (insert "\n") ; aaah, unix.
82345a9a
SM
1774 (if (file-writable-p target-file)
1775 ;; We must disable any code conversion here.
9c524fcb
GM
1776 (let* ((coding-system-for-write 'no-conversion)
1777 ;; Write to a tempfile so that if another Emacs
1778 ;; process is trying to load target-file (eg in a
1779 ;; parallel bootstrap), it does not risk getting a
1780 ;; half-finished file. (Bug#4196)
1781 (tempfile (make-temp-name target-file))
1782 (kill-emacs-hook
1783 (cons (lambda () (ignore-errors (delete-file tempfile)))
1784 kill-emacs-hook)))
82345a9a
SM
1785 (if (memq system-type '(ms-dos 'windows-nt))
1786 (setq buffer-file-type t))
7eb662be 1787 (write-region (point-min) (point-max) tempfile nil 1)
0f34ae28
GM
1788 ;; This has the intentional side effect that any
1789 ;; hard-links to target-file continue to
1790 ;; point to the old file (this makes it possible
1791 ;; for installed files to share disk space with
1792 ;; the build tree, without causing problems when
1793 ;; emacs-lisp files in the build tree are
1794 ;; recompiled). Previously this was accomplished by
1795 ;; deleting target-file before writing it.
7eb662be
GM
1796 (rename-file tempfile target-file t)
1797 (message "Wrote %s" target-file))
82345a9a
SM
1798 ;; This is just to give a better error message than write-region
1799 (signal 'file-error
1800 (list "Opening output file"
1801 (if (file-exists-p target-file)
1802 "cannot overwrite file"
1803 "directory not writable or nonexistent")
7c2fb837 1804 target-file)))
82345a9a
SM
1805 (kill-buffer (current-buffer)))
1806 (if (and byte-compile-generate-call-tree
1807 (or (eq t byte-compile-generate-call-tree)
1c3b663f 1808 (y-or-n-p (format "Report call tree for %s? "
ca105506 1809 filename))))
82345a9a 1810 (save-excursion
ca105506 1811 (display-call-tree filename)))
82345a9a
SM
1812 (if load
1813 (load target-file))
1814 t))))
1c393159 1815
1c393159 1816;;; compiling a single function
fd5285f3 1817;;;###autoload
52799cb8 1818(defun compile-defun (&optional arg)
1c393159 1819 "Compile and evaluate the current top-level form.
6b61353c 1820Print the result in the echo area.
2b9c3b12 1821With argument ARG, insert value in current buffer after the form."
1c393159
JB
1822 (interactive "P")
1823 (save-excursion
1824 (end-of-defun)
1825 (beginning-of-defun)
1826 (let* ((byte-compile-current-file nil)
ccb3c8de
CW
1827 (byte-compile-current-buffer (current-buffer))
1828 (byte-compile-read-position (point))
1829 (byte-compile-last-position byte-compile-read-position)
1c393159 1830 (byte-compile-last-warned-form 'nothing)
ccb3c8de 1831 (value (eval
9cb9a7bc 1832 (let ((read-with-symbol-positions (current-buffer))
ccb3c8de
CW
1833 (read-symbol-positions-list nil))
1834 (displaying-byte-compile-warnings
2ec42da9
SM
1835 (byte-compile-sexp (read (current-buffer)))))
1836 lexical-binding)))
1c393159
JB
1837 (cond (arg
1838 (message "Compiling from buffer... done.")
1839 (prin1 value (current-buffer))
1840 (insert "\n"))
1841 ((message "%s" (prin1-to-string value)))))))
1842
9ace101c
SM
1843;; Dynamically bound in byte-compile-from-buffer.
1844;; NB also used in cl.el and cl-macs.el.
7200d79c 1845(defvar byte-compile--outbuffer)
1c393159 1846
ca105506 1847(defun byte-compile-from-buffer (inbuffer)
7200d79c 1848 (let (byte-compile--outbuffer
ca105506 1849 (byte-compile-current-buffer inbuffer)
ccb3c8de
CW
1850 (byte-compile-read-position nil)
1851 (byte-compile-last-position nil)
d82e848c
RS
1852 ;; Prevent truncation of flonums and lists as we read and print them
1853 (float-output-format nil)
1854 (case-fold-search nil)
1855 (print-length nil)
95e7d933 1856 (print-level nil)
74dfd056
RS
1857 ;; Prevent edebug from interfering when we compile
1858 ;; and put the output into a file.
ccb3c8de
CW
1859;; (edebug-all-defs nil)
1860;; (edebug-all-forms nil)
d82e848c
RS
1861 ;; Simulate entry to byte-compile-top-level
1862 (byte-compile-constants nil)
1863 (byte-compile-variables nil)
1864 (byte-compile-tag-number 0)
1865 (byte-compile-depth 0)
1866 (byte-compile-maxdepth 0)
1867 (byte-compile-output nil)
ccb3c8de 1868 ;; This allows us to get the positions of symbols read; it's
bf247b6e 1869 ;; new in Emacs 22.1.
ca105506 1870 (read-with-symbol-positions inbuffer)
ccb3c8de 1871 (read-symbol-positions-list nil)
d82e848c 1872 ;; #### This is bound in b-c-close-variables.
cf637a34 1873 ;; (byte-compile-warnings byte-compile-warnings)
d82e848c
RS
1874 )
1875 (byte-compile-close-variables
b8104a2b 1876 (with-current-buffer
7200d79c
SM
1877 (setq byte-compile--outbuffer
1878 (get-buffer-create " *Compiler Output*"))
08b59cd3 1879 (set-buffer-multibyte t)
d82e848c
RS
1880 (erase-buffer)
1881 ;; (emacs-lisp-mode)
96bcef2e 1882 (setq case-fold-search nil))
d82e848c 1883 (displaying-byte-compile-warnings
ca105506 1884 (with-current-buffer inbuffer
9ace101c
SM
1885 (and byte-compile-current-file
1886 (byte-compile-insert-header byte-compile-current-file
7200d79c 1887 byte-compile--outbuffer))
b8104a2b 1888 (goto-char (point-min))
2cb63a7c
AM
1889 ;; Should we always do this? When calling multiple files, it
1890 ;; would be useful to delay this warning until all have been
1891 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1892 ;; previous byte-compile.
1893 (setq byte-compile-unresolved-functions nil)
d82e848c
RS
1894
1895 ;; Compile the forms from the input buffer.
1896 (while (progn
1897 (while (progn (skip-chars-forward " \t\n\^l")
1898 (looking-at ";"))
1899 (forward-line 1))
1900 (not (eobp)))
ccb3c8de
CW
1901 (setq byte-compile-read-position (point)
1902 byte-compile-last-position byte-compile-read-position)
36e65f70 1903 (let* ((old-style-backquotes nil)
ca105506 1904 (form (read inbuffer)))
36e65f70
SM
1905 ;; Warn about the use of old-style backquotes.
1906 (when old-style-backquotes
1907 (byte-compile-warn "!! The file uses old-style backquotes !!
1908This functionality has been obsolete for more than 10 years already
1909and will be removed soon. See (elisp)Backquote in the manual."))
876c194c 1910 (byte-compile-toplevel-file-form form)))
d82e848c
RS
1911 ;; Compile pending forms at end of file.
1912 (byte-compile-flush-pending)
977f31f8
RS
1913 ;; Make warnings about unresolved functions
1914 ;; give the end of the file as their position.
1915 (setq byte-compile-last-position (point-max))
2cb63a7c 1916 (byte-compile-warn-about-unresolved-functions))
fb639443
RS
1917 ;; Fix up the header at the front of the output
1918 ;; if the buffer contains multibyte characters.
9ace101c 1919 (and byte-compile-current-file
7200d79c 1920 (with-current-buffer byte-compile--outbuffer
9ace101c 1921 (byte-compile-fix-header byte-compile-current-file)))))
7200d79c 1922 byte-compile--outbuffer))
8a5dd086 1923
775adc51
GM
1924(defun byte-compile-fix-header (filename)
1925 "If the current buffer has any multibyte characters, insert a version test."
1926 (when (< (point-max) (position-bytes (point-max)))
1927 (goto-char (point-min))
1928 ;; Find the comment that describes the version condition.
1929 (search-forward "\n;;; This file uses")
1930 (narrow-to-region (line-beginning-position) (point-max))
1931 ;; Find the first line of ballast semicolons.
1932 (search-forward ";;;;;;;;;;")
1933 (beginning-of-line)
1934 (narrow-to-region (point-min) (point))
1935 (let ((old-header-end (point))
1936 (minimum-version "23")
1937 delta)
1938 (delete-region (point-min) (point-max))
1939 (insert
1940 ";;; This file contains utf-8 non-ASCII characters,\n"
1941 ";;; and so cannot be loaded into Emacs 22 or earlier.\n"
1942 ;; Have to check if emacs-version is bound so that this works
1943 ;; in files loaded early in loadup.el.
1944 "(and (boundp 'emacs-version)\n"
1945 ;; If there is a name at the end of emacs-version,
1946 ;; don't try to check the version number.
1947 " (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1948 (format " (string-lessp emacs-version \"%s\")\n" minimum-version)
1949 " (error \"`"
1950 ;; prin1-to-string is used to quote backslashes.
1951 (substring (prin1-to-string (file-name-nondirectory filename))
1952 1 -1)
1953 (format "' was compiled for Emacs %s or later\"))\n\n"
1954 minimum-version))
1955 ;; Now compensate for any change in size, to make sure all
1956 ;; positions in the file remain valid.
1957 (setq delta (- (point-max) old-header-end))
1958 (goto-char (point-max))
1959 (widen)
1960 (delete-char delta))))
1961
1962(defun byte-compile-insert-header (filename outbuffer)
1963 "Insert a header at the start of OUTBUFFER.
1964Call from the source buffer."
1965 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1966 (dynamic byte-compile-dynamic)
1967 (optimize byte-optimize))
1968 (with-current-buffer outbuffer
a5832373
RS
1969 (goto-char (point-min))
1970 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
430d2ee2 1971 ;; that is the file-format version number (18, 19, 20, or 23) as a
a5832373
RS
1972 ;; byte, followed by some nulls. The primary motivation for doing
1973 ;; this is to get some binary characters up in the first line of
1974 ;; the file so that `diff' will simply say "Binary files differ"
1975 ;; instead of actually doing a diff of two .elc files. An extra
1976 ;; benefit is that you can add this to /etc/magic:
a5832373
RS
1977 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1978 ;; >4 byte x version %d
775adc51
GM
1979 (insert
1980 ";ELC" 23 "\000\000\000\n"
1981 ";;; Compiled by "
1982 (or (and (boundp 'user-mail-address) user-mail-address)
1983 (concat (user-login-name) "@" (system-name)))
1984 " on " (current-time-string) "\n"
1985 ";;; from file " filename "\n"
5fa9d1ec
GM
1986 ";;; in Emacs version " emacs-version "\n"
1987 ";;; with"
775adc51
GM
1988 (cond
1989 ((eq optimize 'source) " source-level optimization only")
1990 ((eq optimize 'byte) " byte-level optimization only")
1991 (optimize " all optimizations")
1992 (t "out optimization"))
1993 ".\n"
1994 (if dynamic ";;; Function definitions are lazy-loaded.\n"
1995 "")
1996 "\n;;; This file uses "
1997 (if dynamic-docstrings
1998 "dynamic docstrings, first added in Emacs 19.29"
1999 "opcodes that do not exist in Emacs 18")
2000 ".\n\n"
2001 ;; Note that byte-compile-fix-header may change this.
2002 ";;; This file does not contain utf-8 non-ASCII characters,\n"
2003 ";;; and so can be loaded in Emacs versions earlier than 23.\n\n"
2004 ;; Insert semicolons as ballast, so that byte-compile-fix-header
2005 ;; can delete them so as to keep the buffer positions
2006 ;; constant for the actual compiled code.
2007 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n"
2008 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))))
1c393159
JB
2009
2010(defun byte-compile-output-file-form (form)
2011 ;; writes the given form to the output buffer, being careful of docstrings
1e857121 2012 ;; in defun, defmacro, defvar, defvaralias, defconst, autoload and
36b7e523 2013 ;; custom-declare-variable because make-docfile is so amazingly stupid.
c36881cf
ER
2014 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
2015 ;; it does not pay to first build the defalias in defmumble and then parse
2016 ;; it here.
876c194c
SM
2017 (if (and (memq (car-safe form) '(defun defmacro defvar defvaralias defconst
2018 autoload custom-declare-variable))
1c393159 2019 (stringp (nth 3 form)))
d82e848c 2020 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
36b7e523 2021 (memq (car form)
1e857121
YM
2022 '(defvaralias autoload
2023 custom-declare-variable)))
1c393159 2024 (let ((print-escape-newlines t)
37c29340
KH
2025 (print-length nil)
2026 (print-level nil)
77308fd7 2027 (print-quoted t)
5e51de79 2028 (print-gensym t)
0e66b003
KH
2029 (print-circle ; handle circular data structures
2030 (not byte-compile-disable-print-circle)))
7200d79c
SM
2031 (princ "\n" byte-compile--outbuffer)
2032 (prin1 form byte-compile--outbuffer)
1c393159
JB
2033 nil)))
2034
6c2161c4 2035(defvar print-gensym-alist) ;Used before print-circle existed.
2ec42da9 2036(defvar byte-compile--for-effect)
6c2161c4 2037
d82e848c 2038(defun byte-compile-output-docform (preface name info form specindex quoted)
dac6f673
RS
2039 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2040If PREFACE and NAME are non-nil, print them too,
2041before INFO and the FORM but after the doc string itself.
2042If SPECINDEX is non-nil, it is the index in FORM
2043of the function bytecode string. In that case,
2b9c3b12
JB
2044we output that argument and the following argument
2045\(the constants vector) together, for lazy loading.
dac6f673
RS
2046QUOTED says that we have to put a quote before the
2047list that represents a doc string reference.
1e857121 2048`defvaralias', `autoload' and `custom-declare-variable' need that."
dac6f673
RS
2049 ;; We need to examine byte-compile-dynamic-docstrings
2050 ;; in the input buffer (now current), not in the output buffer.
2051 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
7200d79c 2052 (with-current-buffer byte-compile--outbuffer
9ec5dfe6
SM
2053 (let (position)
2054
2055 ;; Insert the doc string, and make it a comment with #@LENGTH.
2056 (and (>= (nth 1 info) 0)
2057 dynamic-docstrings
9ec5dfe6
SM
2058 (progn
2059 ;; Make the doc string start at beginning of line
2060 ;; for make-docfile's sake.
2061 (insert "\n")
2062 (setq position
2063 (byte-compile-output-as-comment
2064 (nth (nth 1 info) form) nil))
2065 (setq position (- (position-bytes position) (point-min) -1))
2066 ;; If the doc string starts with * (a user variable),
2067 ;; negate POSITION.
2068 (if (and (stringp (nth (nth 1 info) form))
2069 (> (length (nth (nth 1 info) form)) 0)
2070 (eq (aref (nth (nth 1 info) form) 0) ?*))
2071 (setq position (- position)))))
2072
2073 (if preface
2074 (progn
2075 (insert preface)
7200d79c 2076 (prin1 name byte-compile--outbuffer)))
9ec5dfe6
SM
2077 (insert (car info))
2078 (let ((print-escape-newlines t)
2079 (print-quoted t)
2080 ;; For compatibility with code before print-circle,
2081 ;; use a cons cell to say that we want
2082 ;; print-gensym-alist not to be cleared
2083 ;; between calls to print functions.
2084 (print-gensym '(t))
2085 (print-circle ; handle circular data structures
2086 (not byte-compile-disable-print-circle))
2087 print-gensym-alist ; was used before print-circle existed.
2088 (print-continuous-numbering t)
2089 print-number-table
2090 (index 0))
7200d79c 2091 (prin1 (car form) byte-compile--outbuffer)
9ec5dfe6
SM
2092 (while (setq form (cdr form))
2093 (setq index (1+ index))
2094 (insert " ")
2095 (cond ((and (numberp specindex) (= index specindex)
2096 ;; Don't handle the definition dynamically
2097 ;; if it refers (or might refer)
2098 ;; to objects already output
2099 ;; (for instance, gensyms in the arg list).
2100 (let (non-nil)
17870c01 2101 (when (hash-table-p print-number-table)
9ace101c 2102 (maphash (lambda (_k v) (if v (setq non-nil t)))
17870c01 2103 print-number-table))
9ec5dfe6
SM
2104 (not non-nil)))
2105 ;; Output the byte code and constants specially
2106 ;; for lazy dynamic loading.
2107 (let ((position
2108 (byte-compile-output-as-comment
2109 (cons (car form) (nth 1 form))
2110 t)))
2ec42da9
SM
2111 (setq position (- (position-bytes position)
2112 (point-min) -1))
2113 (princ (format "(#$ . %d) nil" position)
7200d79c 2114 byte-compile--outbuffer)
9ec5dfe6
SM
2115 (setq form (cdr form))
2116 (setq index (1+ index))))
2117 ((= index (nth 1 info))
2118 (if position
2119 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2120 position)
7200d79c 2121 byte-compile--outbuffer)
9ec5dfe6
SM
2122 (let ((print-escape-newlines nil))
2123 (goto-char (prog1 (1+ (point))
7200d79c
SM
2124 (prin1 (car form)
2125 byte-compile--outbuffer)))
9ec5dfe6
SM
2126 (insert "\\\n")
2127 (goto-char (point-max)))))
2128 (t
7200d79c 2129 (prin1 (car form) byte-compile--outbuffer)))))
9ec5dfe6 2130 (insert (nth 2 info)))))
1c393159
JB
2131 nil)
2132
ca105506 2133(defun byte-compile-keep-pending (form &optional handler)
1c393159
JB
2134 (if (memq byte-optimize '(t source))
2135 (setq form (byte-optimize-form form t)))
ca105506 2136 (if handler
2ec42da9 2137 (let ((byte-compile--for-effect t))
1c393159
JB
2138 ;; To avoid consing up monstrously large forms at load time, we split
2139 ;; the output regularly.
b4ff4a23
RS
2140 (and (memq (car-safe form) '(fset defalias))
2141 (nthcdr 300 byte-compile-output)
1c393159 2142 (byte-compile-flush-pending))
ca105506 2143 (funcall handler form)
2ec42da9 2144 (if byte-compile--for-effect
1c393159
JB
2145 (byte-compile-discard)))
2146 (byte-compile-form form t))
2147 nil)
2148
2149(defun byte-compile-flush-pending ()
2150 (if byte-compile-output
2151 (let ((form (byte-compile-out-toplevel t 'file)))
2152 (cond ((eq (car-safe form) 'progn)
ed62683d 2153 (mapc 'byte-compile-output-file-form (cdr form)))
1c393159
JB
2154 (form
2155 (byte-compile-output-file-form form)))
2156 (setq byte-compile-constants nil
2157 byte-compile-variables nil
2158 byte-compile-depth 0
2159 byte-compile-maxdepth 0
2160 byte-compile-output nil))))
2161
2ec42da9
SM
2162(defun byte-compile-preprocess (form &optional _for-effect)
2163 (setq form (macroexpand-all form byte-compile-macro-environment))
2164 ;; FIXME: We should run byte-optimize-form here, but it currently does not
2165 ;; recurse through all the code, so we'd have to fix this first.
2166 ;; Maybe a good fix would be to merge byte-optimize-form into
2167 ;; macroexpand-all.
2168 ;; (if (memq byte-optimize '(t source))
2169 ;; (setq form (byte-optimize-form form for-effect)))
2170 (if lexical-binding
2171 (cconv-closure-convert form)
2172 form))
2173
876c194c
SM
2174;; byte-hunk-handlers cannot call this!
2175(defun byte-compile-toplevel-file-form (form)
2176 (let ((byte-compile-current-form nil)) ; close over this for warnings.
2ec42da9 2177 (byte-compile-file-form (byte-compile-preprocess form t))))
876c194c
SM
2178
2179;; byte-hunk-handlers can call this.
1c393159 2180(defun byte-compile-file-form (form)
ca105506 2181 (let (handler)
a9de04fa
SM
2182 (cond ((and (consp form)
2183 (symbolp (car form))
ca105506
SM
2184 (setq handler (get (car form) 'byte-hunk-handler)))
2185 (cond ((setq form (funcall handler form))
b9598260
SM
2186 (byte-compile-flush-pending)
2187 (byte-compile-output-file-form form))))
2188 (t
2189 (byte-compile-keep-pending form)))))
1c393159
JB
2190
2191;; Functions and variables with doc strings must be output separately,
2192;; so make-docfile can recognise them. Most other things can be output
2193;; as byte-code.
2194
1c393159
JB
2195(put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2196(defun byte-compile-file-form-autoload (form)
2197 (and (let ((form form))
2198 (while (if (setq form (cdr form)) (byte-compile-constp (car form))))
2199 (null form)) ;Constants only
2200 (eval (nth 5 form)) ;Macro
2201 (eval form)) ;Define the autoload.
c5091f25 2202 ;; Avoid undefined function warnings for the autoload.
cb4fb1d0 2203 (when (and (consp (nth 1 form))
c5091f25
DL
2204 (eq (car (nth 1 form)) 'quote)
2205 (consp (cdr (nth 1 form)))
2206 (symbolp (nth 1 (nth 1 form))))
cb4fb1d0
GM
2207 (push (cons (nth 1 (nth 1 form))
2208 (cons 'autoload (cdr (cdr form))))
2209 byte-compile-function-environment)
2210 ;; If an autoload occurs _before_ the first call to a function,
2211 ;; byte-compile-callargs-warn does not add an entry to
2212 ;; byte-compile-unresolved-functions. Here we mimic the logic
2213 ;; of byte-compile-callargs-warn so as not to warn if the
2214 ;; autoload comes _after_ the function call.
2215 ;; Alternatively, similar logic could go in
2216 ;; byte-compile-warn-about-unresolved-functions.
2217 (or (memq (nth 1 (nth 1 form)) byte-compile-noruntime-functions)
2218 (setq byte-compile-unresolved-functions
2219 (delq (assq (nth 1 (nth 1 form))
2220 byte-compile-unresolved-functions)
2221 byte-compile-unresolved-functions))))
1c393159
JB
2222 (if (stringp (nth 3 form))
2223 form
2224 ;; No doc string, so we can compile this as a normal form.
2225 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2226
2227(put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2228(put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2229(defun byte-compile-file-form-defvar (form)
2230 (if (null (nth 3 form))
2231 ;; Since there is no doc string, we can compile this as a normal form,
2232 ;; and not do a file-boundary.
2233 (byte-compile-keep-pending form)
4f1e9960 2234 (when (and (symbolp (nth 1 form))
3fe6ef4e 2235 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
4f1e9960 2236 (byte-compile-warning-enabled-p 'lexical))
7a16788b 2237 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
4f1e9960 2238 (nth 1 form)))
2aea6521
GM
2239 (push (nth 1 form) byte-compile-bound-variables)
2240 (if (eq (car form) 'defconst)
2241 (push (nth 1 form) byte-compile-const-variables))
1c393159
JB
2242 (cond ((consp (nth 2 form))
2243 (setq form (copy-sequence form))
2244 (setcar (cdr (cdr form))
2245 (byte-compile-top-level (nth 2 form) nil 'file))))
2246 form))
2247
2ec42da9
SM
2248(put 'define-abbrev-table 'byte-hunk-handler
2249 'byte-compile-file-form-define-abbrev-table)
b7c76a30 2250(defun byte-compile-file-form-define-abbrev-table (form)
2aea6521
GM
2251 (if (eq 'quote (car-safe (car-safe (cdr form))))
2252 (push (car-safe (cdr (cadr form))) byte-compile-bound-variables))
b7c76a30
SM
2253 (byte-compile-keep-pending form))
2254
8c731d3d
RS
2255(put 'custom-declare-variable 'byte-hunk-handler
2256 'byte-compile-file-form-custom-declare-variable)
2257(defun byte-compile-file-form-custom-declare-variable (form)
cf637a34 2258 (when (byte-compile-warning-enabled-p 'callargs)
fe33e7c8 2259 (byte-compile-nogroup-warn form))
2aea6521 2260 (push (nth 1 (nth 1 form)) byte-compile-bound-variables)
2546bcdd
SM
2261 ;; Don't compile the expression because it may be displayed to the user.
2262 ;; (when (eq (car-safe (nth 2 form)) 'quote)
2263 ;; ;; (nth 2 form) is meant to evaluate to an expression, so if we have the
2264 ;; ;; final value already, we can byte-compile it.
2265 ;; (setcar (cdr (nth 2 form))
2266 ;; (byte-compile-top-level (cadr (nth 2 form)) nil 'file)))
347a36bc
RS
2267 (let ((tail (nthcdr 4 form)))
2268 (while tail
2546bcdd
SM
2269 (unless (keywordp (car tail)) ;No point optimizing keywords.
2270 ;; Compile the keyword arguments.
2271 (setcar tail (byte-compile-top-level (car tail) nil 'file)))
347a36bc 2272 (setq tail (cdr tail))))
8c731d3d
RS
2273 form)
2274
997011eb
RS
2275(put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2276(defun byte-compile-file-form-require (form)
3f12e5bd
GM
2277 (let ((args (mapcar 'eval (cdr form)))
2278 (hist-orig load-history)
2279 hist-new)
997011eb 2280 (apply 'require args)
3f12e5bd
GM
2281 (when (byte-compile-warning-enabled-p 'cl-functions)
2282 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2283 (if (member (car args) '("cl" cl))
2284 (progn
2285 (byte-compile-warn "cl package required at runtime")
2286 (byte-compile-disable-warning 'cl-functions))
2287 ;; We may have required something that causes cl to be loaded, eg
2288 ;; the uncompiled version of a file that requires cl when compiling.
2289 (setq hist-new load-history)
2290 (while (and (not byte-compile-cl-functions)
2291 hist-new (not (eq hist-new hist-orig)))
2292 (and (byte-compile-cl-file-p (car (pop hist-new)))
2293 (byte-compile-find-cl-functions))))))
1c393159
JB
2294 (byte-compile-keep-pending form 'byte-compile-normal-call))
2295
2296(put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2297(put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2298(put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2299(defun byte-compile-file-form-progn (form)
ed62683d 2300 (mapc 'byte-compile-file-form (cdr form))
1c393159
JB
2301 ;; Return nil so the forms are not output twice.
2302 nil)
2303
cb4fb1d0
GM
2304(put 'with-no-warnings 'byte-hunk-handler
2305 'byte-compile-file-form-with-no-warnings)
2306(defun byte-compile-file-form-with-no-warnings (form)
2307 ;; cf byte-compile-file-form-progn.
2308 (let (byte-compile-warnings)
2309 (mapc 'byte-compile-file-form (cdr form))
2310 nil))
2311
1c393159
JB
2312;; This handler is not necessary, but it makes the output from dont-compile
2313;; and similar macros cleaner.
2314(put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2315(defun byte-compile-file-form-eval (form)
2316 (if (eq (car-safe (nth 1 form)) 'quote)
2317 (nth 1 (nth 1 form))
2318 (byte-compile-keep-pending form)))
2319
2320(put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun)
2321(defun byte-compile-file-form-defun (form)
2322 (byte-compile-file-form-defmumble form nil))
2323
2324(put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro)
2325(defun byte-compile-file-form-defmacro (form)
2326 (byte-compile-file-form-defmumble form t))
2327
e3a6b82f
SM
2328(defun byte-compile-defmacro-declaration (form)
2329 "Generate code for declarations in macro definitions.
2330Remove declarations from the body of the macro definition
2331by side-effects."
2332 (let ((tail (nthcdr 2 form))
2333 (res '()))
2334 (when (stringp (car (cdr tail)))
2335 (setq tail (cdr tail)))
2336 (while (and (consp (car (cdr tail)))
2337 (eq (car (car (cdr tail))) 'declare))
2338 (let ((declaration (car (cdr tail))))
2339 (setcdr tail (cdr (cdr tail)))
2340 (push `(if macro-declaration-function
2341 (funcall macro-declaration-function
2342 ',(car (cdr form)) ',declaration))
2343 res)))
2344 res))
2345
1c393159 2346(defun byte-compile-file-form-defmumble (form macrop)
ca105506
SM
2347 (let* ((name (car (cdr form)))
2348 (this-kind (if macrop 'byte-compile-macro-environment
1c393159 2349 'byte-compile-function-environment))
ca105506 2350 (that-kind (if macrop 'byte-compile-function-environment
1c393159 2351 'byte-compile-macro-environment))
ca105506
SM
2352 (this-one (assq name (symbol-value this-kind)))
2353 (that-one (assq name (symbol-value that-kind)))
1c393159
JB
2354 (byte-compile-free-references nil)
2355 (byte-compile-free-assignments nil))
ca105506 2356 (byte-compile-set-symbol-position name)
1c393159
JB
2357 ;; When a function or macro is defined, add it to the call tree so that
2358 ;; we can tell when functions are not used.
2359 (if byte-compile-generate-call-tree
ca105506 2360 (or (assq name byte-compile-call-tree)
1c393159 2361 (setq byte-compile-call-tree
ca105506 2362 (cons (list name nil nil) byte-compile-call-tree))))
1c393159 2363
ca105506 2364 (setq byte-compile-current-form name) ; for warnings
cf637a34 2365 (if (byte-compile-warning-enabled-p 'redefine)
1c393159
JB
2366 (byte-compile-arglist-warn form macrop))
2367 (if byte-compile-verbose
9ace101c
SM
2368 (message "Compiling %s... (%s)"
2369 (or byte-compile-current-file "") (nth 1 form)))
ca105506 2370 (cond (that-one
cf637a34 2371 (if (and (byte-compile-warning-enabled-p 'redefine)
52799cb8 2372 ;; don't warn when compiling the stubs in byte-run...
1c393159
JB
2373 (not (assq (nth 1 form)
2374 byte-compile-initial-macro-environment)))
2375 (byte-compile-warn
29a4dcb0
SM
2376 "`%s' defined multiple times, as both function and macro"
2377 (nth 1 form)))
ca105506
SM
2378 (setcdr that-one nil))
2379 (this-one
cf637a34 2380 (when (and (byte-compile-warning-enabled-p 'redefine)
29a4dcb0
SM
2381 ;; hack: don't warn when compiling the magic internal
2382 ;; byte-compiler macros in byte-run.el...
2383 (not (assq (nth 1 form)
2384 byte-compile-initial-macro-environment)))
1d5c17c0 2385 (byte-compile-warn "%s `%s' defined multiple times in this file"
ccb3c8de
CW
2386 (if macrop "macro" "function")
2387 (nth 1 form))))
ca105506
SM
2388 ((and (fboundp name)
2389 (eq (car-safe (symbol-function name))
1c393159 2390 (if macrop 'lambda 'macro)))
cf637a34 2391 (when (byte-compile-warning-enabled-p 'redefine)
1d5c17c0 2392 (byte-compile-warn "%s `%s' being redefined as a %s"
ccb3c8de
CW
2393 (if macrop "function" "macro")
2394 (nth 1 form)
2395 (if macrop "macro" "function")))
1c393159 2396 ;; shadow existing definition
ca105506
SM
2397 (set this-kind
2398 (cons (cons name nil)
2399 (symbol-value this-kind))))
1c393159
JB
2400 )
2401 (let ((body (nthcdr 3 form)))
ccb3c8de
CW
2402 (when (and (stringp (car body))
2403 (symbolp (car-safe (cdr-safe body)))
2404 (car-safe (cdr-safe body))
2405 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2406 (byte-compile-set-symbol-position (nth 1 form))
2407 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2408 (nth 1 form))))
6b8c2efc 2409
985b4686
GM
2410 ;; Generate code for declarations in macro definitions.
2411 ;; Remove declarations from the body of the macro definition.
2412 (when macrop
e3a6b82f 2413 (dolist (decl (byte-compile-defmacro-declaration form))
7200d79c 2414 (prin1 decl byte-compile--outbuffer)))
6b8c2efc 2415
29a4dcb0 2416 (let* ((code (byte-compile-lambda (nthcdr 2 form) t)))
ca105506 2417 (if this-one
29a4dcb0 2418 (setcdr this-one code)
ca105506 2419 (set this-kind
29a4dcb0 2420 (cons (cons name code)
ca105506 2421 (symbol-value this-kind))))
29a4dcb0
SM
2422 (byte-compile-flush-pending)
2423 (if (not (stringp (nth 3 form)))
2424 ;; No doc string. Provide -1 as the "doc string index"
2425 ;; so that no element will be treated as a doc string.
2426 (byte-compile-output-docform
2427 "\n(defalias '"
2428 name
2429 (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]"))
2430 (append code nil) ; Turn byte-code-function-p into list.
2431 (and (atom code) byte-compile-dynamic
2432 1)
2433 nil)
2434 ;; Output the form by hand, that's much simpler than having
2435 ;; b-c-output-file-form analyze the defalias.
2436 (byte-compile-output-docform
2437 "\n(defalias '"
2438 name
2439 (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]"))
2440 (append code nil) ; Turn byte-code-function-p into list.
2441 (and (atom code) byte-compile-dynamic
2442 1)
2443 nil))
7200d79c 2444 (princ ")" byte-compile--outbuffer)
29a4dcb0 2445 nil)))
d82e848c
RS
2446
2447;; Print Lisp object EXP in the output file, inside a comment,
2448;; and return the file position it will have.
2449;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2450(defun byte-compile-output-as-comment (exp quoted)
2d5975fa 2451 (let ((position (point)))
7200d79c 2452 (with-current-buffer byte-compile--outbuffer
9ec5dfe6
SM
2453
2454 ;; Insert EXP, and make it a comment with #@LENGTH.
2455 (insert " ")
2456 (if quoted
7200d79c
SM
2457 (prin1 exp byte-compile--outbuffer)
2458 (princ exp byte-compile--outbuffer))
9ec5dfe6
SM
2459 (goto-char position)
2460 ;; Quote certain special characters as needed.
2461 ;; get_doc_string in doc.c does the unquoting.
2462 (while (search-forward "\^A" nil t)
2463 (replace-match "\^A\^A" t t))
2464 (goto-char position)
2465 (while (search-forward "\000" nil t)
2466 (replace-match "\^A0" t t))
2467 (goto-char position)
2468 (while (search-forward "\037" nil t)
2469 (replace-match "\^A_" t t))
2470 (goto-char (point-max))
2471 (insert "\037")
2472 (goto-char position)
2473 (insert "#@" (format "%d" (- (position-bytes (point-max))
2474 (position-bytes position))))
2475
2476 ;; Save the file position of the object.
2477 ;; Note we should add 1 to skip the space
2478 ;; that we inserted before the actual doc string,
2479 ;; and subtract 1 to convert from an 1-origin Emacs position
2480 ;; to a file position; they cancel.
2481 (setq position (point))
2482 (goto-char (point-max)))
d82e848c
RS
2483 position))
2484
1c393159
JB
2485
2486\f
fd5285f3 2487;;;###autoload
1c393159
JB
2488(defun byte-compile (form)
2489 "If FORM is a symbol, byte-compile its function definition.
2490If FORM is a lambda or a macro, byte-compile it as a function."
2491 (displaying-byte-compile-warnings
2492 (byte-compile-close-variables
2493 (let* ((fun (if (symbolp form)
2494 (and (fboundp form) (symbol-function form))
2495 form))
2496 (macro (eq (car-safe fun) 'macro)))
2497 (if macro
2498 (setq fun (cdr fun)))
2499 (cond ((eq (car-safe fun) 'lambda)
3e21b6a7 2500 ;; Expand macros.
2ec42da9 2501 (setq fun (byte-compile-preprocess fun))
3e21b6a7 2502 ;; Get rid of the `function' quote added by the `lambda' macro.
876c194c 2503 (if (eq (car-safe fun) 'function) (setq fun (cadr fun)))
1c393159
JB
2504 (setq fun (if macro
2505 (cons 'macro (byte-compile-lambda fun))
2506 (byte-compile-lambda fun)))
2507 (if (symbolp form)
c36881cf 2508 (defalias form fun)
1c393159
JB
2509 fun)))))))
2510
2511(defun byte-compile-sexp (sexp)
2512 "Compile and return SEXP."
2513 (displaying-byte-compile-warnings
2514 (byte-compile-close-variables
2ec42da9 2515 (byte-compile-top-level (byte-compile-preprocess sexp)))))
1c393159 2516
eadd6444
GM
2517(defun byte-compile-check-lambda-list (list)
2518 "Check lambda-list LIST for errors."
2519 (let (vars)
2520 (while list
2521 (let ((arg (car list)))
ccb3c8de
CW
2522 (when (symbolp arg)
2523 (byte-compile-set-symbol-position arg))
1f006824 2524 (cond ((or (not (symbolp arg))
6c2161c4 2525 (byte-compile-const-symbol-p arg t))
eadd6444
GM
2526 (error "Invalid lambda variable %s" arg))
2527 ((eq arg '&rest)
2528 (unless (cdr list)
2529 (error "&rest without variable name"))
2530 (when (cddr list)
2531 (error "Garbage following &rest VAR in lambda-list")))
2532 ((eq arg '&optional)
2533 (unless (cdr list)
2534 (error "Variable name missing after &optional")))
2535 ((memq arg vars)
e34fd2f2 2536 (byte-compile-warn "repeated variable %s in lambda-list" arg))
1f006824 2537 (t
eadd6444
GM
2538 (push arg vars))))
2539 (setq list (cdr list)))))
2540
2541
ce5b520a
SM
2542(defun byte-compile-arglist-vars (arglist)
2543 "Return a list of the variables in the lambda argument list ARGLIST."
2544 (remq '&rest (remq '&optional arglist)))
2545
2546(defun byte-compile-make-lambda-lexenv (form)
2547 "Return a new lexical environment for a lambda expression FORM."
2548 ;; See if this is a closure or not
2549 (let ((args (byte-compile-arglist-vars (cadr form))))
2550 (let ((lexenv nil))
2551 ;; Fill in the initial stack contents
2552 (let ((stackpos 0))
2553 ;; Add entries for each argument
2554 (dolist (arg args)
2555 (push (cons arg stackpos) lexenv)
2556 (setq stackpos (1+ stackpos)))
2557 ;; Return the new lexical environment
2558 lexenv))))
b9598260 2559
e2abe5a1
SM
2560(defun byte-compile-make-args-desc (arglist)
2561 (let ((mandatory 0)
2562 nonrest (rest 0))
2563 (while (and arglist (not (memq (car arglist) '(&optional &rest))))
2564 (setq mandatory (1+ mandatory))
2565 (setq arglist (cdr arglist)))
2566 (setq nonrest mandatory)
2567 (when (eq (car arglist) '&optional)
2568 (setq arglist (cdr arglist))
2569 (while (and arglist (not (eq (car arglist) '&rest)))
2570 (setq nonrest (1+ nonrest))
2571 (setq arglist (cdr arglist))))
2572 (when arglist
2573 (setq rest 1))
2574 (if (> mandatory 127)
2575 (byte-compile-report-error "Too many (>127) mandatory arguments")
2576 (logior mandatory
2577 (lsh nonrest 8)
2578 (lsh rest 7)))))
2579
1c393159
JB
2580;; Byte-compile a lambda-expression and return a valid function.
2581;; The value is usually a compiled function but may be the original
2582;; lambda-expression.
4ec5239c
LH
2583;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2584;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2585;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2586;; for symbols generated by the byte compiler itself.
ca105506 2587(defun byte-compile-lambda (fun &optional add-lambda reserved-csts)
4ec5239c 2588 (if add-lambda
ca105506
SM
2589 (setq fun (cons 'lambda fun))
2590 (unless (eq 'lambda (car-safe fun))
2591 (error "Not a lambda list: %S" fun))
4ec5239c 2592 (byte-compile-set-symbol-position 'lambda))
ca105506
SM
2593 (byte-compile-check-lambda-list (nth 1 fun))
2594 (let* ((arglist (nth 1 fun))
1c393159 2595 (byte-compile-bound-variables
ce5b520a 2596 (append (and (not lexical-binding)
ca105506 2597 (byte-compile-arglist-vars arglist))
ce5b520a 2598 byte-compile-bound-variables))
ca105506
SM
2599 (body (cdr (cdr fun)))
2600 (doc (if (stringp (car body))
2601 (prog1 (car body)
2602 ;; Discard the doc string
2603 ;; unless it is the last element of the body.
2604 (if (cdr body)
2605 (setq body (cdr body))))))
2606 (int (assq 'interactive body)))
6c2161c4 2607 ;; Process the interactive spec.
ca105506 2608 (when int
6c2161c4
SM
2609 (byte-compile-set-symbol-position 'interactive)
2610 ;; Skip (interactive) if it is in front (the most usual location).
ca105506
SM
2611 (if (eq int (car body))
2612 (setq body (cdr body)))
2613 (cond ((consp (cdr int))
2614 (if (cdr (cdr int))
6c2161c4 2615 (byte-compile-warn "malformed interactive spec: %s"
ca105506 2616 (prin1-to-string int)))
6b61353c
KH
2617 ;; If the interactive spec is a call to `list', don't
2618 ;; compile it, because `call-interactively' looks at the
2619 ;; args of `list'. Actually, compile it to get warnings,
2620 ;; but don't use the result.
ca105506 2621 (let* ((form (nth 1 int))
d032d5e7 2622 (newform (byte-compile-top-level form)))
6c2161c4
SM
2623 (while (memq (car-safe form) '(let let* progn save-excursion))
2624 (while (consp (cdr form))
2625 (setq form (cdr form)))
2626 (setq form (car form)))
d032d5e7
SM
2627 (if (and (eq (car-safe form) 'list)
2628 ;; The spec is evaled in callint.c in dynamic-scoping
2629 ;; mode, so just leaving the form unchanged would mean
2630 ;; it won't be eval'd in the right mode.
2631 (not lexical-binding))
2632 nil
ca105506
SM
2633 (setq int `(interactive ,newform)))))
2634 ((cdr int)
6c2161c4 2635 (byte-compile-warn "malformed interactive spec: %s"
ca105506 2636 (prin1-to-string int)))))
6c2161c4 2637 ;; Process the body.
ba83908c 2638 (let ((compiled
ca105506 2639 (byte-compile-top-level (cons 'progn body) nil 'lambda
ba83908c
SM
2640 ;; If doing lexical binding, push a new
2641 ;; lexical environment containing just the
2642 ;; args (since lambda expressions should be
2643 ;; closed by now).
2644 (and lexical-binding
ca105506 2645 (byte-compile-make-lambda-lexenv fun))
ba83908c 2646 reserved-csts)))
6c2161c4 2647 ;; Build the actual byte-coded function.
e5c89ce9 2648 (if (eq 'byte-code (car-safe compiled))
ce5b520a 2649 (apply 'make-byte-code
e2abe5a1 2650 (if lexical-binding
ca105506
SM
2651 (byte-compile-make-args-desc arglist)
2652 arglist)
e2abe5a1
SM
2653 (append
2654 ;; byte-string, constants-vector, stack depth
2655 (cdr compiled)
2656 ;; optionally, the doc string.
2657 (cond (lexical-binding
2658 (require 'help-fns)
ca105506
SM
2659 (list (help-add-fundoc-usage doc arglist)))
2660 ((or doc int)
2661 (list doc)))
e2abe5a1 2662 ;; optionally, the interactive spec.
ca105506
SM
2663 (if int
2664 (list (nth 1 int)))))
29a4dcb0 2665 (error "byte-compile-top-level did not return byte-code")))))
b9598260 2666
876c194c 2667(defvar byte-compile-reserved-constants 0)
1c393159
JB
2668
2669(defun byte-compile-constants-vector ()
2670 ;; Builds the constants-vector from the current variables and constants.
2671 ;; This modifies the constants from (const . nil) to (const . offset).
2672 ;; To keep the byte-codes to look up the vector as short as possible:
2673 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2674 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2675 ;; Next variables again, to get 2-byte codes for variable lookup.
2676 ;; The rest of the constants and variables need 3-byte byte-codes.
876c194c 2677 (let* ((i (1- byte-compile-reserved-constants))
1c393159
JB
2678 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2679 (other (nreverse byte-compile-constants)) ; vars often are used most.
2680 ret tmp
2681 (limits '(5 ; Use the 1-byte varref codes,
2682 63 ; 1-constlim ; 1-byte byte-constant codes,
2683 255 ; 2-byte varref codes,
2684 65535)) ; 3-byte codes for the rest.
2685 limit)
2686 (while (or rest other)
2687 (setq limit (car limits))
876c194c
SM
2688 (while (and rest (< i limit))
2689 (cond
2690 ((numberp (car rest))
2691 (assert (< (car rest) byte-compile-reserved-constants)))
2692 ((setq tmp (assq (car (car rest)) ret))
2693 (setcdr (car rest) (cdr tmp)))
2694 (t
1c393159 2695 (setcdr (car rest) (setq i (1+ i)))
876c194c 2696 (setq ret (cons (car rest) ret))))
1c393159
JB
2697 (setq rest (cdr rest)))
2698 (setq limits (cdr limits)
2699 rest (prog1 other
2700 (setq other rest))))
2701 (apply 'vector (nreverse (mapcar 'car ret)))))
2702
2703;; Given an expression FORM, compile it and return an equivalent byte-code
2704;; expression (a call to the function byte-code).
2ec42da9 2705(defun byte-compile-top-level (form &optional for-effect output-type
876c194c 2706 lexenv reserved-csts)
1c393159
JB
2707 ;; OUTPUT-TYPE advises about how form is expected to be used:
2708 ;; 'eval or nil -> a single form,
2709 ;; 'progn or t -> a list of forms,
2710 ;; 'lambda -> body of a lambda,
2711 ;; 'file -> used at file-level.
2ec42da9 2712 (let ((byte-compile--for-effect for-effect)
9ace101c 2713 (byte-compile-constants nil)
285cdf4e
RS
2714 (byte-compile-variables nil)
2715 (byte-compile-tag-number 0)
2716 (byte-compile-depth 0)
2717 (byte-compile-maxdepth 0)
7200d79c 2718 (byte-compile--lexical-environment lexenv)
876c194c 2719 (byte-compile-reserved-constants (or reserved-csts 0))
285cdf4e 2720 (byte-compile-output nil))
b9598260 2721 (if (memq byte-optimize '(t source))
2ec42da9 2722 (setq form (byte-optimize-form form byte-compile--for-effect)))
b9598260
SM
2723 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2724 (setq form (nth 1 form)))
29a4dcb0
SM
2725 ;; Set up things for a lexically-bound function.
2726 (when (and lexical-binding (eq output-type 'lambda))
2727 ;; See how many arguments there are, and set the current stack depth
2728 ;; accordingly.
7200d79c 2729 (setq byte-compile-depth (length byte-compile--lexical-environment))
29a4dcb0
SM
2730 ;; If there are args, output a tag to record the initial
2731 ;; stack-depth for the optimizer.
2732 (when (> byte-compile-depth 0)
2733 (byte-compile-out-tag (byte-compile-make-tag))))
2734 ;; Now compile FORM
2735 (byte-compile-form form byte-compile--for-effect)
2736 (byte-compile-out-toplevel byte-compile--for-effect output-type)))
1c393159
JB
2737
2738(defun byte-compile-out-toplevel (&optional for-effect output-type)
2739 (if for-effect
2740 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2741 (if (eq (car (car byte-compile-output)) 'byte-discard)
2742 (setq byte-compile-output (cdr byte-compile-output))
2743 (byte-compile-push-constant
2744 ;; Push any constant - preferably one which already is used, and
2745 ;; a number or symbol - ie not some big sequence. The return value
2746 ;; isn't returned, but it would be a shame if some textually large
2747 ;; constant was not optimized away because we chose to return it.
2748 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2749 (let ((tmp (reverse byte-compile-constants)))
ba76e7fa
SM
2750 (while (and tmp (not (or (symbolp (caar tmp))
2751 (numberp (caar tmp)))))
1c393159 2752 (setq tmp (cdr tmp)))
ba76e7fa 2753 (caar tmp))))))
1c393159
JB
2754 (byte-compile-out 'byte-return 0)
2755 (setq byte-compile-output (nreverse byte-compile-output))
2756 (if (memq byte-optimize '(t byte))
2757 (setq byte-compile-output
9ace101c 2758 (byte-optimize-lapcode byte-compile-output)))
1f006824 2759
1c393159
JB
2760 ;; Decompile trivial functions:
2761 ;; only constants and variables, or a single funcall except in lambdas.
2762 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2763 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2764 ;; Note that even (quote foo) must be parsed just as any subr by the
2765 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2766 ;; What to leave uncompiled:
69dc83fd
KH
2767 ;; lambda -> never. we used to leave it uncompiled if the body was
2768 ;; a single atom, but that causes confusion if the docstring
2769 ;; uses the (file . pos) syntax. Besides, now that we have
2770 ;; the Lisp_Compiled type, the compiled form is faster.
1c393159
JB
2771 ;; eval -> atom, quote or (function atom atom atom)
2772 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2773 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2774 (let (rest
2775 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2776 tmp body)
2777 (cond
2778 ;; #### This should be split out into byte-compile-nontrivial-function-p.
69dc83fd
KH
2779 ((or (eq output-type 'lambda)
2780 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
1c393159
JB
2781 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2782 (not (setq tmp (assq 'byte-return byte-compile-output)))
2783 (progn
2784 (setq rest (nreverse
2785 (cdr (memq tmp (reverse byte-compile-output)))))
2ec42da9
SM
2786 (while
2787 (cond
2788 ((memq (car (car rest)) '(byte-varref byte-constant))
2789 (setq tmp (car (cdr (car rest))))
2790 (if (if (eq (car (car rest)) 'byte-constant)
2791 (or (consp tmp)
2792 (and (symbolp tmp)
2793 (not (byte-compile-const-symbol-p tmp)))))
2794 (if maycall
2795 (setq body (cons (list 'quote tmp) body)))
2796 (setq body (cons tmp body))))
2797 ((and maycall
2798 ;; Allow a funcall if at most one atom follows it.
2799 (null (nthcdr 3 rest))
2800 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2801 (or (null (cdr rest))
2802 (and (memq output-type '(file progn t))
2803 (cdr (cdr rest))
2804 (eq (car (nth 1 rest)) 'byte-discard)
2805 (progn (setq rest (cdr rest)) t))))
2806 (setq maycall nil) ; Only allow one real function call.
2807 (setq body (nreverse body))
2808 (setq body (list
2809 (if (and (eq tmp 'funcall)
2810 (eq (car-safe (car body)) 'quote))
2811 (cons (nth 1 (car body)) (cdr body))
2812 (cons tmp body))))
2813 (or (eq output-type 'file)
2814 (not (delq nil (mapcar 'consp (cdr (car body))))))))
1c393159 2815 (setq rest (cdr rest)))
69dc83fd 2816 rest))
1c393159
JB
2817 (let ((byte-compile-vector (byte-compile-constants-vector)))
2818 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2819 byte-compile-vector byte-compile-maxdepth)))
2820 ;; it's a trivial function
2821 ((cdr body) (cons 'progn (nreverse body)))
2822 ((car body)))))
2823
ca105506
SM
2824;; Given BODY, compile it and return a new body.
2825(defun byte-compile-top-level-body (body &optional for-effect)
2826 (setq body
2827 (byte-compile-top-level (cons 'progn body) for-effect t))
2828 (cond ((eq (car-safe body) 'progn)
2829 (cdr body))
2830 (body
2831 (list body))))
d97362d7 2832
a9de04fa
SM
2833;; Special macro-expander used during byte-compilation.
2834(defun byte-compile-macroexpand-declare-function (fn file &rest args)
2835 (push (cons fn
2836 (if (and (consp args) (listp (car args)))
2837 (list 'declared (car args))
7628b337 2838 t)) ; arglist not specified
d97362d7 2839 byte-compile-function-environment)
a342aca4
GM
2840 ;; We are stating that it _will_ be defined at runtime.
2841 (setq byte-compile-noruntime-functions
a9de04fa
SM
2842 (delq fn byte-compile-noruntime-functions))
2843 ;; Delegate the rest to the normal macro definition.
2844 (macroexpand `(declare-function ,fn ,file ,@args)))
d97362d7 2845
1c393159 2846\f
c5091f25 2847;; This is the recursive entry point for compiling each subform of an
1c393159
JB
2848;; expression.
2849;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2850;; before terminating (ie no value will be left on the stack).
2ec42da9
SM
2851;; A byte-compile handler may, when byte-compile--for-effect is non-nil, choose
2852;; output code which does not leave a value on the stack, and then set
2853;; byte-compile--for-effect to nil (to prevent byte-compile-form from
2854;; outputting the byte-discard).
1c393159 2855;; If a handler wants to call another handler, it should do so via
2ec42da9
SM
2856;; byte-compile-form, or take extreme care to handle byte-compile--for-effect
2857;; correctly. (Use byte-compile-form-do-effect to reset the
2858;; byte-compile--for-effect flag too.)
1c393159
JB
2859;;
2860(defun byte-compile-form (form &optional for-effect)
2ec42da9 2861 (let ((byte-compile--for-effect for-effect))
9ace101c
SM
2862 (cond
2863 ((not (consp form))
2864 (cond ((or (not (symbolp form)) (byte-compile-const-symbol-p form))
2865 (when (symbolp form)
2866 (byte-compile-set-symbol-position form))
2867 (byte-compile-constant form))
2ec42da9 2868 ((and byte-compile--for-effect byte-compile-delete-errors)
9ace101c
SM
2869 (when (symbolp form)
2870 (byte-compile-set-symbol-position form))
2ec42da9 2871 (setq byte-compile--for-effect nil))
9ace101c
SM
2872 (t
2873 (byte-compile-variable-ref form))))
2874 ((symbolp (car form))
ca105506
SM
2875 (let* ((fn (car form))
2876 (handler (get fn 'byte-compile)))
2877 (when (byte-compile-const-symbol-p fn)
2878 (byte-compile-warn "`%s' called as a function" fn))
9ace101c 2879 (and (byte-compile-warning-enabled-p 'interactive-only)
ca105506 2880 (memq fn byte-compile-interactive-only-functions)
9ace101c 2881 (byte-compile-warn "`%s' used from Lisp code\n\
ca105506 2882That command is designed for interactive use only" fn))
9ace101c
SM
2883 (if (and (fboundp (car form))
2884 (eq (car-safe (symbol-function (car form))) 'macro))
2885 (byte-compile-report-error
2886 (format "Forgot to expand macro %s" (car form))))
ca105506 2887 (if (and handler
9ace101c
SM
2888 ;; Make sure that function exists. This is important
2889 ;; for CL compiler macros since the symbol may be
2890 ;; `cl-byte-compile-compiler-macro' but if CL isn't
2891 ;; loaded, this function doesn't exist.
ca105506 2892 (and (not (eq handler
9ace101c
SM
2893 ;; Already handled by macroexpand-all.
2894 'cl-byte-compile-compiler-macro))
ca105506
SM
2895 (functionp handler)))
2896 (funcall handler form)
9ace101c
SM
2897 (byte-compile-normal-call form))
2898 (if (byte-compile-warning-enabled-p 'cl-functions)
2899 (byte-compile-cl-warn form))))
29a4dcb0
SM
2900 ((and (byte-code-function-p (car form))
2901 (memq byte-optimize '(t lap)))
2902 (byte-compile-unfold-bcf form))
2903 ((and (eq (car-safe (car form)) 'lambda)
9ace101c
SM
2904 ;; if the form comes out the same way it went in, that's
2905 ;; because it was malformed, and we couldn't unfold it.
2906 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2ec42da9
SM
2907 (byte-compile-form form byte-compile--for-effect)
2908 (setq byte-compile--for-effect nil))
9ace101c 2909 ((byte-compile-normal-call form)))
2ec42da9 2910 (if byte-compile--for-effect
9ace101c 2911 (byte-compile-discard))))
1c393159
JB
2912
2913(defun byte-compile-normal-call (form)
876c194c
SM
2914 (when (and (byte-compile-warning-enabled-p 'callargs)
2915 (symbolp (car form)))
2916 (if (memq (car form)
03408648
SM
2917 '(custom-declare-group custom-declare-variable
2918 custom-declare-face))
876c194c 2919 (byte-compile-nogroup-warn form))
a9de04fa
SM
2920 (when (get (car form) 'byte-obsolete-info)
2921 (byte-compile-warn-obsolete (car form)))
876c194c 2922 (byte-compile-callargs-warn form))
1c393159
JB
2923 (if byte-compile-generate-call-tree
2924 (byte-compile-annotate-call-tree form))
2ec42da9 2925 (when (and byte-compile--for-effect (eq (car form) 'mapcar)
cf637a34 2926 (byte-compile-warning-enabled-p 'mapcar))
89c91fdb
GM
2927 (byte-compile-set-symbol-position 'mapcar)
2928 (byte-compile-warn
2929 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
1c393159 2930 (byte-compile-push-constant (car form))
ed62683d 2931 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
1c393159
JB
2932 (byte-compile-out 'byte-call (length (cdr form))))
2933
29a4dcb0
SM
2934
2935;; Splice the given lap code into the current instruction stream.
2936;; If it has any labels in it, you're responsible for making sure there
2937;; are no collisions, and that byte-compile-tag-number is reasonable
2938;; after this is spliced in. The provided list is destroyed.
2939(defun byte-compile-inline-lapcode (lap end-depth)
2940 ;; "Replay" the operations: we used to just do
2941 ;; (setq byte-compile-output (nconc (nreverse lap) byte-compile-output))
2942 ;; but that fails to update byte-compile-depth, so we had to assume
2943 ;; that `lap' ends up adding exactly 1 element to the stack. This
2944 ;; happens to be true for byte-code generated by bytecomp.el without
2945 ;; lexical-binding, but it's not true in general, and it's not true for
2946 ;; code output by bytecomp.el with lexical-binding.
2947 (let ((endtag (byte-compile-make-tag)))
2948 (dolist (op lap)
2949 (cond
2950 ((eq (car op) 'TAG) (byte-compile-out-tag op))
2951 ((memq (car op) byte-goto-ops) (byte-compile-goto (car op) (cdr op)))
2952 ((eq (car op) 'byte-return)
2953 (byte-compile-discard (- byte-compile-depth end-depth) t)
2954 (byte-compile-goto 'byte-goto endtag))
2955 (t (byte-compile-out (car op) (cdr op)))))
2956 (byte-compile-out-tag endtag)))
2957
2958(defun byte-compile-unfold-bcf (form)
7200d79c 2959 "Inline call to byte-code-functions."
29a4dcb0
SM
2960 (let* ((byte-compile-bound-variables byte-compile-bound-variables)
2961 (fun (car form))
2962 (fargs (aref fun 0))
2963 (start-depth byte-compile-depth)
2964 (fmax2 (if (numberp fargs) (lsh fargs -7))) ;2*max+rest.
2965 ;; (fmin (if (numberp fargs) (logand fargs 127)))
2966 (alen (length (cdr form)))
2967 (dynbinds ()))
2968 (fetch-bytecode fun)
2969 (mapc 'byte-compile-form (cdr form))
2970 (unless fmax2
2971 ;; Old-style byte-code.
2972 (assert (listp fargs))
2973 (while fargs
2974 (case (car fargs)
2975 (&optional (setq fargs (cdr fargs)))
2976 (&rest (setq fmax2 (+ (* 2 (length dynbinds)) 1))
2977 (push (cadr fargs) dynbinds)
2978 (setq fargs nil))
2979 (t (push (pop fargs) dynbinds))))
2980 (unless fmax2 (setq fmax2 (* 2 (length dynbinds)))))
2981 (cond
2982 ((<= (+ alen alen) fmax2)
2983 ;; Add missing &optional (or &rest) arguments.
2984 (dotimes (i (- (/ (1+ fmax2) 2) alen))
2985 (byte-compile-push-constant nil)))
2986 ((zerop (logand fmax2 1))
2987 (byte-compile-log-warning "Too many arguments for inlined function"
2988 nil :error)
2989 (byte-compile-discard (- alen (/ fmax2 2))))
2990 (t
2991 ;; Turn &rest args into a list.
2992 (let ((n (- alen (/ (1- fmax2) 2))))
2993 (assert (> n 0) nil "problem: fmax2=%S alen=%S n=%S" fmax2 alen n)
2994 (if (< n 5)
2995 (byte-compile-out
2996 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- n))
2997 0)
2998 (byte-compile-out 'byte-listN n)))))
2999 (mapc #'byte-compile-dynamic-variable-bind dynbinds)
3000 (byte-compile-inline-lapcode
3001 (byte-decompile-bytecode-1 (aref fun 1) (aref fun 2) t)
3002 (1+ start-depth))
3003 ;; Unbind dynamic variables.
3004 (when dynbinds
3005 (byte-compile-out 'byte-unbind (length dynbinds)))
3006 (assert (eq byte-compile-depth (1+ start-depth))
3007 nil "Wrong depth start=%s end=%s" start-depth byte-compile-depth)))
3008
b9598260
SM
3009(defun byte-compile-check-variable (var &optional binding)
3010 "Do various error checks before a use of the variable VAR.
3011If BINDING is non-nil, VAR is being bound."
3012 (when (symbolp var)
3013 (byte-compile-set-symbol-position var))
3014 (cond ((or (not (symbolp var)) (byte-compile-const-symbol-p var))
3015 (when (byte-compile-warning-enabled-p 'constants)
3016 (byte-compile-warn (if binding
3017 "attempt to let-bind %s `%s`"
3018 "variable reference to %s `%s'")
3019 (if (symbolp var) "constant" "nonvariable")
3020 (prin1-to-string var))))
3021 ((and (get var 'byte-obsolete-variable)
f43cb649 3022 (not (memq var byte-compile-not-obsolete-vars)))
b9598260
SM
3023 (byte-compile-warn-obsolete var))))
3024
3025(defsubst byte-compile-dynamic-variable-op (base-op var)
3026 (let ((tmp (assq var byte-compile-variables)))
6c2161c4 3027 (unless tmp
b9598260 3028 (setq tmp (list var))
6c2161c4 3029 (push tmp byte-compile-variables))
1c393159
JB
3030 (byte-compile-out base-op tmp)))
3031
b9598260
SM
3032(defun byte-compile-dynamic-variable-bind (var)
3033 "Generate code to bind the lexical variable VAR to the top-of-stack value."
3034 (byte-compile-check-variable var t)
ce5b520a 3035 (push var byte-compile-bound-variables)
b9598260
SM
3036 (byte-compile-dynamic-variable-op 'byte-varbind var))
3037
b9598260
SM
3038(defun byte-compile-variable-ref (var)
3039 "Generate code to push the value of the variable VAR on the stack."
3040 (byte-compile-check-variable var)
7200d79c 3041 (let ((lex-binding (assq var byte-compile--lexical-environment)))
b9598260
SM
3042 (if lex-binding
3043 ;; VAR is lexically bound
ce5b520a 3044 (byte-compile-stack-ref (cdr lex-binding))
b9598260
SM
3045 ;; VAR is dynamically bound
3046 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3047 (boundp var)
3048 (memq var byte-compile-bound-variables)
3049 (memq var byte-compile-free-references))
876c194c 3050 (byte-compile-warn "reference to free variable `%S'" var)
b9598260
SM
3051 (push var byte-compile-free-references))
3052 (byte-compile-dynamic-variable-op 'byte-varref var))))
3053
3054(defun byte-compile-variable-set (var)
3055 "Generate code to set the variable VAR from the top-of-stack value."
3056 (byte-compile-check-variable var)
7200d79c 3057 (let ((lex-binding (assq var byte-compile--lexical-environment)))
b9598260
SM
3058 (if lex-binding
3059 ;; VAR is lexically bound
ce5b520a 3060 (byte-compile-stack-set (cdr lex-binding))
b9598260
SM
3061 ;; VAR is dynamically bound
3062 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3063 (boundp var)
3064 (memq var byte-compile-bound-variables)
3065 (memq var byte-compile-free-assignments))
3066 (byte-compile-warn "assignment to free variable `%s'" var)
3067 (push var byte-compile-free-assignments))
3068 (byte-compile-dynamic-variable-op 'byte-varset var))))
3069
1c393159 3070(defmacro byte-compile-get-constant (const)
1639b803 3071 `(or (if (stringp ,const)
7fb4fa10
RS
3072 ;; In a string constant, treat properties as significant.
3073 (let (result)
3074 (dolist (elt byte-compile-constants)
3075 (if (equal-including-properties (car elt) ,const)
3076 (setq result elt)))
3077 result)
1639b803
DL
3078 (assq ,const byte-compile-constants))
3079 (car (setq byte-compile-constants
3080 (cons (list ,const) byte-compile-constants)))))
1c393159 3081
2ec42da9
SM
3082;; Use this when the value of a form is a constant.
3083;; This obeys byte-compile--for-effect.
1c393159 3084(defun byte-compile-constant (const)
2ec42da9
SM
3085 (if byte-compile--for-effect
3086 (setq byte-compile--for-effect nil)
ccb3c8de
CW
3087 (when (symbolp const)
3088 (byte-compile-set-symbol-position const))
1c393159
JB
3089 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
3090
3091;; Use this for a constant that is not the value of its containing form.
2ec42da9 3092;; This ignores byte-compile--for-effect.
1c393159 3093(defun byte-compile-push-constant (const)
2ec42da9 3094 (let ((byte-compile--for-effect nil))
1c393159 3095 (inline (byte-compile-constant const))))
1c393159
JB
3096\f
3097;; Compile those primitive ordinary functions
3098;; which have special byte codes just for speed.
3099
3100(defmacro byte-defop-compiler (function &optional compile-handler)
9d28c33e
SM
3101 "Add a compiler-form for FUNCTION.
3102If function is a symbol, then the variable \"byte-SYMBOL\" must name
3103the opcode to be used. If function is a list, the first element
3104is the function and the second element is the bytecode-symbol.
3105The second element may be nil, meaning there is no opcode.
3106COMPILE-HANDLER is the function to use to compile this byte-op, or
3107may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
3108If it is nil, then the handler is \"byte-compile-SYMBOL.\""
1c393159
JB
3109 (let (opcode)
3110 (if (symbolp function)
3111 (setq opcode (intern (concat "byte-" (symbol-name function))))
3112 (setq opcode (car (cdr function))
3113 function (car function)))
3114 (let ((fnform
3115 (list 'put (list 'quote function) ''byte-compile
3116 (list 'quote
3117 (or (cdr (assq compile-handler
3118 '((0 . byte-compile-no-args)
3119 (1 . byte-compile-one-arg)
3120 (2 . byte-compile-two-args)
3121 (3 . byte-compile-three-args)
3122 (0-1 . byte-compile-zero-or-one-arg)
3123 (1-2 . byte-compile-one-or-two-args)
3124 (2-3 . byte-compile-two-or-three-args)
3125 )))
3126 compile-handler
3127 (intern (concat "byte-compile-"
3128 (symbol-name function))))))))
3129 (if opcode
3130 (list 'progn fnform
3131 (list 'put (list 'quote function)
3132 ''byte-opcode (list 'quote opcode))
3133 (list 'put (list 'quote opcode)
3134 ''byte-opcode-invert (list 'quote function)))
3135 fnform))))
3136
1c393159
JB
3137(defmacro byte-defop-compiler-1 (function &optional compile-handler)
3138 (list 'byte-defop-compiler (list function nil) compile-handler))
3139
3140\f
3141(put 'byte-call 'byte-opcode-invert 'funcall)
3142(put 'byte-list1 'byte-opcode-invert 'list)
3143(put 'byte-list2 'byte-opcode-invert 'list)
3144(put 'byte-list3 'byte-opcode-invert 'list)
3145(put 'byte-list4 'byte-opcode-invert 'list)
3146(put 'byte-listN 'byte-opcode-invert 'list)
3147(put 'byte-concat2 'byte-opcode-invert 'concat)
3148(put 'byte-concat3 'byte-opcode-invert 'concat)
3149(put 'byte-concat4 'byte-opcode-invert 'concat)
3150(put 'byte-concatN 'byte-opcode-invert 'concat)
3151(put 'byte-insertN 'byte-opcode-invert 'insert)
3152
1c393159
JB
3153(byte-defop-compiler point 0)
3154;;(byte-defop-compiler mark 0) ;; obsolete
3155(byte-defop-compiler point-max 0)
3156(byte-defop-compiler point-min 0)
3157(byte-defop-compiler following-char 0)
3158(byte-defop-compiler preceding-char 0)
3159(byte-defop-compiler current-column 0)
3160(byte-defop-compiler eolp 0)
3161(byte-defop-compiler eobp 0)
3162(byte-defop-compiler bolp 0)
3163(byte-defop-compiler bobp 0)
3164(byte-defop-compiler current-buffer 0)
3165;;(byte-defop-compiler read-char 0) ;; obsolete
7200d79c 3166;; (byte-defop-compiler interactive-p 0) ;; Obsolete.
eef899a9
GM
3167(byte-defop-compiler widen 0)
3168(byte-defop-compiler end-of-line 0-1)
3169(byte-defop-compiler forward-char 0-1)
3170(byte-defop-compiler forward-line 0-1)
1c393159
JB
3171(byte-defop-compiler symbolp 1)
3172(byte-defop-compiler consp 1)
3173(byte-defop-compiler stringp 1)
3174(byte-defop-compiler listp 1)
3175(byte-defop-compiler not 1)
3176(byte-defop-compiler (null byte-not) 1)
3177(byte-defop-compiler car 1)
3178(byte-defop-compiler cdr 1)
3179(byte-defop-compiler length 1)
3180(byte-defop-compiler symbol-value 1)
3181(byte-defop-compiler symbol-function 1)
3182(byte-defop-compiler (1+ byte-add1) 1)
3183(byte-defop-compiler (1- byte-sub1) 1)
3184(byte-defop-compiler goto-char 1)
b8ae93ad 3185(byte-defop-compiler char-after 0-1)
1c393159
JB
3186(byte-defop-compiler set-buffer 1)
3187;;(byte-defop-compiler set-mark 1) ;; obsolete
eef899a9
GM
3188(byte-defop-compiler forward-word 0-1)
3189(byte-defop-compiler char-syntax 1)
3190(byte-defop-compiler nreverse 1)
3191(byte-defop-compiler car-safe 1)
3192(byte-defop-compiler cdr-safe 1)
3193(byte-defop-compiler numberp 1)
3194(byte-defop-compiler integerp 1)
3195(byte-defop-compiler skip-chars-forward 1-2)
3196(byte-defop-compiler skip-chars-backward 1-2)
1c393159
JB
3197(byte-defop-compiler eq 2)
3198(byte-defop-compiler memq 2)
3199(byte-defop-compiler cons 2)
3200(byte-defop-compiler aref 2)
3201(byte-defop-compiler set 2)
3202(byte-defop-compiler (= byte-eqlsign) 2)
3203(byte-defop-compiler (< byte-lss) 2)
3204(byte-defop-compiler (> byte-gtr) 2)
3205(byte-defop-compiler (<= byte-leq) 2)
3206(byte-defop-compiler (>= byte-geq) 2)
3207(byte-defop-compiler get 2)
3208(byte-defop-compiler nth 2)
3209(byte-defop-compiler substring 2-3)
eef899a9
GM
3210(byte-defop-compiler (move-marker byte-set-marker) 2-3)
3211(byte-defop-compiler set-marker 2-3)
3212(byte-defop-compiler match-beginning 1)
3213(byte-defop-compiler match-end 1)
3214(byte-defop-compiler upcase 1)
3215(byte-defop-compiler downcase 1)
3216(byte-defop-compiler string= 2)
3217(byte-defop-compiler string< 2)
3218(byte-defop-compiler (string-equal byte-string=) 2)
3219(byte-defop-compiler (string-lessp byte-string<) 2)
3220(byte-defop-compiler equal 2)
3221(byte-defop-compiler nthcdr 2)
3222(byte-defop-compiler elt 2)
3223(byte-defop-compiler member 2)
3224(byte-defop-compiler assq 2)
3225(byte-defop-compiler (rplaca byte-setcar) 2)
3226(byte-defop-compiler (rplacd byte-setcdr) 2)
3227(byte-defop-compiler setcar 2)
3228(byte-defop-compiler setcdr 2)
3229(byte-defop-compiler buffer-substring 2)
3230(byte-defop-compiler delete-region 2)
3231(byte-defop-compiler narrow-to-region 2)
3232(byte-defop-compiler (% byte-rem) 2)
1c393159
JB
3233(byte-defop-compiler aset 3)
3234
3235(byte-defop-compiler max byte-compile-associative)
3236(byte-defop-compiler min byte-compile-associative)
3237(byte-defop-compiler (+ byte-plus) byte-compile-associative)
eef899a9 3238(byte-defop-compiler (* byte-mult) byte-compile-associative)
1c393159 3239
eef899a9 3240;;####(byte-defop-compiler move-to-column 1)
1c393159
JB
3241(byte-defop-compiler-1 interactive byte-compile-noop)
3242
3243\f
3244(defun byte-compile-subr-wrong-args (form n)
ccb3c8de 3245 (byte-compile-set-symbol-position (car form))
1d5c17c0 3246 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
1c393159
JB
3247 (car form) (length (cdr form))
3248 (if (= 1 (length (cdr form))) "" "s") n)
29a4dcb0 3249 ;; Get run-time wrong-number-of-args error.
1c393159
JB
3250 (byte-compile-normal-call form))
3251
3252(defun byte-compile-no-args (form)
3253 (if (not (= (length form) 1))
3254 (byte-compile-subr-wrong-args form "none")
3255 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3256
3257(defun byte-compile-one-arg (form)
3258 (if (not (= (length form) 2))
3259 (byte-compile-subr-wrong-args form 1)
3260 (byte-compile-form (car (cdr form))) ;; Push the argument
3261 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3262
3263(defun byte-compile-two-args (form)
3264 (if (not (= (length form) 3))
3265 (byte-compile-subr-wrong-args form 2)
3266 (byte-compile-form (car (cdr form))) ;; Push the arguments
3267 (byte-compile-form (nth 2 form))
3268 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3269
3270(defun byte-compile-three-args (form)
3271 (if (not (= (length form) 4))
3272 (byte-compile-subr-wrong-args form 3)
3273 (byte-compile-form (car (cdr form))) ;; Push the arguments
3274 (byte-compile-form (nth 2 form))
3275 (byte-compile-form (nth 3 form))
3276 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3277
3278(defun byte-compile-zero-or-one-arg (form)
3279 (let ((len (length form)))
3280 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3281 ((= len 2) (byte-compile-one-arg form))
3282 (t (byte-compile-subr-wrong-args form "0-1")))))
3283
3284(defun byte-compile-one-or-two-args (form)
3285 (let ((len (length form)))
3286 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3287 ((= len 3) (byte-compile-two-args form))
3288 (t (byte-compile-subr-wrong-args form "1-2")))))
3289
3290(defun byte-compile-two-or-three-args (form)
3291 (let ((len (length form)))
3292 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3293 ((= len 4) (byte-compile-three-args form))
3294 (t (byte-compile-subr-wrong-args form "2-3")))))
3295
9ace101c 3296(defun byte-compile-noop (_form)
1c393159
JB
3297 (byte-compile-constant nil))
3298
b9598260 3299(defun byte-compile-discard (&optional num preserve-tos)
2ec42da9
SM
3300 "Output byte codes to discard the NUM entries at the top of the stack.
3301NUM defaults to 1.
b9598260
SM
3302If PRESERVE-TOS is non-nil, preserve the top-of-stack value, as if it were
3303popped before discarding the num values, and then pushed back again after
3304discarding."
3305 (if (and (null num) (not preserve-tos))
3306 ;; common case
3307 (byte-compile-out 'byte-discard)
3308 ;; general case
3309 (unless num
3310 (setq num 1))
3311 (when (and preserve-tos (> num 0))
3312 ;; Preserve the top-of-stack value by writing it directly to the stack
3313 ;; location which will be at the top-of-stack after popping.
3314 (byte-compile-stack-set (1- (- byte-compile-depth num)))
3315 ;; Now we actually discard one less value, since we want to keep
3316 ;; the eventual TOS
3317 (setq num (1- num)))
3318 (while (> num 0)
3319 (byte-compile-out 'byte-discard)
3320 (setq num (1- num)))))
3321
3322(defun byte-compile-stack-ref (stack-pos)
2ec42da9 3323 "Output byte codes to push the value at stack position STACK-POS."
3e21b6a7
SM
3324 (let ((dist (- byte-compile-depth (1+ stack-pos))))
3325 (if (zerop dist)
3326 ;; A simple optimization
3327 (byte-compile-out 'byte-dup)
3328 ;; normal case
3329 (byte-compile-out 'byte-stack-ref dist))))
b9598260
SM
3330
3331(defun byte-compile-stack-set (stack-pos)
2ec42da9 3332 "Output byte codes to store the TOS value at stack position STACK-POS."
3e21b6a7 3333 (byte-compile-out 'byte-stack-set (- byte-compile-depth (1+ stack-pos))))
1c393159 3334
cb9336bd
SM
3335(byte-defop-compiler-1 internal-make-closure byte-compile-make-closure)
3336(byte-defop-compiler-1 internal-get-closed-var byte-compile-get-closed-var)
3337
cb9336bd 3338(defun byte-compile-make-closure (form)
7200d79c 3339 "Byte-compile the special `internal-make-closure' form."
2ec42da9 3340 (if byte-compile--for-effect (setq byte-compile--for-effect nil)
876c194c
SM
3341 (let* ((vars (nth 1 form))
3342 (env (nth 2 form))
3343 (body (nthcdr 3 form))
3344 (fun
3345 (byte-compile-lambda `(lambda ,vars . ,body) nil (length env))))
3346 (assert (byte-code-function-p fun))
3347 (byte-compile-form `(make-byte-code
3348 ',(aref fun 0) ',(aref fun 1)
3349 (vconcat (vector . ,env) ',(aref fun 2))
3350 ,@(nthcdr 3 (mapcar (lambda (x) `',x) fun)))))))
cb9336bd
SM
3351
3352(defun byte-compile-get-closed-var (form)
7200d79c 3353 "Byte-compile the special `internal-get-closed-var' form."
2ec42da9 3354 (if byte-compile--for-effect (setq byte-compile--for-effect nil)
7200d79c 3355 (byte-compile-out 'byte-constant (nth 1 form))))
1c393159
JB
3356
3357;; Compile a function that accepts one or more args and is right-associative.
c0f43df5
RS
3358;; We do it by left-associativity so that the operations
3359;; are done in the same order as in interpreted code.
10809e0f
RS
3360;; We treat the one-arg case, as in (+ x), like (+ x 0).
3361;; in order to convert markers to numbers, and trigger expected errors.
1c393159
JB
3362(defun byte-compile-associative (form)
3363 (if (cdr form)
c0f43df5 3364 (let ((opcode (get (car form) 'byte-opcode))
24ae8da4
CY
3365 args)
3366 (if (and (< 3 (length form))
3367 (memq opcode (list (get '+ 'byte-opcode)
3368 (get '* 'byte-opcode))))
3369 ;; Don't use binary operations for > 2 operands, as that
3370 ;; may cause overflow/truncation in float operations.
3371 (byte-compile-normal-call form)
3372 (setq args (copy-sequence (cdr form)))
3373 (byte-compile-form (car args))
3374 (setq args (cdr args))
3375 (or args (setq args '(0)
3376 opcode (get '+ 'byte-opcode)))
3377 (dolist (arg args)
3378 (byte-compile-form arg)
3379 (byte-compile-out opcode 0))))
1c393159
JB
3380 (byte-compile-constant (eval form))))
3381
3382\f
3383;; more complicated compiler macros
3384
ec448ae2 3385(byte-defop-compiler char-before)
a746fb65
GM
3386(byte-defop-compiler backward-char)
3387(byte-defop-compiler backward-word)
1c393159
JB
3388(byte-defop-compiler list)
3389(byte-defop-compiler concat)
3390(byte-defop-compiler fset)
3391(byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3392(byte-defop-compiler indent-to)
3393(byte-defop-compiler insert)
3394(byte-defop-compiler-1 function byte-compile-function-form)
3395(byte-defop-compiler-1 - byte-compile-minus)
eef899a9
GM
3396(byte-defop-compiler (/ byte-quo) byte-compile-quo)
3397(byte-defop-compiler nconc)
1c393159 3398
ec448ae2
GM
3399(defun byte-compile-char-before (form)
3400 (cond ((= 2 (length form))
a746fb65
GM
3401 (byte-compile-form (list 'char-after (if (numberp (nth 1 form))
3402 (1- (nth 1 form))
3403 `(1- ,(nth 1 form))))))
3404 ((= 1 (length form))
3405 (byte-compile-form '(char-after (1- (point)))))
3406 (t (byte-compile-subr-wrong-args form "0-1"))))
3407
3408;; backward-... ==> forward-... with negated argument.
3409(defun byte-compile-backward-char (form)
3410 (cond ((= 2 (length form))
3411 (byte-compile-form (list 'forward-char (if (numberp (nth 1 form))
3412 (- (nth 1 form))
3413 `(- ,(nth 1 form))))))
3414 ((= 1 (length form))
3415 (byte-compile-form '(forward-char -1)))
3416 (t (byte-compile-subr-wrong-args form "0-1"))))
3417
3418(defun byte-compile-backward-word (form)
3419 (cond ((= 2 (length form))
3420 (byte-compile-form (list 'forward-word (if (numberp (nth 1 form))
3421 (- (nth 1 form))
3422 `(- ,(nth 1 form))))))
3423 ((= 1 (length form))
3424 (byte-compile-form '(forward-word -1)))
3425 (t (byte-compile-subr-wrong-args form "0-1"))))
ec448ae2 3426
1c393159
JB
3427(defun byte-compile-list (form)
3428 (let ((count (length (cdr form))))
3429 (cond ((= count 0)
3430 (byte-compile-constant nil))
3431 ((< count 5)
ed62683d 3432 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3433 (byte-compile-out
3434 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
e5c89ce9 3435 ((< count 256)
ed62683d 3436 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3437 (byte-compile-out 'byte-listN count))
3438 (t (byte-compile-normal-call form)))))
3439
3440(defun byte-compile-concat (form)
3441 (let ((count (length (cdr form))))
3442 (cond ((and (< 1 count) (< count 5))
ed62683d 3443 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3444 (byte-compile-out
3445 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3446 0))
3447 ;; Concat of one arg is not a no-op if arg is not a string.
3448 ((= count 0)
3449 (byte-compile-form ""))
e5c89ce9 3450 ((< count 256)
ed62683d 3451 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3452 (byte-compile-out 'byte-concatN count))
3453 ((byte-compile-normal-call form)))))
3454
3455(defun byte-compile-minus (form)
24ae8da4
CY
3456 (let ((len (length form)))
3457 (cond
3458 ((= 1 len) (byte-compile-constant 0))
3459 ((= 2 len)
3460 (byte-compile-form (cadr form))
3461 (byte-compile-out 'byte-negate 0))
2b9c3b12 3462 ((= 3 len)
24ae8da4
CY
3463 (byte-compile-form (nth 1 form))
3464 (byte-compile-form (nth 2 form))
3465 (byte-compile-out 'byte-diff 0))
3466 ;; Don't use binary operations for > 2 operands, as that may
3467 ;; cause overflow/truncation in float operations.
3468 (t (byte-compile-normal-call form)))))
1c393159
JB
3469
3470(defun byte-compile-quo (form)
3471 (let ((len (length form)))
3472 (cond ((<= len 2)
3473 (byte-compile-subr-wrong-args form "2 or more"))
24ae8da4
CY
3474 ((= len 3)
3475 (byte-compile-two-args form))
1c393159 3476 (t
24ae8da4
CY
3477 ;; Don't use binary operations for > 2 operands, as that
3478 ;; may cause overflow/truncation in float operations.
3479 (byte-compile-normal-call form)))))
1c393159
JB
3480
3481(defun byte-compile-nconc (form)
3482 (let ((len (length form)))
3483 (cond ((= len 1)
3484 (byte-compile-constant nil))
3485 ((= len 2)
3486 ;; nconc of one arg is a noop, even if that arg isn't a list.
3487 (byte-compile-form (nth 1 form)))
3488 (t
3489 (byte-compile-form (car (setq form (cdr form))))
3490 (while (setq form (cdr form))
3491 (byte-compile-form (car form))
3492 (byte-compile-out 'byte-nconc 0))))))
3493
3494(defun byte-compile-fset (form)
3495 ;; warn about forms like (fset 'foo '(lambda () ...))
3496 ;; (where the lambda expression is non-trivial...)
3497 (let ((fn (nth 2 form))
3498 body)
3499 (if (and (eq (car-safe fn) 'quote)
3500 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3501 (progn
3502 (setq body (cdr (cdr fn)))
3503 (if (stringp (car body)) (setq body (cdr body)))
3504 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3505 (if (and (consp (car body))
3506 (not (eq 'byte-code (car (car body)))))
3507 (byte-compile-warn
1d5c17c0 3508 "A quoted lambda form is the second argument of `fset'. This is probably
1c393159 3509 not what you want, as that lambda cannot be compiled. Consider using
29a4dcb0 3510 the syntax #'(lambda (...) ...) instead.")))))
1c393159
JB
3511 (byte-compile-two-args form))
3512
1c393159
JB
3513;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3514;; Otherwise it will be incompatible with the interpreter,
3515;; and (funcall (function foo)) will lose with autoloads.
3516
3517(defun byte-compile-function-form (form)
29a4dcb0
SM
3518 (byte-compile-constant (if (symbolp (nth 1 form))
3519 (nth 1 form)
3520 (byte-compile-lambda (nth 1 form)))))
1c393159
JB
3521
3522(defun byte-compile-indent-to (form)
3523 (let ((len (length form)))
3524 (cond ((= len 2)
3525 (byte-compile-form (car (cdr form)))
3526 (byte-compile-out 'byte-indent-to 0))
3527 ((= len 3)
3528 ;; no opcode for 2-arg case.
3529 (byte-compile-normal-call form))
3530 (t
3531 (byte-compile-subr-wrong-args form "1-2")))))
3532
3533(defun byte-compile-insert (form)
3534 (cond ((null (cdr form))
3535 (byte-compile-constant nil))
e5c89ce9 3536 ((<= (length form) 256)
ed62683d 3537 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3538 (if (cdr (cdr form))
3539 (byte-compile-out 'byte-insertN (length (cdr form)))
3540 (byte-compile-out 'byte-insert 0)))
3541 ((memq t (mapcar 'consp (cdr (cdr form))))
3542 (byte-compile-normal-call form))
3543 ;; We can split it; there is no function call after inserting 1st arg.
3544 (t
3545 (while (setq form (cdr form))
3546 (byte-compile-form (car form))
3547 (byte-compile-out 'byte-insert 0)
3548 (if (cdr form)
3549 (byte-compile-discard))))))
3550
1c393159
JB
3551\f
3552(byte-defop-compiler-1 setq)
3553(byte-defop-compiler-1 setq-default)
3554(byte-defop-compiler-1 quote)
1c393159
JB
3555
3556(defun byte-compile-setq (form)
ca105506
SM
3557 (let ((args (cdr form)))
3558 (if args
3559 (while args
3560 (byte-compile-form (car (cdr args)))
3561 (or byte-compile--for-effect (cdr (cdr args))
1c393159 3562 (byte-compile-out 'byte-dup 0))
ca105506
SM
3563 (byte-compile-variable-set (car args))
3564 (setq args (cdr (cdr args))))
1c393159 3565 ;; (setq), with no arguments.
2ec42da9
SM
3566 (byte-compile-form nil byte-compile--for-effect))
3567 (setq byte-compile--for-effect nil)))
1c393159
JB
3568
3569(defun byte-compile-setq-default (form)
9ae0c310
SM
3570 (setq form (cdr form))
3571 (if (> (length form) 2)
3572 (let ((setters ()))
3573 (while (consp form)
3574 (push `(setq-default ,(pop form) ,(pop form)) setters))
3575 (byte-compile-form (cons 'progn (nreverse setters))))
3576 (let ((var (car form)))
3577 (and (or (not (symbolp var))
3578 (byte-compile-const-symbol-p var t))
3579 (byte-compile-warning-enabled-p 'constants)
3580 (byte-compile-warn
3581 "variable assignment to %s `%s'"
3582 (if (symbolp var) "constant" "nonvariable")
3583 (prin1-to-string var)))
3584 (byte-compile-normal-call `(set-default ',var ,@(cdr form))))))
3585
3586(byte-defop-compiler-1 set-default)
3587(defun byte-compile-set-default (form)
3588 (let ((varexp (car-safe (cdr-safe form))))
3589 (if (eq (car-safe varexp) 'quote)
3590 ;; If the varexp is constant, compile it as a setq-default
3591 ;; so we get more warnings.
3592 (byte-compile-setq-default `(setq-default ,(car-safe (cdr varexp))
3593 ,@(cddr form)))
3594 (byte-compile-normal-call form))))
1c393159
JB
3595
3596(defun byte-compile-quote (form)
3597 (byte-compile-constant (car (cdr form))))
1c393159
JB
3598\f
3599;;; control structures
3600
ca105506
SM
3601(defun byte-compile-body (body &optional for-effect)
3602 (while (cdr body)
3603 (byte-compile-form (car body) t)
3604 (setq body (cdr body)))
3605 (byte-compile-form (car body) for-effect))
1c393159 3606
ca105506
SM
3607(defsubst byte-compile-body-do-effect (body)
3608 (byte-compile-body body byte-compile--for-effect)
2ec42da9 3609 (setq byte-compile--for-effect nil))
1c393159 3610
52799cb8 3611(defsubst byte-compile-form-do-effect (form)
2ec42da9
SM
3612 (byte-compile-form form byte-compile--for-effect)
3613 (setq byte-compile--for-effect nil))
1c393159
JB
3614
3615(byte-defop-compiler-1 inline byte-compile-progn)
3616(byte-defop-compiler-1 progn)
3617(byte-defop-compiler-1 prog1)
3618(byte-defop-compiler-1 prog2)
3619(byte-defop-compiler-1 if)
3620(byte-defop-compiler-1 cond)
3621(byte-defop-compiler-1 and)
3622(byte-defop-compiler-1 or)
3623(byte-defop-compiler-1 while)
3624(byte-defop-compiler-1 funcall)
1c393159 3625(byte-defop-compiler-1 let)
b38b1ec0 3626(byte-defop-compiler-1 let* byte-compile-let)
1c393159
JB
3627
3628(defun byte-compile-progn (form)
3629 (byte-compile-body-do-effect (cdr form)))
3630
3631(defun byte-compile-prog1 (form)
3632 (byte-compile-form-do-effect (car (cdr form)))
3633 (byte-compile-body (cdr (cdr form)) t))
3634
3635(defun byte-compile-prog2 (form)
3636 (byte-compile-form (nth 1 form) t)
3637 (byte-compile-form-do-effect (nth 2 form))
3638 (byte-compile-body (cdr (cdr (cdr form))) t))
3639
3640(defmacro byte-compile-goto-if (cond discard tag)
1639b803
DL
3641 `(byte-compile-goto
3642 (if ,cond
3643 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3644 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3645 ,tag))
1c393159 3646
70f41945
DN
3647;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3648;; Only return items that are not in ONLY-IF-NOT-PRESENT.
516b3653
JB
3649(defun byte-compile-find-bound-condition (condition-param
3650 pred-list
70f41945
DN
3651 &optional only-if-not-present)
3652 (let ((result nil)
3653 (nth-one nil)
516b3653 3654 (cond-list
70f41945
DN
3655 (if (memq (car-safe condition-param) pred-list)
3656 ;; The condition appears by itself.
3657 (list condition-param)
3658 ;; If the condition is an `and', look for matches among the
3659 ;; `and' arguments.
3660 (when (eq 'and (car-safe condition-param))
3661 (cdr condition-param)))))
516b3653 3662
70f41945
DN
3663 (dolist (crt cond-list)
3664 (when (and (memq (car-safe crt) pred-list)
3665 (eq 'quote (car-safe (setq nth-one (nth 1 crt))))
3666 ;; Ignore if the symbol is already on the unresolved
3667 ;; list.
3668 (not (assq (nth 1 nth-one) ; the relevant symbol
3669 only-if-not-present)))
3670 (push (nth 1 (nth 1 crt)) result)))
3671 result))
3672
6b61353c
KH
3673(defmacro byte-compile-maybe-guarded (condition &rest body)
3674 "Execute forms in BODY, potentially guarded by CONDITION.
82a726b4 3675CONDITION is a variable whose value is a test in an `if' or `cond'.
d6dc41d5
GM
3676BODY is the code to compile in the first arm of the if or the body of
3677the cond clause. If CONDITION's value is of the form (fboundp 'foo)
ad50a502 3678or (boundp 'foo), the relevant warnings from BODY about foo's
8480fc7c 3679being undefined (or obsolete) will be suppressed.
82a726b4 3680
b2e948ee 3681If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
ad50a502 3682that suppresses all warnings during execution of BODY."
6b61353c 3683 (declare (indent 1) (debug t))
516b3653
JB
3684 `(let* ((fbound-list (byte-compile-find-bound-condition
3685 ,condition (list 'fboundp)
70f41945 3686 byte-compile-unresolved-functions))
516b3653 3687 (bound-list (byte-compile-find-bound-condition
70f41945 3688 ,condition (list 'boundp 'default-boundp)))
6b61353c
KH
3689 ;; Maybe add to the bound list.
3690 (byte-compile-bound-variables
ce5b520a 3691 (append bound-list byte-compile-bound-variables)))
82a726b4 3692 (unwind-protect
2ec42da9
SM
3693 ;; If things not being bound at all is ok, so must them being
3694 ;; obsolete. Note that we add to the existing lists since Tramp
3695 ;; (ab)uses this feature.
8480fc7c
GM
3696 (let ((byte-compile-not-obsolete-vars
3697 (append byte-compile-not-obsolete-vars bound-list))
3698 (byte-compile-not-obsolete-funcs
3699 (append byte-compile-not-obsolete-funcs fbound-list)))
3700 ,@body)
82a726b4 3701 ;; Maybe remove the function symbol from the unresolved list.
70f41945
DN
3702 (dolist (fbound fbound-list)
3703 (when fbound
82a726b4
RS
3704 (setq byte-compile-unresolved-functions
3705 (delq (assq fbound byte-compile-unresolved-functions)
70f41945 3706 byte-compile-unresolved-functions)))))))
6b61353c 3707
1c393159
JB
3708(defun byte-compile-if (form)
3709 (byte-compile-form (car (cdr form)))
b8234c84
DL
3710 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3711 ;; and avoid warnings about the relevent symbols in the consequent.
6b61353c
KH
3712 (let ((clause (nth 1 form))
3713 (donetag (byte-compile-make-tag)))
b8234c84
DL
3714 (if (null (nthcdr 3 form))
3715 ;; No else-forms
3716 (progn
2ec42da9 3717 (byte-compile-goto-if nil byte-compile--for-effect donetag)
6b61353c 3718 (byte-compile-maybe-guarded clause
2ec42da9 3719 (byte-compile-form (nth 2 form) byte-compile--for-effect))
b8234c84
DL
3720 (byte-compile-out-tag donetag))
3721 (let ((elsetag (byte-compile-make-tag)))
3722 (byte-compile-goto 'byte-goto-if-nil elsetag)
6b61353c 3723 (byte-compile-maybe-guarded clause
2ec42da9 3724 (byte-compile-form (nth 2 form) byte-compile--for-effect))
b8234c84
DL
3725 (byte-compile-goto 'byte-goto donetag)
3726 (byte-compile-out-tag elsetag)
300f994a 3727 (byte-compile-maybe-guarded (list 'not clause)
2ec42da9 3728 (byte-compile-body (cdr (cdr (cdr form))) byte-compile--for-effect))
b8234c84 3729 (byte-compile-out-tag donetag))))
2ec42da9 3730 (setq byte-compile--for-effect nil))
1c393159
JB
3731
3732(defun byte-compile-cond (clauses)
3733 (let ((donetag (byte-compile-make-tag))
3734 nexttag clause)
3735 (while (setq clauses (cdr clauses))
3736 (setq clause (car clauses))
3737 (cond ((or (eq (car clause) t)
3738 (and (eq (car-safe (car clause)) 'quote)
3739 (car-safe (cdr-safe (car clause)))))
3740 ;; Unconditional clause
3741 (setq clause (cons t clause)
3742 clauses nil))
3743 ((cdr clauses)
3744 (byte-compile-form (car clause))
3745 (if (null (cdr clause))
3746 ;; First clause is a singleton.
2ec42da9 3747 (byte-compile-goto-if t byte-compile--for-effect donetag)
82a726b4
RS
3748 (setq nexttag (byte-compile-make-tag))
3749 (byte-compile-goto 'byte-goto-if-nil nexttag)
3750 (byte-compile-maybe-guarded (car clause)
2ec42da9 3751 (byte-compile-body (cdr clause) byte-compile--for-effect))
82a726b4
RS
3752 (byte-compile-goto 'byte-goto donetag)
3753 (byte-compile-out-tag nexttag)))))
1c393159 3754 ;; Last clause
6b61353c
KH
3755 (let ((guard (car clause)))
3756 (and (cdr clause) (not (eq guard t))
3757 (progn (byte-compile-form guard)
2ec42da9 3758 (byte-compile-goto-if nil byte-compile--for-effect donetag)
6b61353c
KH
3759 (setq clause (cdr clause))))
3760 (byte-compile-maybe-guarded guard
3761 (byte-compile-body-do-effect clause)))
1c393159
JB
3762 (byte-compile-out-tag donetag)))
3763
3764(defun byte-compile-and (form)
3765 (let ((failtag (byte-compile-make-tag))
ca105506
SM
3766 (args (cdr form)))
3767 (if (null args)
1c393159 3768 (byte-compile-form-do-effect t)
ca105506 3769 (byte-compile-and-recursion args failtag))))
8877fa6f 3770
83b0af6e 3771;; Handle compilation of a nontrivial `and' call.
8877fa6f
RS
3772;; We use tail recursion so we can use byte-compile-maybe-guarded.
3773(defun byte-compile-and-recursion (rest failtag)
3774 (if (cdr rest)
3775 (progn
3776 (byte-compile-form (car rest))
2ec42da9 3777 (byte-compile-goto-if nil byte-compile--for-effect failtag)
8877fa6f
RS
3778 (byte-compile-maybe-guarded (car rest)
3779 (byte-compile-and-recursion (cdr rest) failtag)))
3780 (byte-compile-form-do-effect (car rest))
3781 (byte-compile-out-tag failtag)))
1c393159
JB
3782
3783(defun byte-compile-or (form)
3784 (let ((wintag (byte-compile-make-tag))
ca105506
SM
3785 (args (cdr form)))
3786 (if (null args)
1c393159 3787 (byte-compile-form-do-effect nil)
ca105506 3788 (byte-compile-or-recursion args wintag))))
83b0af6e
RS
3789
3790;; Handle compilation of a nontrivial `or' call.
3791;; We use tail recursion so we can use byte-compile-maybe-guarded.
3792(defun byte-compile-or-recursion (rest wintag)
3793 (if (cdr rest)
3794 (progn
3795 (byte-compile-form (car rest))
2ec42da9 3796 (byte-compile-goto-if t byte-compile--for-effect wintag)
83b0af6e
RS
3797 (byte-compile-maybe-guarded (list 'not (car rest))
3798 (byte-compile-or-recursion (cdr rest) wintag)))
3799 (byte-compile-form-do-effect (car rest))
3800 (byte-compile-out-tag wintag)))
1c393159
JB
3801
3802(defun byte-compile-while (form)
3803 (let ((endtag (byte-compile-make-tag))
3804 (looptag (byte-compile-make-tag)))
3805 (byte-compile-out-tag looptag)
3806 (byte-compile-form (car (cdr form)))
2ec42da9 3807 (byte-compile-goto-if nil byte-compile--for-effect endtag)
1c393159
JB
3808 (byte-compile-body (cdr (cdr form)) t)
3809 (byte-compile-goto 'byte-goto looptag)
3810 (byte-compile-out-tag endtag)
2ec42da9 3811 (setq byte-compile--for-effect nil)))
1c393159
JB
3812
3813(defun byte-compile-funcall (form)
ed62683d 3814 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3815 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3816
b9598260
SM
3817\f
3818;; let binding
3819
ce5b520a 3820(defun byte-compile-push-binding-init (clause)
b9598260 3821 "Emit byte-codes to push the initialization value for CLAUSE on the stack.
ce5b520a
SM
3822Return the offset in the form (VAR . OFFSET)."
3823 (let* ((var (if (consp clause) (car clause) clause)))
3824 ;; We record the stack position even of dynamic bindings and
3825 ;; variables in non-stack lexical environments; we'll put
3826 ;; them in the proper place below.
3827 (prog1 (cons var byte-compile-depth)
b9598260 3828 (if (consp clause)
ce5b520a
SM
3829 (byte-compile-form (cadr clause))
3830 (byte-compile-push-constant nil)))))
3831
3832(defun byte-compile-not-lexical-var-p (var)
b38b1ec0
SM
3833 (or (not (symbolp var))
3834 (special-variable-p var)
ce5b520a
SM
3835 (memq var byte-compile-bound-variables)
3836 (memq var '(nil t))
3837 (keywordp var)))
3838
3839(defun byte-compile-bind (var init-lexenv)
7200d79c 3840 "Emit byte-codes to bind VAR and update `byte-compile--lexical-environment'.
ce5b520a
SM
3841INIT-LEXENV should be a lexical-environment alist describing the
3842positions of the init value that have been pushed on the stack.
3843Return non-nil if the TOS value was popped."
3844 ;; The presence of lexical bindings mean that we may have to
b38b1ec0
SM
3845 ;; juggle things on the stack, to move them to TOS for
3846 ;; dynamic binding.
ce5b520a
SM
3847 (cond ((not (byte-compile-not-lexical-var-p var))
3848 ;; VAR is a simple stack-allocated lexical variable
3849 (push (assq var init-lexenv)
7200d79c 3850 byte-compile--lexical-environment)
ce5b520a
SM
3851 nil)
3852 ((eq var (caar init-lexenv))
3853 ;; VAR is dynamic and is on the top of the
3854 ;; stack, so we can just bind it like usual
3855 (byte-compile-dynamic-variable-bind var)
3856 t)
3857 (t
3858 ;; VAR is dynamic, but we have to get its
3859 ;; value out of the middle of the stack
3860 (let ((stack-pos (cdr (assq var init-lexenv))))
3861 (byte-compile-stack-ref stack-pos)
3862 (byte-compile-dynamic-variable-bind var)
3863 ;; Now we have to store nil into its temporary
3864 ;; stack position to avoid problems with GC
3865 (byte-compile-push-constant nil)
3866 (byte-compile-stack-set stack-pos))
3867 nil)))
3868
3869(defun byte-compile-unbind (clauses init-lexenv
3870 &optional preserve-body-value)
3871 "Emit byte-codes to unbind the variables bound by CLAUSES.
3872CLAUSES is a `let'-style variable binding list. INIT-LEXENV should be a
3873lexical-environment alist describing the positions of the init value that
3874have been pushed on the stack. If PRESERVE-BODY-VALUE is true,
3875then an additional value on the top of the stack, above any lexical binding
3876slots, is preserved, so it will be on the top of the stack after all
3877binding slots have been popped."
3878 ;; Unbind dynamic variables
3879 (let ((num-dynamic-bindings 0))
3880 (dolist (clause clauses)
3881 (unless (assq (if (consp clause) (car clause) clause)
7200d79c 3882 byte-compile--lexical-environment)
ce5b520a
SM
3883 (setq num-dynamic-bindings (1+ num-dynamic-bindings))))
3884 (unless (zerop num-dynamic-bindings)
3885 (byte-compile-out 'byte-unbind num-dynamic-bindings)))
3886 ;; Pop lexical variables off the stack, possibly preserving the
3887 ;; return value of the body.
3888 (when init-lexenv
3889 ;; INIT-LEXENV contains all init values left on the stack
3890 (byte-compile-discard (length init-lexenv) preserve-body-value)))
1c393159
JB
3891
3892(defun byte-compile-let (form)
b9598260 3893 "Generate code for the `let' form FORM."
b38b1ec0
SM
3894 (let ((clauses (cadr form))
3895 (init-lexenv nil))
3896 (when (eq (car form) 'let)
3897 ;; First compute the binding values in the old scope.
3898 (dolist (var clauses)
3899 (push (byte-compile-push-binding-init var) init-lexenv)))
3900 ;; New scope.
3901 (let ((byte-compile-bound-variables byte-compile-bound-variables)
7200d79c
SM
3902 (byte-compile--lexical-environment
3903 byte-compile--lexical-environment))
b38b1ec0
SM
3904 ;; Bind the variables.
3905 ;; For `let', do it in reverse order, because it makes no
3906 ;; semantic difference, but it is a lot more efficient since the
3907 ;; values are now in reverse order on the stack.
3908 (dolist (var (if (eq (car form) 'let) (reverse clauses) clauses))
3909 (unless (eq (car form) 'let)
3910 (push (byte-compile-push-binding-init var) init-lexenv))
3911 (let ((var (if (consp var) (car var) var)))
3912 (cond ((null lexical-binding)
3913 ;; If there are no lexical bindings, we can do things simply.
3914 (byte-compile-dynamic-variable-bind var))
3915 ((byte-compile-bind var init-lexenv)
3916 (pop init-lexenv)))))
ce5b520a 3917 ;; Emit the body.
b38b1ec0
SM
3918 (let ((init-stack-depth byte-compile-depth))
3919 (byte-compile-body-do-effect (cdr (cdr form)))
3920 ;; Unbind the variables.
3921 (if lexical-binding
3922 ;; Unbind both lexical and dynamic variables.
3923 (progn
3924 (assert (or (eq byte-compile-depth init-stack-depth)
3925 (eq byte-compile-depth (1+ init-stack-depth))))
3926 (byte-compile-unbind clauses init-lexenv (> byte-compile-depth
3927 init-stack-depth)))
3928 ;; Unbind dynamic variables.
3929 (byte-compile-out 'byte-unbind (length clauses)))))))
1c393159 3930
b9598260 3931\f
1c393159
JB
3932
3933(byte-defop-compiler-1 /= byte-compile-negated)
3934(byte-defop-compiler-1 atom byte-compile-negated)
3935(byte-defop-compiler-1 nlistp byte-compile-negated)
3936
3937(put '/= 'byte-compile-negated-op '=)
3938(put 'atom 'byte-compile-negated-op 'consp)
3939(put 'nlistp 'byte-compile-negated-op 'listp)
3940
3941(defun byte-compile-negated (form)
3942 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3943
3944;; Even when optimization is off, /= is optimized to (not (= ...)).
3945(defun byte-compile-negation-optimizer (form)
3946 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
ccb3c8de 3947 (byte-compile-set-symbol-position (car form))
1c393159
JB
3948 (list 'not
3949 (cons (or (get (car form) 'byte-compile-negated-op)
3950 (error
52799cb8 3951 "Compiler error: `%s' has no `byte-compile-negated-op' property"
1c393159
JB
3952 (car form)))
3953 (cdr form))))
3954\f
3955;;; other tricky macro-like special-forms
3956
3957(byte-defop-compiler-1 catch)
3958(byte-defop-compiler-1 unwind-protect)
3959(byte-defop-compiler-1 condition-case)
3960(byte-defop-compiler-1 save-excursion)
f3e472b0 3961(byte-defop-compiler-1 save-current-buffer)
1c393159 3962(byte-defop-compiler-1 save-restriction)
7200d79c
SM
3963;; (byte-defop-compiler-1 save-window-excursion) ;Obsolete: now a macro.
3964;; (byte-defop-compiler-1 with-output-to-temp-buffer) ;Obsolete: now a macro.
6e8d0db7 3965(byte-defop-compiler-1 track-mouse)
1c393159
JB
3966
3967(defun byte-compile-catch (form)
3968 (byte-compile-form (car (cdr form)))
d779e73c
SM
3969 (pcase (cddr form)
3970 (`(:fun-body ,f)
3971 (byte-compile-form `(list 'funcall ,f)))
3972 (body
3973 (byte-compile-push-constant
2ec42da9 3974 (byte-compile-top-level (cons 'progn body) byte-compile--for-effect))))
1c393159
JB
3975 (byte-compile-out 'byte-catch 0))
3976
3977(defun byte-compile-unwind-protect (form)
d779e73c
SM
3978 (pcase (cddr form)
3979 (`(:fun-body ,f)
3980 (byte-compile-form `(list (list 'funcall ,f))))
3981 (handlers
3982 (byte-compile-push-constant
3983 (byte-compile-top-level-body handlers t))))
1c393159
JB
3984 (byte-compile-out 'byte-unwind-protect 0)
3985 (byte-compile-form-do-effect (car (cdr form)))
3986 (byte-compile-out 'byte-unbind 1))
3987
6e8d0db7 3988(defun byte-compile-track-mouse (form)
d7846e08 3989 (byte-compile-form
d779e73c
SM
3990 (pcase form
3991 (`(,_ :fun-body ,f) `(eval (list 'track-mouse (list 'funcall ,f))))
3992 (_ `(eval '(track-mouse ,@(byte-compile-top-level-body (cdr form))))))))
6e8d0db7 3993
1c393159
JB
3994(defun byte-compile-condition-case (form)
3995 (let* ((var (nth 1 form))
ce5b520a
SM
3996 (fun-bodies (eq var :fun-body))
3997 (byte-compile-bound-variables
3998 (if (and var (not fun-bodies))
3999 (cons var byte-compile-bound-variables)
1c393159 4000 byte-compile-bound-variables)))
ccb3c8de
CW
4001 (byte-compile-set-symbol-position 'condition-case)
4002 (unless (symbolp var)
4003 (byte-compile-warn
1d5c17c0 4004 "`%s' is not a variable-name or nil (in condition-case)" var))
d779e73c 4005 (if fun-bodies (setq var (make-symbol "err")))
1c393159 4006 (byte-compile-push-constant var)
d779e73c
SM
4007 (if fun-bodies
4008 (byte-compile-form `(list 'funcall ,(nth 2 form)))
4009 (byte-compile-push-constant
2ec42da9 4010 (byte-compile-top-level (nth 2 form) byte-compile--for-effect)))
d779e73c
SM
4011 (let ((compiled-clauses
4012 (mapcar
4013 (lambda (clause)
4014 (let ((condition (car clause)))
4015 (cond ((not (or (symbolp condition)
4016 (and (listp condition)
4017 (let ((ok t))
4018 (dolist (sym condition)
4019 (if (not (symbolp sym))
4020 (setq ok nil)))
4021 ok))))
4022 (byte-compile-warn
4023 "`%S' is not a condition name or list of such (in condition-case)"
4024 condition))
4025 ;; (not (or (eq condition 't)
4026 ;; (and (stringp (get condition 'error-message))
4027 ;; (consp (get condition
4028 ;; 'error-conditions)))))
4029 ;; (byte-compile-warn
4030 ;; "`%s' is not a known condition name
4031 ;; (in condition-case)"
4032 ;; condition))
4033 )
4034 (if fun-bodies
4035 `(list ',condition (list 'funcall ,(cadr clause) ',var))
4036 (cons condition
4037 (byte-compile-top-level-body
2ec42da9 4038 (cdr clause) byte-compile--for-effect)))))
d779e73c
SM
4039 (cdr (cdr (cdr form))))))
4040 (if fun-bodies
4041 (byte-compile-form `(list ,@compiled-clauses))
4042 (byte-compile-push-constant compiled-clauses)))
1c393159
JB
4043 (byte-compile-out 'byte-condition-case 0)))
4044
4045
4046(defun byte-compile-save-excursion (form)
62a258a7
SM
4047 (if (and (eq 'set-buffer (car-safe (car-safe (cdr form))))
4048 (byte-compile-warning-enabled-p 'suspicious))
0a57d256
SM
4049 (byte-compile-warn
4050 "Use `with-current-buffer' rather than save-excursion+set-buffer"))
1c393159
JB
4051 (byte-compile-out 'byte-save-excursion 0)
4052 (byte-compile-body-do-effect (cdr form))
4053 (byte-compile-out 'byte-unbind 1))
4054
4055(defun byte-compile-save-restriction (form)
4056 (byte-compile-out 'byte-save-restriction 0)
4057 (byte-compile-body-do-effect (cdr form))
4058 (byte-compile-out 'byte-unbind 1))
4059
f3e472b0
RS
4060(defun byte-compile-save-current-buffer (form)
4061 (byte-compile-out 'byte-save-current-buffer 0)
4062 (byte-compile-body-do-effect (cdr form))
4063 (byte-compile-out 'byte-unbind 1))
1c393159
JB
4064\f
4065;;; top-level forms elsewhere
4066
4067(byte-defop-compiler-1 defun)
4068(byte-defop-compiler-1 defmacro)
4069(byte-defop-compiler-1 defvar)
4070(byte-defop-compiler-1 defconst byte-compile-defvar)
4071(byte-defop-compiler-1 autoload)
4072(byte-defop-compiler-1 lambda byte-compile-lambda-form)
4073
4074(defun byte-compile-defun (form)
4075 ;; This is not used for file-level defuns with doc strings.
ccb3c8de
CW
4076 (if (symbolp (car form))
4077 (byte-compile-set-symbol-position (car form))
4078 (byte-compile-set-symbol-position 'defun)
eadd6444 4079 (error "defun name must be a symbol, not %s" (car form)))
29a4dcb0
SM
4080 (byte-compile-push-constant 'defalias)
4081 (byte-compile-push-constant (nth 1 form))
4082 (byte-compile-push-constant (byte-compile-lambda (cdr (cdr form)) t))
b9598260 4083 (byte-compile-out 'byte-call 2))
1c393159
JB
4084
4085(defun byte-compile-defmacro (form)
4086 ;; This is not used for file-level defmacros with doc strings.
4087 (byte-compile-body-do-effect
e3a6b82f 4088 (let ((decls (byte-compile-defmacro-declaration form))
29a4dcb0 4089 (code (byte-compile-lambda (cdr (cdr form)) t)))
e3a6b82f
SM
4090 `((defalias ',(nth 1 form)
4091 ,(if (eq (car-safe code) 'make-byte-code)
4092 `(cons 'macro ,code)
4093 `'(macro . ,(eval code))))
4094 ,@decls
4095 ',(nth 1 form)))))
1c393159 4096
3aaaa6f1
SM
4097;; If foo.el declares `toto' as obsolete, it is likely that foo.el will
4098;; actually use `toto' in order for this obsolete variable to still work
4099;; correctly, so paradoxically, while byte-compiling foo.el, the presence
4100;; of a make-obsolete-variable call for `toto' is an indication that `toto'
4101;; should not trigger obsolete-warnings in foo.el.
4102(byte-defop-compiler-1 make-obsolete-variable)
4103(defun byte-compile-make-obsolete-variable (form)
4104 (when (eq 'quote (car-safe (nth 1 form)))
4105 (push (nth 1 (nth 1 form)) byte-compile-not-obsolete-vars))
4106 (byte-compile-normal-call form))
4107
1c393159
JB
4108(defun byte-compile-defvar (form)
4109 ;; This is not used for file-level defvar/consts with doc strings.
4f1e9960 4110 (when (and (symbolp (nth 1 form))
3fe6ef4e 4111 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
4f1e9960 4112 (byte-compile-warning-enabled-p 'lexical))
7a16788b 4113 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
4f1e9960 4114 (nth 1 form)))
1bc20d83
GM
4115 (let ((fun (nth 0 form))
4116 (var (nth 1 form))
1c393159
JB
4117 (value (nth 2 form))
4118 (string (nth 3 form)))
ccb3c8de 4119 (byte-compile-set-symbol-position fun)
6c2161c4
SM
4120 (when (or (> (length form) 4)
4121 (and (eq fun 'defconst) (null (cddr form))))
d0e07261
SM
4122 (let ((ncall (length (cdr form))))
4123 (byte-compile-warn
1d5c17c0 4124 "`%s' called with %d argument%s, but %s %s"
d0e07261
SM
4125 fun ncall
4126 (if (= 1 ncall) "" "s")
4127 (if (< ncall 2) "requires" "accepts only")
4128 "2-3")))
2aea6521
GM
4129 (push var byte-compile-bound-variables)
4130 (if (eq fun 'defconst)
4131 (push var byte-compile-const-variables))
1c393159 4132 (byte-compile-body-do-effect
1bc20d83
GM
4133 (list
4134 ;; Put the defined variable in this library's load-history entry
4135 ;; just as a real defvar would, but only in top-level forms.
3614fc84 4136 (when (and (cddr form) (null byte-compile-current-form))
b9598260 4137 `(setq current-load-list (cons ',var current-load-list)))
1bc20d83
GM
4138 (when (> (length form) 3)
4139 (when (and string (not (stringp string)))
0028351d
GM
4140 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
4141 fun var string))
1bc20d83 4142 `(put ',var 'variable-documentation ,string))
fef3407e 4143 (if (cddr form) ; `value' provided
8480fc7c 4144 (let ((byte-compile-not-obsolete-vars (list var)))
6b61353c
KH
4145 (if (eq fun 'defconst)
4146 ;; `defconst' sets `var' unconditionally.
4147 (let ((tmp (make-symbol "defconst-tmp-var")))
4148 `(funcall '(lambda (,tmp) (defconst ,var ,tmp))
4149 ,value))
4150 ;; `defvar' sets `var' only when unbound.
4151 `(if (not (default-boundp ',var)) (setq-default ,var ,value))))
6c2161c4
SM
4152 (when (eq fun 'defconst)
4153 ;; This will signal an appropriate error at runtime.
4154 `(eval ',form)))
1bc20d83 4155 `',var))))
1c393159
JB
4156
4157(defun byte-compile-autoload (form)
ccb3c8de 4158 (byte-compile-set-symbol-position 'autoload)
1c393159
JB
4159 (and (byte-compile-constp (nth 1 form))
4160 (byte-compile-constp (nth 5 form))
4161 (eval (nth 5 form)) ; macro-p
4162 (not (fboundp (eval (nth 1 form))))
4163 (byte-compile-warn
c5091f25 4164 "The compiler ignores `autoload' except at top level. You should
1c393159
JB
4165 probably put the autoload of the macro `%s' at top-level."
4166 (eval (nth 1 form))))
4167 (byte-compile-normal-call form))
4168
c5091f25 4169;; Lambdas in valid places are handled as special cases by various code.
1c393159 4170;; The ones that remain are errors.
9ace101c 4171(defun byte-compile-lambda-form (_form)
ccb3c8de 4172 (byte-compile-set-symbol-position 'lambda)
1c393159
JB
4173 (error "`lambda' used as function name is invalid"))
4174
5286a842 4175;; Compile normally, but deal with warnings for the function being defined.
977b50fb
SM
4176(put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
4177(defun byte-compile-file-form-defalias (form)
5286a842
RS
4178 (if (and (consp (cdr form)) (consp (nth 1 form))
4179 (eq (car (nth 1 form)) 'quote)
4180 (consp (cdr (nth 1 form)))
a7a7ddf1
RS
4181 (symbolp (nth 1 (nth 1 form))))
4182 (let ((constant
4183 (and (consp (nthcdr 2 form))
4184 (consp (nth 2 form))
4185 (eq (car (nth 2 form)) 'quote)
4186 (consp (cdr (nth 2 form)))
4187 (symbolp (nth 1 (nth 2 form))))))
6c2161c4 4188 (byte-compile-defalias-warn (nth 1 (nth 1 form)))
977b50fb
SM
4189 (push (cons (nth 1 (nth 1 form))
4190 (if constant (nth 1 (nth 2 form)) t))
4191 byte-compile-function-environment)))
a2b3fdbf 4192 ;; We used to just do: (byte-compile-normal-call form)
b7a5a208
SM
4193 ;; But it turns out that this fails to optimize the code.
4194 ;; So instead we now do the same as what other byte-hunk-handlers do,
4195 ;; which is to call back byte-compile-file-form and then return nil.
4196 ;; Except that we can't just call byte-compile-file-form since it would
4197 ;; call us right back.
4198 (byte-compile-keep-pending form)
4199 ;; Return nil so the form is not output twice.
4200 nil)
5286a842
RS
4201
4202;; Turn off warnings about prior calls to the function being defalias'd.
4203;; This could be smarter and compare those calls with
4204;; the function it is being aliased to.
6c2161c4 4205(defun byte-compile-defalias-warn (new)
5286a842
RS
4206 (let ((calls (assq new byte-compile-unresolved-functions)))
4207 (if calls
4208 (setq byte-compile-unresolved-functions
4209 (delq calls byte-compile-unresolved-functions)))))
3c9dc1cf
RS
4210
4211(byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
4212(defun byte-compile-no-warnings (form)
4213 (let (byte-compile-warnings)
a4f66531 4214 (byte-compile-form (cons 'progn (cdr form)))))
01e4a4fa
SM
4215
4216;; Warn about misuses of make-variable-buffer-local.
49fec531
SM
4217(byte-defop-compiler-1 make-variable-buffer-local
4218 byte-compile-make-variable-buffer-local)
01e4a4fa 4219(defun byte-compile-make-variable-buffer-local (form)
15ce9dcf 4220 (if (and (eq (car-safe (car-safe (cdr-safe form))) 'quote)
cf637a34 4221 (byte-compile-warning-enabled-p 'make-local))
01e4a4fa
SM
4222 (byte-compile-warn
4223 "`make-variable-buffer-local' should be called at toplevel"))
4224 (byte-compile-normal-call form))
4225(put 'make-variable-buffer-local
4226 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
4227(defun byte-compile-form-make-variable-buffer-local (form)
4228 (byte-compile-keep-pending form 'byte-compile-normal-call))
4229
1c393159
JB
4230\f
4231;;; tags
4232
4233;; Note: Most operations will strip off the 'TAG, but it speeds up
4234;; optimization to have the 'TAG as a part of the tag.
4235;; Tags will be (TAG . (tag-number . stack-depth)).
4236(defun byte-compile-make-tag ()
4237 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
4238
4239
4240(defun byte-compile-out-tag (tag)
4241 (setq byte-compile-output (cons tag byte-compile-output))
4242 (if (cdr (cdr tag))
4243 (progn
4244 ;; ## remove this someday
4245 (and byte-compile-depth
b38b1ec0
SM
4246 (not (= (cdr (cdr tag)) byte-compile-depth))
4247 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
1c393159
JB
4248 (setq byte-compile-depth (cdr (cdr tag))))
4249 (setcdr (cdr tag) byte-compile-depth)))
4250
4251(defun byte-compile-goto (opcode tag)
6c2161c4 4252 (push (cons opcode tag) byte-compile-output)
1c393159
JB
4253 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
4254 (1- byte-compile-depth)
4255 byte-compile-depth))
4256 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
4257 (1- byte-compile-depth))))
4258
b9598260
SM
4259(defun byte-compile-stack-adjustment (op operand)
4260 "Return the amount by which an operation adjusts the stack.
4261OP and OPERAND are as passed to `byte-compile-out'."
4262 (if (memq op '(byte-call byte-discardN byte-discardN-preserve-tos))
4263 ;; For calls, OPERAND is the number of args, so we pop OPERAND + 1
4264 ;; elements, and the push the result, for a total of -OPERAND.
4265 ;; For discardN*, of course, we just pop OPERAND elements.
4266 (- operand)
4267 (or (aref byte-stack+-info (symbol-value op))
4268 ;; Ops with a nil entry in `byte-stack+-info' are byte-codes
4269 ;; that take OPERAND values off the stack and push a result, for
4270 ;; a total of 1 - OPERAND
4271 (- 1 operand))))
7200d79c 4272
b9598260
SM
4273(defun byte-compile-out (op &optional operand)
4274 (push (cons op operand) byte-compile-output)
4275 (if (eq op 'byte-return)
4276 ;; This is actually an unnecessary case, because there should be no
4277 ;; more ops behind byte-return.
4278 (setq byte-compile-depth nil)
4279 (setq byte-compile-depth
4280 (+ byte-compile-depth (byte-compile-stack-adjustment op operand)))
4281 (setq byte-compile-maxdepth (max byte-compile-depth byte-compile-maxdepth))
4282 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
4283 ))
1c393159
JB
4284\f
4285;;; call tree stuff
4286
4287(defun byte-compile-annotate-call-tree (form)
4288 (let (entry)
4289 ;; annotate the current call
4290 (if (setq entry (assq (car form) byte-compile-call-tree))
4291 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
4292 (setcar (cdr entry)
4293 (cons byte-compile-current-form (nth 1 entry))))
4294 (setq byte-compile-call-tree
4295 (cons (list (car form) (list byte-compile-current-form) nil)
4296 byte-compile-call-tree)))
4297 ;; annotate the current function
4298 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
4299 (or (memq (car form) (nth 2 entry)) ;called
4300 (setcar (cdr (cdr entry))
4301 (cons (car form) (nth 2 entry))))
4302 (setq byte-compile-call-tree
4303 (cons (list byte-compile-current-form nil (list (car form)))
4304 byte-compile-call-tree)))
4305 ))
4306
52799cb8
RS
4307;; Renamed from byte-compile-report-call-tree
4308;; to avoid interfering with completion of byte-compile-file.
fd5285f3 4309;;;###autoload
52799cb8
RS
4310(defun display-call-tree (&optional filename)
4311 "Display a call graph of a specified file.
4312This lists which functions have been called, what functions called
4313them, and what functions they call. The list includes all functions
4314whose definitions have been compiled in this Emacs session, as well as
4315all functions called by those functions.
1c393159 4316
52799cb8
RS
4317The call graph does not include macros, inline functions, or
4318primitives that the byte-code interpreter knows about directly \(eq,
4319cons, etc.\).
1c393159
JB
4320
4321The call tree also lists those functions which are not known to be called
52799cb8
RS
4322\(that is, to which no calls have been compiled\), and which cannot be
4323invoked interactively."
1c393159
JB
4324 (interactive)
4325 (message "Generating call tree...")
4326 (with-output-to-temp-buffer "*Call-Tree*"
4327 (set-buffer "*Call-Tree*")
4328 (erase-buffer)
47cf9d3a 4329 (message "Generating call tree... (sorting on %s)"
1c393159
JB
4330 byte-compile-call-tree-sort)
4331 (insert "Call tree for "
4332 (cond ((null byte-compile-current-file) (or filename "???"))
4333 ((stringp byte-compile-current-file)
4334 byte-compile-current-file)
4335 (t (buffer-name byte-compile-current-file)))
4336 " sorted on "
4337 (prin1-to-string byte-compile-call-tree-sort)
4338 ":\n\n")
4339 (if byte-compile-call-tree-sort
4340 (setq byte-compile-call-tree
4341 (sort byte-compile-call-tree
2ec42da9
SM
4342 (case byte-compile-call-tree-sort
4343 (callers
4344 (lambda (x y) (< (length (nth 1 x))
4345 (length (nth 1 y)))))
4346 (calls
4347 (lambda (x y) (< (length (nth 2 x))
4348 (length (nth 2 y)))))
4349 (calls+callers
4350 (lambda (x y) (< (+ (length (nth 1 x))
4351 (length (nth 2 x)))
4352 (+ (length (nth 1 y))
4353 (length (nth 2 y))))))
4354 (name
4355 (lambda (x y) (string< (car x) (car y))))
4356 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
4357 byte-compile-call-tree-sort))))))
1c393159
JB
4358 (message "Generating call tree...")
4359 (let ((rest byte-compile-call-tree)
4360 (b (current-buffer))
4361 f p
4362 callers calls)
4363 (while rest
4364 (prin1 (car (car rest)) b)
4365 (setq callers (nth 1 (car rest))
4366 calls (nth 2 (car rest)))
4367 (insert "\t"
4368 (cond ((not (fboundp (setq f (car (car rest)))))
4369 (if (null f)
4370 " <top level>";; shouldn't insert nil then, actually -sk
4371 " <not defined>"))
4372 ((subrp (setq f (symbol-function f)))
4373 " <subr>")
4374 ((symbolp f)
4375 (format " ==> %s" f))
ed015bdd 4376 ((byte-code-function-p f)
1c393159
JB
4377 "<compiled function>")
4378 ((not (consp f))
4379 "<malformed function>")
4380 ((eq 'macro (car f))
ed015bdd 4381 (if (or (byte-code-function-p (cdr f))
1c393159
JB
4382 (assq 'byte-code (cdr (cdr (cdr f)))))
4383 " <compiled macro>"
4384 " <macro>"))
4385 ((assq 'byte-code (cdr (cdr f)))
4386 "<compiled lambda>")
4387 ((eq 'lambda (car f))
4388 "<function>")
4389 (t "???"))
4390 (format " (%d callers + %d calls = %d)"
4391 ;; Does the optimizer eliminate common subexpressions?-sk
4392 (length callers)
4393 (length calls)
4394 (+ (length callers) (length calls)))
4395 "\n")
4396 (if callers
4397 (progn
4398 (insert " called by:\n")
4399 (setq p (point))
4400 (insert " " (if (car callers)
4401 (mapconcat 'symbol-name callers ", ")
4402 "<top level>"))
4403 (let ((fill-prefix " "))
78bba1c8
TTN
4404 (fill-region-as-paragraph p (point)))
4405 (unless (= 0 (current-column))
4406 (insert "\n"))))
1c393159
JB
4407 (if calls
4408 (progn
4409 (insert " calls:\n")
4410 (setq p (point))
4411 (insert " " (mapconcat 'symbol-name calls ", "))
4412 (let ((fill-prefix " "))
78bba1c8
TTN
4413 (fill-region-as-paragraph p (point)))
4414 (unless (= 0 (current-column))
4415 (insert "\n"))))
1c393159
JB
4416 (setq rest (cdr rest)))
4417
4418 (message "Generating call tree...(finding uncalled functions...)")
4419 (setq rest byte-compile-call-tree)
416d3588 4420 (let (uncalled def)
1c393159
JB
4421 (while rest
4422 (or (nth 1 (car rest))
416d3588
GM
4423 (null (setq f (caar rest)))
4424 (progn
4425 (setq def (byte-compile-fdefinition f t))
4426 (and (eq (car-safe def) 'macro)
4427 (eq (car-safe (cdr-safe def)) 'lambda)
4428 (setq def (cdr def)))
4429 (functionp def))
4430 (progn
4431 (setq def (byte-compile-fdefinition f nil))
4432 (and (eq (car-safe def) 'macro)
4433 (eq (car-safe (cdr-safe def)) 'lambda)
4434 (setq def (cdr def)))
4435 (commandp def))
1c393159
JB
4436 (setq uncalled (cons f uncalled)))
4437 (setq rest (cdr rest)))
4438 (if uncalled
4439 (let ((fill-prefix " "))
4440 (insert "Noninteractive functions not known to be called:\n ")
4441 (setq p (point))
4442 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
416d3588
GM
4443 (fill-region-as-paragraph p (point))))))
4444 (message "Generating call tree...done.")))
1c393159
JB
4445
4446\f
814c447f 4447;;;###autoload
7e7d0f8b
RS
4448(defun batch-byte-compile-if-not-done ()
4449 "Like `byte-compile-file' but doesn't recompile if already up to date.
4450Use this from the command line, with `-batch';
4451it won't work in an interactive Emacs."
4452 (batch-byte-compile t))
4453
1c393159
JB
4454;;; by crl@newton.purdue.edu
4455;;; Only works noninteractively.
fd5285f3 4456;;;###autoload
7e7d0f8b 4457(defun batch-byte-compile (&optional noforce)
52799cb8
RS
4458 "Run `byte-compile-file' on the files remaining on the command line.
4459Use this from the command line, with `-batch';
4460it won't work in an interactive Emacs.
4461Each file is processed even if an error occurred previously.
7e7d0f8b
RS
4462For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4463If NOFORCE is non-nil, don't recompile a file that seems to be
4464already up-to-date."
2ec42da9
SM
4465 ;; command-line-args-left is what is left of the command line, from
4466 ;; startup.el.
1c393159
JB
4467 (defvar command-line-args-left) ;Avoid 'free variable' warning
4468 (if (not noninteractive)
52799cb8 4469 (error "`batch-byte-compile' is to be used only with -batch"))
ca105506 4470 (let ((error nil))
1c393159
JB
4471 (while command-line-args-left
4472 (if (file-directory-p (expand-file-name (car command-line-args-left)))
7e7d0f8b 4473 ;; Directory as argument.
ca105506
SM
4474 (let (source dest)
4475 (dolist (file (directory-files (car command-line-args-left)))
4476 (if (and (string-match emacs-lisp-file-regexp file)
4477 (not (auto-save-file-name-p file))
4478 (setq source
4479 (expand-file-name file
1c3b663f 4480 (car command-line-args-left)))
ca105506
SM
4481 (setq dest (byte-compile-dest-file source))
4482 (file-exists-p dest)
4483 (file-newer-than-file-p source dest))
4484 (if (null (batch-byte-compile-file source))
4485 (setq error t)))))
7e7d0f8b
RS
4486 ;; Specific file argument
4487 (if (or (not noforce)
ca105506
SM
4488 (let* ((source (car command-line-args-left))
4489 (dest (byte-compile-dest-file source)))
4490 (or (not (file-exists-p dest))
4491 (file-newer-than-file-p source dest))))
7e7d0f8b 4492 (if (null (batch-byte-compile-file (car command-line-args-left)))
ca105506 4493 (setq error t))))
1c393159 4494 (setq command-line-args-left (cdr command-line-args-left)))
ca105506 4495 (kill-emacs (if error 1 0))))
1c393159 4496
ca105506 4497(defun batch-byte-compile-file (file)
6b61353c 4498 (if debug-on-error
ca105506 4499 (byte-compile-file file)
6b61353c 4500 (condition-case err
ca105506 4501 (byte-compile-file file)
6b61353c
KH
4502 (file-error
4503 (message (if (cdr err)
4504 ">>Error occurred processing %s: %s (%s)"
d09b1c02 4505 ">>Error occurred processing %s: %s")
ca105506 4506 file
6b61353c
KH
4507 (get (car err) 'error-message)
4508 (prin1-to-string (cdr err)))
ca105506
SM
4509 (let ((destfile (byte-compile-dest-file file)))
4510 (if (file-exists-p destfile)
4511 (delete-file destfile)))
6b61353c
KH
4512 nil)
4513 (error
4514 (message (if (cdr err)
4515 ">>Error occurred processing %s: %s (%s)"
1c393159 4516 ">>Error occurred processing %s: %s")
ca105506 4517 file
6b61353c
KH
4518 (get (car err) 'error-message)
4519 (prin1-to-string (cdr err)))
4520 nil))))
1c393159 4521
49fec531
SM
4522(defun byte-compile-refresh-preloaded ()
4523 "Reload any Lisp file that was changed since Emacs was dumped.
4524Use with caution."
4525 (let* ((argv0 (car command-line-args))
4526 (emacs-file (executable-find argv0)))
4527 (if (not (and emacs-file (file-executable-p emacs-file)))
4528 (message "Can't find %s to refresh preloaded Lisp files" argv0)
4529 (dolist (f (reverse load-history))
4530 (setq f (car f))
4531 (if (string-match "elc\\'" f) (setq f (substring f 0 -1)))
4532 (when (and (file-readable-p f)
d032d5e7
SM
4533 (file-newer-than-file-p f emacs-file)
4534 ;; Don't reload the source version of the files below
4535 ;; because that causes subsequent byte-compilation to
4536 ;; be a lot slower and need a higher max-lisp-eval-depth,
4537 ;; so it can cause recompilation to fail.
4538 (not (member (file-name-nondirectory f)
4539 '("pcase.el" "bytecomp.el" "macroexp.el"
4540 "cconv.el" "byte-opt.el"))))
49fec531
SM
4541 (message "Reloading stale %s" (file-name-nondirectory f))
4542 (condition-case nil
4543 (load f 'noerror nil 'nosuffix)
4544 ;; Probably shouldn't happen, but in case of an error, it seems
4545 ;; at least as useful to ignore it as it is to stop compilation.
4546 (error nil)))))))
4547
e9681c45 4548;;;###autoload
6f8e3590 4549(defun batch-byte-recompile-directory (&optional arg)
4f6d5bf0 4550 "Run `byte-recompile-directory' on the dirs remaining on the command line.
79c6071d 4551Must be used only with `-batch', and kills Emacs on completion.
defe3b41
EZ
4552For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4553
4554Optional argument ARG is passed as second argument ARG to
516b3653 4555`byte-recompile-directory'; see there for its possible values
defe3b41 4556and corresponding effects."
e27c3564
JB
4557 ;; command-line-args-left is what is left of the command line (startup.el)
4558 (defvar command-line-args-left) ;Avoid 'free variable' warning
4559 (if (not noninteractive)
4560 (error "batch-byte-recompile-directory is to be used only with -batch"))
4561 (or command-line-args-left
4562 (setq command-line-args-left '(".")))
4563 (while command-line-args-left
6f8e3590 4564 (byte-recompile-directory (car command-line-args-left) arg)
e27c3564
JB
4565 (setq command-line-args-left (cdr command-line-args-left)))
4566 (kill-emacs 0))
4567
1c393159 4568(provide 'byte-compile)
200503bb 4569(provide 'bytecomp)
1c393159
JB
4570
4571\f
4572;;; report metering (see the hacks in bytecode.c)
4573
08d21785 4574(defvar byte-code-meter)
52799cb8 4575(defun byte-compile-report-ops ()
5a972c36
GM
4576 (or (boundp 'byte-metering-on)
4577 (error "You must build Emacs with -DBYTE_CODE_METER to use this"))
52799cb8
RS
4578 (with-output-to-temp-buffer "*Meter*"
4579 (set-buffer "*Meter*")
4580 (let ((i 0) n op off)
4581 (while (< i 256)
4582 (setq n (aref (aref byte-code-meter 0) i)
4583 off nil)
4584 (if t ;(not (zerop n))
4585 (progn
4586 (setq op i)
4587 (setq off nil)
4588 (cond ((< op byte-nth)
4589 (setq off (logand op 7))
4590 (setq op (logand op 248)))
4591 ((>= op byte-constant)
4592 (setq off (- op byte-constant)
4593 op byte-constant)))
4594 (setq op (aref byte-code-vector op))
4595 (insert (format "%-4d" i))
4596 (insert (symbol-name op))
4597 (if off (insert " [" (int-to-string off) "]"))
4598 (indent-to 40)
4599 (insert (int-to-string n) "\n")))
4600 (setq i (1+ i))))))
1c393159
JB
4601\f
4602;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4603;; itself, compile some of its most used recursive functions (at load time).
4604;;
4605(eval-when-compile
591655c7
SM
4606 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4607 (assq 'byte-code (symbol-function 'byte-compile-form))
4608 (let ((byte-optimize nil) ; do it fast
4609 (byte-compile-warnings nil))
86da2828
GM
4610 (mapc (lambda (x)
4611 (or noninteractive (message "compiling %s..." x))
4612 (byte-compile x)
4613 (or noninteractive (message "compiling %s...done" x)))
4614 '(byte-compile-normal-call
4615 byte-compile-form
4616 byte-compile-body
4617 ;; Inserted some more than necessary, to speed it up.
4618 byte-compile-top-level
4619 byte-compile-out-toplevel
4620 byte-compile-constant
4621 byte-compile-variable-ref))))
591655c7 4622 nil)
fd5285f3 4623
3433c43f
DL
4624(run-hooks 'bytecomp-load-hook)
4625
fd5285f3 4626;;; bytecomp.el ends here