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