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