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