ChangeLog fix
[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
1227
52799cb8 1228;; Warn if the form is calling a function with the wrong number of arguments.
1c393159 1229(defun byte-compile-callargs-warn (form)
1c393159
JB
1230 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1231 (byte-compile-fdefinition (car form) t)))
a7a7ddf1 1232 (sig (if (and def (not (eq def t)))
416d3588
GM
1233 (progn
1234 (and (eq (car-safe def) 'macro)
1235 (eq (car-safe (cdr-safe def)) 'lambda)
1236 (setq def (cdr def)))
1237 (byte-compile-arglist-signature
1238 (if (memq (car-safe def) '(declared lambda))
1239 (nth 1 def)
1240 (if (byte-code-function-p def)
1241 (aref def 0)
1242 '(&rest def)))))
ed62683d
DL
1243 (if (and (fboundp (car form))
1244 (subrp (symbol-function (car form))))
1245 (subr-arity (symbol-function (car form))))))
1c393159 1246 (ncall (length (cdr form))))
ed62683d
DL
1247 ;; Check many or unevalled from subr-arity.
1248 (if (and (cdr-safe sig)
1249 (not (numberp (cdr sig))))
1250 (setcdr sig nil))
1c393159 1251 (if sig
ccb3c8de 1252 (when (or (< ncall (car sig))
1c393159 1253 (and (cdr sig) (> ncall (cdr sig))))
ccb3c8de
CW
1254 (byte-compile-set-symbol-position (car form))
1255 (byte-compile-warn
1256 "%s called with %d argument%s, but %s %s"
1257 (car form) ncall
1258 (if (= 1 ncall) "" "s")
1259 (if (< ncall (car sig))
1260 "requires"
1261 "accepts only")
ba76e7fa 1262 (byte-compile-arglist-signature-string sig))))
6b61353c 1263 (byte-compile-format-warn form)
ba76e7fa
SM
1264 ;; Check to see if the function will be available at runtime
1265 ;; and/or remember its arity if it's unknown.
a7a7ddf1 1266 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
6b61353c 1267 (not (memq (car form) byte-compile-noruntime-functions)))
61b108cc
SM
1268 (eq (car form) byte-compile-current-form) ; ## This doesn't work
1269 ; with recursion.
ba76e7fa
SM
1270 ;; It's a currently-undefined function.
1271 ;; Remember number of args in call.
1272 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1273 (n (length (cdr form))))
1274 (if cons
1275 (or (memq n (cdr cons))
1276 (setcdr cons (cons n (cdr cons))))
977b50fb
SM
1277 (push (list (car form) n)
1278 byte-compile-unresolved-functions))))))
1c393159 1279
6b61353c
KH
1280(defun byte-compile-format-warn (form)
1281 "Warn if FORM is `format'-like with inconsistent args.
1282Applies if head of FORM is a symbol with non-nil property
1283`byte-compile-format-like' and first arg is a constant string.
1284Then check the number of format fields matches the number of
1285extra args."
1286 (when (and (symbolp (car form))
1287 (stringp (nth 1 form))
1288 (get (car form) 'byte-compile-format-like))
1289 (let ((nfields (with-temp-buffer
1290 (insert (nth 1 form))
b8104a2b 1291 (goto-char (point-min))
6b61353c
KH
1292 (let ((n 0))
1293 (while (re-search-forward "%." nil t)
1294 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1295 (setq n (1+ n))))
1296 n)))
1297 (nargs (- (length form) 2)))
1298 (unless (= nargs nfields)
1299 (byte-compile-warn
1300 "`%s' called with %d args to fill %d format field(s)" (car form)
1301 nargs nfields)))))
1302
1303(dolist (elt '(format message error))
1304 (put elt 'byte-compile-format-like t))
1305
11efeb9b
RS
1306;; Warn if a custom definition fails to specify :group.
1307(defun byte-compile-nogroup-warn (form)
ab5111e3
SM
1308 (if (and (memq (car form) '(custom-declare-face custom-declare-variable))
1309 byte-compile-current-group)
1310 ;; The group will be provided implicitly.
1311 nil
1312 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1313 (name (cadr form)))
1314 (or (not (eq (car-safe name) 'quote))
3ab6a7ae
SM
1315 (and (eq (car form) 'custom-declare-group)
1316 (equal name ''emacs))
1317 (plist-get keyword-args :group)
1318 (not (and (consp name) (eq (car name) 'quote)))
1319 (byte-compile-warn
1320 "%s for `%s' fails to specify containing group"
1321 (cdr (assq (car form)
ab5111e3
SM
1322 '((custom-declare-group . defgroup)
1323 (custom-declare-face . defface)
1324 (custom-declare-variable . defcustom))))
1325 (cadr name)))
1326 ;; Update the current group, if needed.
2ec42da9 1327 (if (and byte-compile-current-file ;Only when compiling a whole file.
ab5111e3
SM
1328 (eq (car form) 'custom-declare-group)
1329 (eq (car-safe name) 'quote))
1330 (setq byte-compile-current-group (cadr name))))))
11efeb9b 1331
52799cb8
RS
1332;; Warn if the function or macro is being redefined with a different
1333;; number of arguments.
61b108cc
SM
1334(defun byte-compile-arglist-warn (name arglist macrop)
1335 (let* ((old (byte-compile-fdefinition name macrop))
7d3b9d44
GM
1336 (initial (and macrop
1337 (cdr (assq name
1338 byte-compile-initial-macro-environment)))))
1339 ;; Assumes an element of b-c-i-macro-env that is a symbol points
1340 ;; to a defined function. (Bug#8646)
1341 (and initial (symbolp initial)
410c42c5 1342 (setq old (byte-compile-fdefinition initial nil)))
a7a7ddf1 1343 (if (and old (not (eq old t)))
416d3588
GM
1344 (progn
1345 (and (eq 'macro (car-safe old))
1346 (eq 'lambda (car-safe (cdr-safe old)))
1347 (setq old (cdr old)))
1348 (let ((sig1 (byte-compile-arglist-signature
b38b1ec0
SM
1349 (pcase old
1350 (`(lambda ,args . ,_) args)
23aba0ea 1351 (`(closure ,_ ,args . ,_) args)
b38b1ec0
SM
1352 ((pred byte-code-function-p) (aref old 0))
1353 (t '(&rest def)))))
61b108cc 1354 (sig2 (byte-compile-arglist-signature arglist)))
416d3588 1355 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
a9de04fa 1356 (byte-compile-set-symbol-position name)
416d3588
GM
1357 (byte-compile-warn
1358 "%s %s used to take %s %s, now takes %s"
61b108cc 1359 (if macrop "macro" "function")
a9de04fa 1360 name
416d3588
GM
1361 (byte-compile-arglist-signature-string sig1)
1362 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1363 (byte-compile-arglist-signature-string sig2)))))
1c393159 1364 ;; This is the first definition. See if previous calls are compatible.
a9de04fa 1365 (let ((calls (assq name byte-compile-unresolved-functions))
1c393159 1366 nums sig min max)
a9de04fa
SM
1367 (when calls
1368 (when (and (symbolp name)
7abaf5cc 1369 (eq (function-get name 'byte-optimizer)
a9de04fa
SM
1370 'byte-compile-inline-expand))
1371 (byte-compile-warn "defsubst `%s' was used before it was defined"
1372 name))
61b108cc 1373 (setq sig (byte-compile-arglist-signature arglist)
a9de04fa
SM
1374 nums (sort (copy-sequence (cdr calls)) (function <))
1375 min (car nums)
1376 max (car (nreverse nums)))
1377 (when (or (< min (car sig))
1378 (and (cdr sig) (> max (cdr sig))))
1379 (byte-compile-set-symbol-position name)
1380 (byte-compile-warn
1381 "%s being defined to take %s%s, but was previously called with %s"
1382 name
1383 (byte-compile-arglist-signature-string sig)
1384 (if (equal sig '(1 . 1)) " arg" " args")
1385 (byte-compile-arglist-signature-string (cons min max))))
1386
1387 (setq byte-compile-unresolved-functions
1388 (delq calls byte-compile-unresolved-functions)))))))
1c393159 1389
95c997fa
RS
1390(defvar byte-compile-cl-functions nil
1391 "List of functions defined in CL.")
1392
3f12e5bd
GM
1393;; Can't just add this to cl-load-hook, because that runs just before
1394;; the forms from cl.el get added to load-history.
95c997fa
RS
1395(defun byte-compile-find-cl-functions ()
1396 (unless byte-compile-cl-functions
1397 (dolist (elt load-history)
3f12e5bd
GM
1398 (and (byte-compile-cl-file-p (car elt))
1399 (dolist (e (cdr elt))
1400 ;; Includes the cl-foo functions that cl autoloads.
1401 (when (memq (car-safe e) '(autoload defun))
1402 (push (cdr e) byte-compile-cl-functions)))))))
95c997fa 1403
4795d1c7
RS
1404(defun byte-compile-cl-warn (form)
1405 "Warn if FORM is a call of a function from the CL package."
95c997fa
RS
1406 (let ((func (car-safe form)))
1407 (if (and byte-compile-cl-functions
1408 (memq func byte-compile-cl-functions)
6b61353c 1409 ;; Aliases which won't have been expanded at this point.
4795d1c7
RS
1410 ;; These aren't all aliases of subrs, so not trivial to
1411 ;; avoid hardwiring the list.
1412 (not (memq func
bb3faf5b 1413 '(cl--block-wrapper cl--block-throw
9cb9a7bc 1414 multiple-value-call nth-value
95c997fa 1415 copy-seq first second rest endp cl-member
d1a57439
RS
1416 ;; These are included in generated code
1417 ;; that can't be called except at compile time
1418 ;; or unless cl is loaded anyway.
bb3faf5b 1419 cl--defsubst-expand cl-struct-setf-expander
8f876842
RS
1420 ;; These would sometimes be warned about
1421 ;; but such warnings are never useful,
1422 ;; so don't warn about them.
118861df 1423 macroexpand cl-macroexpand-all
bb3faf5b 1424 cl--compiling-file))))
7a16788b 1425 (byte-compile-warn "function `%s' from cl package called at runtime"
4795d1c7
RS
1426 func)))
1427 form)
1428
a586093f 1429(defun byte-compile-print-syms (str1 strn syms)
ccb3c8de
CW
1430 (when syms
1431 (byte-compile-set-symbol-position (car syms) t))
b8175fe6
GM
1432 (cond ((and (cdr syms) (not noninteractive))
1433 (let* ((str strn)
1434 (L (length str))
1435 s)
1436 (while syms
1437 (setq s (symbol-name (pop syms))
1438 L (+ L (length s) 2))
1439 (if (< L (1- fill-column))
1440 (setq str (concat str " " s (and syms ",")))
1441 (setq str (concat str "\n " s (and syms ","))
1442 L (+ (length s) 4))))
1443 (byte-compile-warn "%s" str)))
1444 ((cdr syms)
1f006824 1445 (byte-compile-warn "%s %s"
b8175fe6
GM
1446 strn
1447 (mapconcat #'symbol-name syms ", ")))
1448
1449 (syms
1450 (byte-compile-warn str1 (car syms)))))
a586093f 1451
1f006824 1452;; If we have compiled any calls to functions which are not known to be
52799cb8
RS
1453;; defined, issue a warning enumerating them.
1454;; `unresolved' in the list `byte-compile-warnings' disables this.
1c393159 1455(defun byte-compile-warn-about-unresolved-functions ()
cf637a34 1456 (when (byte-compile-warning-enabled-p 'unresolved)
b8175fe6 1457 (let ((byte-compile-current-form :end)
a586093f
SM
1458 (noruntime nil)
1459 (unresolved nil))
1460 ;; Separate the functions that will not be available at runtime
1461 ;; from the truly unresolved ones.
1462 (dolist (f byte-compile-unresolved-functions)
1463 (setq f (car f))
1464 (if (fboundp f) (push f noruntime) (push f unresolved)))
1465 ;; Complain about the no-run-time functions
1466 (byte-compile-print-syms
b8175fe6
GM
1467 "the function `%s' might not be defined at runtime."
1468 "the following functions might not be defined at runtime:"
a586093f
SM
1469 noruntime)
1470 ;; Complain about the unresolved functions
1471 (byte-compile-print-syms
b8175fe6
GM
1472 "the function `%s' is not known to be defined."
1473 "the following functions are not known to be defined:"
a586093f 1474 unresolved)))
1c393159
JB
1475 nil)
1476
1477\f
6876a58d
SM
1478;; Dynamically bound in byte-compile-from-buffer.
1479;; NB also used in cl.el and cl-macs.el.
1480(defvar byte-compile--outbuffer)
1481
1c393159 1482(defmacro byte-compile-close-variables (&rest body)
876c194c 1483 (declare (debug t))
6876a58d
SM
1484 `(let (;;
1485 ;; Close over these variables to encapsulate the
1486 ;; compilation state
1487 ;;
1488 (byte-compile-macro-environment
1489 ;; Copy it because the compiler may patch into the
1490 ;; macroenvironment.
1491 (copy-alist byte-compile-initial-macro-environment))
1492 (byte-compile--outbuffer nil)
1493 (byte-compile-function-environment nil)
1494 (byte-compile-bound-variables nil)
208d0342 1495 (byte-compile-lexical-variables nil)
6876a58d
SM
1496 (byte-compile-const-variables nil)
1497 (byte-compile-free-references nil)
1498 (byte-compile-free-assignments nil)
1499 ;;
1500 ;; Close over these variables so that `byte-compiler-options'
1501 ;; can change them on a per-file basis.
1502 ;;
1503 (byte-compile-verbose byte-compile-verbose)
1504 (byte-optimize byte-optimize)
1505 (byte-compile-dynamic byte-compile-dynamic)
1506 (byte-compile-dynamic-docstrings
1507 byte-compile-dynamic-docstrings)
1508 ;; (byte-compile-generate-emacs19-bytecodes
1509 ;; byte-compile-generate-emacs19-bytecodes)
1510 (byte-compile-warnings byte-compile-warnings)
1511 )
1512 ,@body))
1c393159 1513
1c393159 1514(defmacro displaying-byte-compile-warnings (&rest body)
876c194c 1515 (declare (debug t))
4390021b
RS
1516 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1517 (warning-series-started
1518 (and (markerp warning-series)
1519 (eq (marker-buffer warning-series)
7847454a 1520 (get-buffer byte-compile-log-buffer)))))
95c997fa 1521 (byte-compile-find-cl-functions)
4390021b
RS
1522 (if (or (eq warning-series 'byte-compile-warning-series)
1523 warning-series-started)
1524 ;; warning-series does come from compilation,
1525 ;; so don't bind it, but maybe do set it.
1526 (let (tem)
1527 ;; Log the file name. Record position of that text.
1528 (setq tem (byte-compile-log-file))
1529 (unless warning-series-started
1530 (setq warning-series (or tem 'byte-compile-warning-series)))
1531 (if byte-compile-debug
1532 (funcall --displaying-byte-compile-warnings-fn)
1533 (condition-case error-info
1534 (funcall --displaying-byte-compile-warnings-fn)
1535 (error (byte-compile-report-error error-info)))))
1536 ;; warning-series does not come from compilation, so bind it.
1537 (let ((warning-series
1538 ;; Log the file name. Record position of that text.
1539 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1540 (if byte-compile-debug
22788fb8 1541 (funcall --displaying-byte-compile-warnings-fn)
4390021b
RS
1542 (condition-case error-info
1543 (funcall --displaying-byte-compile-warnings-fn)
1544 (error (byte-compile-report-error error-info))))))))
1c393159 1545\f
fd5285f3 1546;;;###autoload
9742dbc0
RS
1547(defun byte-force-recompile (directory)
1548 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1549Files in subdirectories of DIRECTORY are processed also."
c0f43df5 1550 (interactive "DByte force recompile (directory): ")
9742dbc0
RS
1551 (byte-recompile-directory directory nil t))
1552
1553;;;###autoload
ca105506
SM
1554(defun byte-recompile-directory (directory &optional arg force)
1555 "Recompile every `.el' file in DIRECTORY that needs recompilation.
2b9c3b12 1556This happens when a `.elc' file exists but is older than the `.el' file.
ca105506 1557Files in subdirectories of DIRECTORY are processed also.
1c393159 1558
c4f2cabd 1559If the `.elc' file does not exist, normally this function *does not*
1c3b663f 1560compile the corresponding `.el' file. However, if the prefix argument
ca105506
SM
1561ARG is 0, that means do compile all those files. A nonzero
1562ARG means ask the user, for each such `.el' file, whether to
1563compile it. A nonzero ARG also means ask about each subdirectory
1c3b663f
GM
1564before scanning it.
1565
ca105506 1566If the third argument FORCE is non-nil, recompile every `.el' file
1c3b663f 1567that already has a `.elc' file."
1c393159 1568 (interactive "DByte recompile directory: \nP")
ca105506 1569 (if arg (setq arg (prefix-numeric-value arg)))
e27c3564
JB
1570 (if noninteractive
1571 nil
1572 (save-some-buffers)
ba901388 1573 (force-mode-line-update))
7847454a 1574 (with-current-buffer (get-buffer-create byte-compile-log-buffer)
ca105506 1575 (setq default-directory (expand-file-name directory))
977f31f8
RS
1576 ;; compilation-mode copies value of default-directory.
1577 (unless (eq major-mode 'compilation-mode)
1578 (compilation-mode))
ca105506 1579 (let ((directories (list default-directory))
4eb4926c
RS
1580 (default-directory default-directory)
1581 (skip-count 0)
1582 (fail-count 0)
1583 (file-count 0)
1584 (dir-count 0)
1585 last-dir)
1586 (displaying-byte-compile-warnings
ca105506
SM
1587 (while directories
1588 (setq directory (car directories))
1589 (message "Checking %s..." directory)
1590 (dolist (file (directory-files directory))
1591 (let ((source (expand-file-name file directory)))
1592 (if (and (not (member file '("RCS" "CVS")))
1593 (not (eq ?\. (aref file 0)))
1594 (file-directory-p source)
1595 (not (file-symlink-p source)))
1596 ;; This file is a subdirectory. Handle them differently.
1597 (when (or (null arg) (eq 0 arg)
1598 (y-or-n-p (concat "Check " source "? ")))
1599 (setq directories (nconc directories (list source))))
1600 ;; It is an ordinary file. Decide whether to compile it.
1601 (if (and (string-match emacs-lisp-file-regexp source)
343a2aef 1602 ;; The next 2 tests avoid compiling lock files
ca105506 1603 (file-readable-p source)
343a2aef 1604 (not (string-match "\\`\\.#" file))
ca105506
SM
1605 (not (auto-save-file-name-p source))
1606 (not (string-equal dir-locals-file
1607 (file-name-nondirectory source))))
56bc1586 1608 (progn (cl-incf
f58e0fd5
SM
1609 (pcase (byte-recompile-file source force arg)
1610 (`no-byte-compile skip-count)
1611 (`t file-count)
1612 (_ fail-count)))
ca105506
SM
1613 (or noninteractive
1614 (message "Checking %s..." directory))
1615 (if (not (eq last-dir directory))
1616 (setq last-dir directory
1617 dir-count (1+ dir-count)))
1618 )))))
1619 (setq directories (cdr directories))))
4eb4926c
RS
1620 (message "Done (Total of %d file%s compiled%s%s%s)"
1621 file-count (if (= file-count 1) "" "s")
1622 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1623 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1c3b663f
GM
1624 (if (> dir-count 1)
1625 (format " in %d directories" dir-count) "")))))
1c393159 1626
fef3407e 1627(defvar no-byte-compile nil
2b9c3b12 1628 "Non-nil to prevent byte-compiling of Emacs Lisp code.
fef3407e
SM
1629This is normally set in local file variables at the end of the elisp file:
1630
ce5b520a 1631\;; Local Variables:\n;; no-byte-compile: t\n;; End: ") ;Backslash for compile-main.
631c8020 1632;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
fef3407e 1633
ca105506
SM
1634(defun byte-recompile-file (filename &optional force arg load)
1635 "Recompile FILENAME file if it needs recompilation.
430e7297
JD
1636This happens when its `.elc' file is older than itself.
1637
3c3cda1a
GM
1638If the `.elc' file exists and is up-to-date, normally this function
1639*does not* compile FILENAME. If the prefix argument FORCE is non-nil,
1640however, it compiles FILENAME even if the destination already
1641exists and is up-to-date.
430e7297 1642
3c3cda1a
GM
1643If the `.elc' file does not exist, normally this function *does not*
1644compile FILENAME. If optional argument ARG is 0, it compiles
1645the input file even if the `.elc' file does not exist.
1646Any other non-nil value of ARG means to ask the user.
430e7297 1647
3c3cda1a 1648If optional argument LOAD is non-nil, loads the file after compiling.
430e7297 1649
3c3cda1a
GM
1650If compilation is needed, this functions returns the result of
1651`byte-compile-file'; otherwise it returns 'no-byte-compile."
430e7297 1652 (interactive
ca105506
SM
1653 (let ((file buffer-file-name)
1654 (file-name nil)
1655 (file-dir nil))
1656 (and file
1657 (derived-mode-p 'emacs-lisp-mode)
1658 (setq file-name (file-name-nondirectory file)
1659 file-dir (file-name-directory file)))
430e7297
JD
1660 (list (read-file-name (if current-prefix-arg
1661 "Byte compile file: "
1662 "Byte recompile file: ")
ca105506 1663 file-dir file-name nil)
430e7297 1664 current-prefix-arg)))
ca105506 1665 (let ((dest (byte-compile-dest-file filename))
430e7297 1666 ;; Expand now so we get the current buffer's defaults
ca105506
SM
1667 (filename (expand-file-name filename)))
1668 (if (if (file-exists-p dest)
430e7297
JD
1669 ;; File was already compiled
1670 ;; Compile if forced to, or filename newer
ca105506
SM
1671 (or force
1672 (file-newer-than-file-p filename dest))
1673 (and arg
1674 (or (eq 0 arg)
fa14dc18 1675 (y-or-n-p (concat "Compile "
ca105506 1676 filename "? ")))))
430e7297
JD
1677 (progn
1678 (if (and noninteractive (not byte-compile-verbose))
ca105506
SM
1679 (message "Compiling %s..." filename))
1680 (byte-compile-file filename load))
e5b19827
AS
1681 (when load
1682 (load (if (file-exists-p dest) dest filename)))
430e7297
JD
1683 'no-byte-compile)))
1684
fd743628
GM
1685(defvar byte-compile-level 0 ; bug#13787
1686 "Depth of a recursive byte compilation.")
1687
fd5285f3 1688;;;###autoload
ca105506
SM
1689(defun byte-compile-file (filename &optional load)
1690 "Compile a file of Lisp code named FILENAME into a file of byte code.
1691The output file's name is generated by passing FILENAME to the
f279aaab 1692function `byte-compile-dest-file' (which see).
3614fc84 1693With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
d90a41e8 1694The value is non-nil if there were no errors, nil if errors."
1c393159
JB
1695;; (interactive "fByte compile file: \nP")
1696 (interactive
ca105506
SM
1697 (let ((file buffer-file-name)
1698 (file-name nil)
1699 (file-dir nil))
1700 (and file
9ace101c 1701 (derived-mode-p 'emacs-lisp-mode)
ca105506
SM
1702 (setq file-name (file-name-nondirectory file)
1703 file-dir (file-name-directory file)))
52799cb8
RS
1704 (list (read-file-name (if current-prefix-arg
1705 "Byte compile and load file: "
1706 "Byte compile file: ")
ca105506 1707 file-dir file-name nil)
fd5285f3 1708 current-prefix-arg)))
1c393159 1709 ;; Expand now so we get the current buffer's defaults
ca105506 1710 (setq filename (expand-file-name filename))
1c393159
JB
1711
1712 ;; If we're compiling a file that's in a buffer and is modified, offer
1713 ;; to save it first.
1714 (or noninteractive
ca105506 1715 (let ((b (get-file-buffer (expand-file-name filename))))
1c393159 1716 (if (and b (buffer-modified-p b)
a586093f 1717 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
008e2c2a 1718 (with-current-buffer b (save-buffer)))))
1c393159 1719
4390021b
RS
1720 ;; Force logging of the file name for each file compiled.
1721 (setq byte-compile-last-logged-file nil)
ca105506 1722 (let ((byte-compile-current-file filename)
ab5111e3 1723 (byte-compile-current-group nil)
dc14ae36 1724 (set-auto-coding-for-load t)
d82e848c
RS
1725 target-file input-buffer output-buffer
1726 byte-compile-dest-file)
ca105506 1727 (setq target-file (byte-compile-dest-file filename))
d82e848c 1728 (setq byte-compile-dest-file target-file)
ea1cb2bd 1729 (with-current-buffer
fd743628
GM
1730 ;; It would be cleaner to use a temp buffer, but if there was
1731 ;; an error, we leave this buffer around for diagnostics.
1732 ;; Its name is documented in the lispref.
1733 (setq input-buffer (get-buffer-create
1734 (concat " *Compiler Input*"
1735 (if (zerop byte-compile-level) ""
1736 (format "-%s" byte-compile-level)))))
1c393159 1737 (erase-buffer)
7a28e3b1 1738 (setq buffer-file-coding-system nil)
746dd298 1739 ;; Always compile an Emacs Lisp file as multibyte
b92dd692 1740 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
746dd298 1741 (set-buffer-multibyte t)
ca105506 1742 (insert-file-contents filename)
844da0ff
KH
1743 ;; Mimic the way after-insert-file-set-coding can make the
1744 ;; buffer unibyte when visiting this file.
7a28e3b1
RS
1745 (when (or (eq last-coding-system-used 'no-conversion)
1746 (eq (coding-system-type last-coding-system-used) 5))
1747 ;; For coding systems no-conversion and raw-text...,
1748 ;; edit the buffer as unibyte.
1749 (set-buffer-multibyte nil))
1c393159
JB
1750 ;; Run hooks including the uncompression hook.
1751 ;; If they change the file name, then change it for the output also.
2ee3d7f0
SM
1752 (let ((buffer-file-name filename)
1753 (dmm (default-value 'major-mode))
1754 ;; Ignore unsafe local variables.
1755 ;; We only care about a few of them for our purposes.
1756 (enable-local-variables :safe)
1757 (enable-local-eval nil))
1758 (unwind-protect
1759 (progn
1760 (setq-default major-mode 'emacs-lisp-mode)
1761 ;; Arg of t means don't alter enable-local-variables.
1762 (normal-mode t))
1763 (setq-default major-mode dmm))
7d5944b9
GM
1764 ;; There may be a file local variable setting (bug#10419).
1765 (setq buffer-read-only nil
1766 filename buffer-file-name))
002c019c
SM
1767 ;; Don't inherit lexical-binding from caller (bug#12938).
1768 (unless (local-variable-p 'lexical-binding)
1769 (setq-local lexical-binding nil))
cd891e68 1770 ;; Set the default directory, in case an eval-when-compile uses it.
ca105506 1771 (setq default-directory (file-name-directory filename)))
3614fc84
GM
1772 ;; Check if the file's local variables explicitly specify not to
1773 ;; compile this file.
fef3407e 1774 (if (with-current-buffer input-buffer no-byte-compile)
3614fc84 1775 (progn
6b61353c 1776 ;; (message "%s not compiled because of `no-byte-compile: %s'"
375e49d4 1777 ;; (byte-compile-abbreviate-file filename)
6b61353c
KH
1778 ;; (with-current-buffer input-buffer no-byte-compile))
1779 (when (file-exists-p target-file)
1780 (message "%s deleted because of `no-byte-compile: %s'"
375e49d4 1781 (byte-compile-abbreviate-file target-file)
6b61353c
KH
1782 (buffer-local-value 'no-byte-compile input-buffer))
1783 (condition-case nil (delete-file target-file) (error nil)))
82345a9a 1784 ;; We successfully didn't compile this file.
d90a41e8 1785 'no-byte-compile)
ccb3c8de 1786 (when byte-compile-verbose
ca105506 1787 (message "Compiling %s..." filename))
82345a9a
SM
1788 (setq byte-compiler-error-flag nil)
1789 ;; It is important that input-buffer not be current at this call,
1790 ;; so that the value of point set in input-buffer
1791 ;; within byte-compile-from-buffer lingers in that buffer.
4f6d5bf0
SM
1792 (setq output-buffer
1793 (save-current-buffer
4c514b0f
SM
1794 (let ((byte-compile-level (1+ byte-compile-level)))
1795 (byte-compile-from-buffer input-buffer))))
82345a9a
SM
1796 (if byte-compiler-error-flag
1797 nil
ccb3c8de 1798 (when byte-compile-verbose
ca105506 1799 (message "Compiling %s...done" filename))
82345a9a
SM
1800 (kill-buffer input-buffer)
1801 (with-current-buffer output-buffer
1802 (goto-char (point-max))
1803 (insert "\n") ; aaah, unix.
94d4c7dc
AS
1804 (if (file-writable-p target-file)
1805 ;; We must disable any code conversion here.
1806 (let* ((coding-system-for-write 'no-conversion)
1807 ;; Write to a tempfile so that if another Emacs
1808 ;; process is trying to load target-file (eg in a
1809 ;; parallel bootstrap), it does not risk getting a
1810 ;; half-finished file. (Bug#4196)
1811 (tempfile (make-temp-name target-file))
1812 (kill-emacs-hook
1813 (cons (lambda () (ignore-errors (delete-file tempfile)))
1814 kill-emacs-hook)))
94d4c7dc
AS
1815 (write-region (point-min) (point-max) tempfile nil 1)
1816 ;; This has the intentional side effect that any
1817 ;; hard-links to target-file continue to
1818 ;; point to the old file (this makes it possible
1819 ;; for installed files to share disk space with
1820 ;; the build tree, without causing problems when
1821 ;; emacs-lisp files in the build tree are
1822 ;; recompiled). Previously this was accomplished by
1823 ;; deleting target-file before writing it.
1824 (rename-file tempfile target-file t)
1825 (message "Wrote %s" target-file))
1826 ;; This is just to give a better error message than write-region
1827 (signal 'file-error
1828 (list "Opening output file"
1829 (if (file-exists-p target-file)
1830 "cannot overwrite file"
1831 "directory not writable or nonexistent")
1832 target-file)))
82345a9a
SM
1833 (kill-buffer (current-buffer)))
1834 (if (and byte-compile-generate-call-tree
1835 (or (eq t byte-compile-generate-call-tree)
1c3b663f 1836 (y-or-n-p (format "Report call tree for %s? "
ca105506 1837 filename))))
82345a9a 1838 (save-excursion
ca105506 1839 (display-call-tree filename)))
82345a9a
SM
1840 (if load
1841 (load target-file))
1842 t))))
1c393159 1843
1c393159 1844;;; compiling a single function
fd5285f3 1845;;;###autoload
52799cb8 1846(defun compile-defun (&optional arg)
1c393159 1847 "Compile and evaluate the current top-level form.
6b61353c 1848Print the result in the echo area.
2b9c3b12 1849With argument ARG, insert value in current buffer after the form."
1c393159
JB
1850 (interactive "P")
1851 (save-excursion
1852 (end-of-defun)
1853 (beginning-of-defun)
1854 (let* ((byte-compile-current-file nil)
ccb3c8de
CW
1855 (byte-compile-current-buffer (current-buffer))
1856 (byte-compile-read-position (point))
1857 (byte-compile-last-position byte-compile-read-position)
1c393159 1858 (byte-compile-last-warned-form 'nothing)
ccb3c8de 1859 (value (eval
9cb9a7bc 1860 (let ((read-with-symbol-positions (current-buffer))
ccb3c8de
CW
1861 (read-symbol-positions-list nil))
1862 (displaying-byte-compile-warnings
2ec42da9
SM
1863 (byte-compile-sexp (read (current-buffer)))))
1864 lexical-binding)))
1c393159
JB
1865 (cond (arg
1866 (message "Compiling from buffer... done.")
1867 (prin1 value (current-buffer))
1868 (insert "\n"))
1869 ((message "%s" (prin1-to-string value)))))))
1870
ca105506 1871(defun byte-compile-from-buffer (inbuffer)
6876a58d 1872 (let ((byte-compile-current-buffer inbuffer)
ccb3c8de
CW
1873 (byte-compile-read-position nil)
1874 (byte-compile-last-position nil)
d82e848c
RS
1875 ;; Prevent truncation of flonums and lists as we read and print them
1876 (float-output-format nil)
1877 (case-fold-search nil)
1878 (print-length nil)
95e7d933 1879 (print-level nil)
74dfd056
RS
1880 ;; Prevent edebug from interfering when we compile
1881 ;; and put the output into a file.
ccb3c8de
CW
1882;; (edebug-all-defs nil)
1883;; (edebug-all-forms nil)
d82e848c
RS
1884 ;; Simulate entry to byte-compile-top-level
1885 (byte-compile-constants nil)
1886 (byte-compile-variables nil)
1887 (byte-compile-tag-number 0)
1888 (byte-compile-depth 0)
1889 (byte-compile-maxdepth 0)
1890 (byte-compile-output nil)
ccb3c8de 1891 ;; This allows us to get the positions of symbols read; it's
bf247b6e 1892 ;; new in Emacs 22.1.
ca105506 1893 (read-with-symbol-positions inbuffer)
ccb3c8de 1894 (read-symbol-positions-list nil)
d82e848c 1895 ;; #### This is bound in b-c-close-variables.
cf637a34 1896 ;; (byte-compile-warnings byte-compile-warnings)
d82e848c
RS
1897 )
1898 (byte-compile-close-variables
b8104a2b 1899 (with-current-buffer
7200d79c 1900 (setq byte-compile--outbuffer
fd743628
GM
1901 (get-buffer-create
1902 (concat " *Compiler Output*"
1903 (if (<= byte-compile-level 1) ""
1904 (format "-%s" (1- byte-compile-level))))))
08b59cd3 1905 (set-buffer-multibyte t)
d82e848c
RS
1906 (erase-buffer)
1907 ;; (emacs-lisp-mode)
96bcef2e 1908 (setq case-fold-search nil))
d82e848c 1909 (displaying-byte-compile-warnings
ca105506 1910 (with-current-buffer inbuffer
9ace101c
SM
1911 (and byte-compile-current-file
1912 (byte-compile-insert-header byte-compile-current-file
7200d79c 1913 byte-compile--outbuffer))
b8104a2b 1914 (goto-char (point-min))
2cb63a7c
AM
1915 ;; Should we always do this? When calling multiple files, it
1916 ;; would be useful to delay this warning until all have been
1917 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1918 ;; previous byte-compile.
1919 (setq byte-compile-unresolved-functions nil)
d82e848c
RS
1920
1921 ;; Compile the forms from the input buffer.
1922 (while (progn
1923 (while (progn (skip-chars-forward " \t\n\^l")
1924 (looking-at ";"))
1925 (forward-line 1))
1926 (not (eobp)))
ccb3c8de
CW
1927 (setq byte-compile-read-position (point)
1928 byte-compile-last-position byte-compile-read-position)
36e65f70 1929 (let* ((old-style-backquotes nil)
ca105506 1930 (form (read inbuffer)))
36e65f70
SM
1931 ;; Warn about the use of old-style backquotes.
1932 (when old-style-backquotes
1933 (byte-compile-warn "!! The file uses old-style backquotes !!
1934This functionality has been obsolete for more than 10 years already
1935and will be removed soon. See (elisp)Backquote in the manual."))
876c194c 1936 (byte-compile-toplevel-file-form form)))
d82e848c
RS
1937 ;; Compile pending forms at end of file.
1938 (byte-compile-flush-pending)
977f31f8
RS
1939 ;; Make warnings about unresolved functions
1940 ;; give the end of the file as their position.
1941 (setq byte-compile-last-position (point-max))
2cb63a7c 1942 (byte-compile-warn-about-unresolved-functions))
fb639443
RS
1943 ;; Fix up the header at the front of the output
1944 ;; if the buffer contains multibyte characters.
9ace101c 1945 (and byte-compile-current-file
7200d79c 1946 (with-current-buffer byte-compile--outbuffer
6876a58d
SM
1947 (byte-compile-fix-header byte-compile-current-file))))
1948 byte-compile--outbuffer)))
8a5dd086 1949
dd41169b 1950(defun byte-compile-fix-header (_filename)
775adc51
GM
1951 "If the current buffer has any multibyte characters, insert a version test."
1952 (when (< (point-max) (position-bytes (point-max)))
1953 (goto-char (point-min))
1954 ;; Find the comment that describes the version condition.
1955 (search-forward "\n;;; This file uses")
1956 (narrow-to-region (line-beginning-position) (point-max))
1957 ;; Find the first line of ballast semicolons.
1958 (search-forward ";;;;;;;;;;")
1959 (beginning-of-line)
1960 (narrow-to-region (point-min) (point))
1961 (let ((old-header-end (point))
1962 (minimum-version "23")
1963 delta)
1964 (delete-region (point-min) (point-max))
1965 (insert
1966 ";;; This file contains utf-8 non-ASCII characters,\n"
1967 ";;; and so cannot be loaded into Emacs 22 or earlier.\n"
1968 ;; Have to check if emacs-version is bound so that this works
1969 ;; in files loaded early in loadup.el.
1970 "(and (boundp 'emacs-version)\n"
1971 ;; If there is a name at the end of emacs-version,
1972 ;; don't try to check the version number.
1973 " (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1974 (format " (string-lessp emacs-version \"%s\")\n" minimum-version)
dd41169b
SM
1975 ;; Because the header must fit in a fixed width, we cannot
1976 ;; insert arbitrary-length file names (Bug#11585).
1977 " (error \"`%s' was compiled for "
4a5f187a 1978 (format "Emacs %s or later\" #$))\n\n" minimum-version))
775adc51
GM
1979 ;; Now compensate for any change in size, to make sure all
1980 ;; positions in the file remain valid.
1981 (setq delta (- (point-max) old-header-end))
1982 (goto-char (point-max))
1983 (widen)
1984 (delete-char delta))))
1985
5cb15713 1986(defun byte-compile-insert-header (_filename outbuffer)
775adc51
GM
1987 "Insert a header at the start of OUTBUFFER.
1988Call from the source buffer."
1989 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1990 (dynamic byte-compile-dynamic)
1991 (optimize byte-optimize))
1992 (with-current-buffer outbuffer
a5832373
RS
1993 (goto-char (point-min))
1994 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
430d2ee2 1995 ;; that is the file-format version number (18, 19, 20, or 23) as a
a5832373
RS
1996 ;; byte, followed by some nulls. The primary motivation for doing
1997 ;; this is to get some binary characters up in the first line of
1998 ;; the file so that `diff' will simply say "Binary files differ"
1999 ;; instead of actually doing a diff of two .elc files. An extra
2000 ;; benefit is that you can add this to /etc/magic:
a5832373
RS
2001 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
2002 ;; >4 byte x version %d
775adc51
GM
2003 (insert
2004 ";ELC" 23 "\000\000\000\n"
a6d63d97 2005 ";;; Compiled\n"
5fa9d1ec
GM
2006 ";;; in Emacs version " emacs-version "\n"
2007 ";;; with"
775adc51
GM
2008 (cond
2009 ((eq optimize 'source) " source-level optimization only")
2010 ((eq optimize 'byte) " byte-level optimization only")
2011 (optimize " all optimizations")
2012 (t "out optimization"))
2013 ".\n"
2014 (if dynamic ";;; Function definitions are lazy-loaded.\n"
2015 "")
2016 "\n;;; This file uses "
2017 (if dynamic-docstrings
2018 "dynamic docstrings, first added in Emacs 19.29"
2019 "opcodes that do not exist in Emacs 18")
2020 ".\n\n"
2021 ;; Note that byte-compile-fix-header may change this.
2022 ";;; This file does not contain utf-8 non-ASCII characters,\n"
2023 ";;; and so can be loaded in Emacs versions earlier than 23.\n\n"
2024 ;; Insert semicolons as ballast, so that byte-compile-fix-header
2025 ;; can delete them so as to keep the buffer positions
2026 ;; constant for the actual compiled code.
2027 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n"
2028 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))))
1c393159
JB
2029
2030(defun byte-compile-output-file-form (form)
61b108cc 2031 ;; Write the given form to the output buffer, being careful of docstrings
4a5f187a 2032 ;; in defvar, defvaralias, defconst, autoload and
36b7e523 2033 ;; custom-declare-variable because make-docfile is so amazingly stupid.
c36881cf
ER
2034 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
2035 ;; it does not pay to first build the defalias in defmumble and then parse
2036 ;; it here.
61b108cc
SM
2037 (let ((print-escape-newlines t)
2038 (print-length nil)
2039 (print-level nil)
2040 (print-quoted t)
2041 (print-gensym t)
2042 (print-circle ; Handle circular data structures.
2043 (not byte-compile-disable-print-circle)))
4a5f187a 2044 (if (and (memq (car-safe form) '(defvar defvaralias defconst
61b108cc
SM
2045 autoload custom-declare-variable))
2046 (stringp (nth 3 form)))
2047 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
2048 (memq (car form)
2049 '(defvaralias autoload
2050 custom-declare-variable)))
7200d79c
SM
2051 (princ "\n" byte-compile--outbuffer)
2052 (prin1 form byte-compile--outbuffer)
1c393159
JB
2053 nil)))
2054
2ec42da9 2055(defvar byte-compile--for-effect)
6c2161c4 2056
d82e848c 2057(defun byte-compile-output-docform (preface name info form specindex quoted)
dac6f673
RS
2058 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2059If PREFACE and NAME are non-nil, print them too,
2060before INFO and the FORM but after the doc string itself.
2061If SPECINDEX is non-nil, it is the index in FORM
2062of the function bytecode string. In that case,
2b9c3b12
JB
2063we output that argument and the following argument
2064\(the constants vector) together, for lazy loading.
dac6f673
RS
2065QUOTED says that we have to put a quote before the
2066list that represents a doc string reference.
1e857121 2067`defvaralias', `autoload' and `custom-declare-variable' need that."
dac6f673
RS
2068 ;; We need to examine byte-compile-dynamic-docstrings
2069 ;; in the input buffer (now current), not in the output buffer.
2070 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
7200d79c 2071 (with-current-buffer byte-compile--outbuffer
9ec5dfe6
SM
2072 (let (position)
2073
2074 ;; Insert the doc string, and make it a comment with #@LENGTH.
2075 (and (>= (nth 1 info) 0)
2076 dynamic-docstrings
9ec5dfe6
SM
2077 (progn
2078 ;; Make the doc string start at beginning of line
2079 ;; for make-docfile's sake.
2080 (insert "\n")
2081 (setq position
2082 (byte-compile-output-as-comment
2083 (nth (nth 1 info) form) nil))
9ec5dfe6
SM
2084 ;; If the doc string starts with * (a user variable),
2085 ;; negate POSITION.
2086 (if (and (stringp (nth (nth 1 info) form))
2087 (> (length (nth (nth 1 info) form)) 0)
2088 (eq (aref (nth (nth 1 info) form) 0) ?*))
2089 (setq position (- position)))))
2090
2091 (if preface
2092 (progn
2093 (insert preface)
7200d79c 2094 (prin1 name byte-compile--outbuffer)))
9ec5dfe6 2095 (insert (car info))
61b108cc 2096 (let ((print-continuous-numbering t)
9ec5dfe6 2097 print-number-table
4a5f187a
SM
2098 (index 0)
2099 ;; FIXME: The bindings below are only needed for when we're
2100 ;; called from ...-defmumble.
2101 (print-escape-newlines t)
2102 (print-length nil)
2103 (print-level nil)
2104 (print-quoted t)
2105 (print-gensym t)
2106 (print-circle ; Handle circular data structures.
2107 (not byte-compile-disable-print-circle)))
7200d79c 2108 (prin1 (car form) byte-compile--outbuffer)
9ec5dfe6
SM
2109 (while (setq form (cdr form))
2110 (setq index (1+ index))
2111 (insert " ")
2112 (cond ((and (numberp specindex) (= index specindex)
2113 ;; Don't handle the definition dynamically
2114 ;; if it refers (or might refer)
2115 ;; to objects already output
2116 ;; (for instance, gensyms in the arg list).
2117 (let (non-nil)
17870c01 2118 (when (hash-table-p print-number-table)
9ace101c 2119 (maphash (lambda (_k v) (if v (setq non-nil t)))
17870c01 2120 print-number-table))
9ec5dfe6
SM
2121 (not non-nil)))
2122 ;; Output the byte code and constants specially
2123 ;; for lazy dynamic loading.
2124 (let ((position
2125 (byte-compile-output-as-comment
2126 (cons (car form) (nth 1 form))
2127 t)))
2ec42da9 2128 (princ (format "(#$ . %d) nil" position)
7200d79c 2129 byte-compile--outbuffer)
9ec5dfe6
SM
2130 (setq form (cdr form))
2131 (setq index (1+ index))))
2132 ((= index (nth 1 info))
2133 (if position
2134 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2135 position)
7200d79c 2136 byte-compile--outbuffer)
9ec5dfe6
SM
2137 (let ((print-escape-newlines nil))
2138 (goto-char (prog1 (1+ (point))
7200d79c
SM
2139 (prin1 (car form)
2140 byte-compile--outbuffer)))
9ec5dfe6
SM
2141 (insert "\\\n")
2142 (goto-char (point-max)))))
2143 (t
7200d79c 2144 (prin1 (car form) byte-compile--outbuffer)))))
9ec5dfe6 2145 (insert (nth 2 info)))))
1c393159
JB
2146 nil)
2147
ca105506 2148(defun byte-compile-keep-pending (form &optional handler)
1c393159
JB
2149 (if (memq byte-optimize '(t source))
2150 (setq form (byte-optimize-form form t)))
ca105506 2151 (if handler
2ec42da9 2152 (let ((byte-compile--for-effect t))
1c393159
JB
2153 ;; To avoid consing up monstrously large forms at load time, we split
2154 ;; the output regularly.
b4ff4a23
RS
2155 (and (memq (car-safe form) '(fset defalias))
2156 (nthcdr 300 byte-compile-output)
1c393159 2157 (byte-compile-flush-pending))
ca105506 2158 (funcall handler form)
2ec42da9 2159 (if byte-compile--for-effect
1c393159
JB
2160 (byte-compile-discard)))
2161 (byte-compile-form form t))
2162 nil)
2163
2164(defun byte-compile-flush-pending ()
2165 (if byte-compile-output
2166 (let ((form (byte-compile-out-toplevel t 'file)))
2167 (cond ((eq (car-safe form) 'progn)
ed62683d 2168 (mapc 'byte-compile-output-file-form (cdr form)))
1c393159
JB
2169 (form
2170 (byte-compile-output-file-form form)))
2171 (setq byte-compile-constants nil
2172 byte-compile-variables nil
2173 byte-compile-depth 0
2174 byte-compile-maxdepth 0
2175 byte-compile-output nil))))
2176
2ec42da9
SM
2177(defun byte-compile-preprocess (form &optional _for-effect)
2178 (setq form (macroexpand-all form byte-compile-macro-environment))
2179 ;; FIXME: We should run byte-optimize-form here, but it currently does not
2180 ;; recurse through all the code, so we'd have to fix this first.
2181 ;; Maybe a good fix would be to merge byte-optimize-form into
2182 ;; macroexpand-all.
2183 ;; (if (memq byte-optimize '(t source))
2184 ;; (setq form (byte-optimize-form form for-effect)))
2185 (if lexical-binding
2186 (cconv-closure-convert form)
2187 form))
2188
876c194c
SM
2189;; byte-hunk-handlers cannot call this!
2190(defun byte-compile-toplevel-file-form (form)
2191 (let ((byte-compile-current-form nil)) ; close over this for warnings.
2ec42da9 2192 (byte-compile-file-form (byte-compile-preprocess form t))))
876c194c
SM
2193
2194;; byte-hunk-handlers can call this.
1c393159 2195(defun byte-compile-file-form (form)
ca105506 2196 (let (handler)
a9de04fa
SM
2197 (cond ((and (consp form)
2198 (symbolp (car form))
ca105506
SM
2199 (setq handler (get (car form) 'byte-hunk-handler)))
2200 (cond ((setq form (funcall handler form))
b9598260
SM
2201 (byte-compile-flush-pending)
2202 (byte-compile-output-file-form form))))
2203 (t
2204 (byte-compile-keep-pending form)))))
1c393159
JB
2205
2206;; Functions and variables with doc strings must be output separately,
e1dbe924 2207;; so make-docfile can recognize them. Most other things can be output
1c393159
JB
2208;; as byte-code.
2209
1c393159
JB
2210(put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2211(defun byte-compile-file-form-autoload (form)
2212 (and (let ((form form))
4dd1c416 2213 (while (if (setq form (cdr form)) (macroexp-const-p (car form))))
1c393159
JB
2214 (null form)) ;Constants only
2215 (eval (nth 5 form)) ;Macro
2216 (eval form)) ;Define the autoload.
c5091f25 2217 ;; Avoid undefined function warnings for the autoload.
cb4fb1d0 2218 (when (and (consp (nth 1 form))
c5091f25
DL
2219 (eq (car (nth 1 form)) 'quote)
2220 (consp (cdr (nth 1 form)))
ca5995ec
GM
2221 (symbolp (nth 1 (nth 1 form))))
2222 ;; Don't add it if it's already defined. Otherwise, it might
2223 ;; hide the actual definition. However, do remove any entry from
2224 ;; byte-compile-noruntime-functions, in case we have an autoload
2225 ;; of foo-func following an (eval-when-compile (require 'foo)).
2226 (unless (fboundp (nth 1 (nth 1 form)))
2227 (push (cons (nth 1 (nth 1 form))
2228 (cons 'autoload (cdr (cdr form))))
2229 byte-compile-function-environment))
cb4fb1d0
GM
2230 ;; If an autoload occurs _before_ the first call to a function,
2231 ;; byte-compile-callargs-warn does not add an entry to
2232 ;; byte-compile-unresolved-functions. Here we mimic the logic
2233 ;; of byte-compile-callargs-warn so as not to warn if the
2234 ;; autoload comes _after_ the function call.
2235 ;; Alternatively, similar logic could go in
2236 ;; byte-compile-warn-about-unresolved-functions.
ca5995ec
GM
2237 (if (memq (nth 1 (nth 1 form)) byte-compile-noruntime-functions)
2238 (setq byte-compile-noruntime-functions
2239 (delq (nth 1 (nth 1 form)) byte-compile-noruntime-functions)
2240 byte-compile-noruntime-functions)
2241 (setq byte-compile-unresolved-functions
2242 (delq (assq (nth 1 (nth 1 form))
2243 byte-compile-unresolved-functions)
2244 byte-compile-unresolved-functions))))
1c393159
JB
2245 (if (stringp (nth 3 form))
2246 form
2247 ;; No doc string, so we can compile this as a normal form.
2248 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2249
2250(put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2251(put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
208d0342
SM
2252
2253(defun byte-compile--declare-var (sym)
2254 (when (and (symbolp sym)
2255 (not (string-match "[-*/:$]" (symbol-name sym)))
f3934f6f
SM
2256 (byte-compile-warning-enabled-p 'lexical))
2257 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
208d0342
SM
2258 sym))
2259 (when (memq sym byte-compile-lexical-variables)
2260 (setq byte-compile-lexical-variables
2261 (delq sym byte-compile-lexical-variables))
2262 (byte-compile-warn "Variable `%S' declared after its first use" sym))
2263 (push sym byte-compile-bound-variables))
2264
2265(defun byte-compile-file-form-defvar (form)
2266 (let ((sym (nth 1 form)))
2267 (byte-compile--declare-var sym)
2268 (if (eq (car form) 'defconst)
2269 (push sym byte-compile-const-variables)))
f3934f6f
SM
2270 (if (and (null (cddr form)) ;No `value' provided.
2271 (eq (car form) 'defvar)) ;Just a declaration.
2272 nil
1c393159 2273 (cond ((consp (nth 2 form))
f3934f6f
SM
2274 (setq form (copy-sequence form))
2275 (setcar (cdr (cdr form))
2276 (byte-compile-top-level (nth 2 form) nil 'file))))
1c393159
JB
2277 form))
2278
2ec42da9
SM
2279(put 'define-abbrev-table 'byte-hunk-handler
2280 'byte-compile-file-form-define-abbrev-table)
b7c76a30 2281(defun byte-compile-file-form-define-abbrev-table (form)
2aea6521 2282 (if (eq 'quote (car-safe (car-safe (cdr form))))
208d0342 2283 (byte-compile--declare-var (car-safe (cdr (cadr form)))))
b7c76a30
SM
2284 (byte-compile-keep-pending form))
2285
8c731d3d
RS
2286(put 'custom-declare-variable 'byte-hunk-handler
2287 'byte-compile-file-form-custom-declare-variable)
2288(defun byte-compile-file-form-custom-declare-variable (form)
cf637a34 2289 (when (byte-compile-warning-enabled-p 'callargs)
fe33e7c8 2290 (byte-compile-nogroup-warn form))
208d0342 2291 (byte-compile--declare-var (nth 1 (nth 1 form)))
2bd785a2 2292 (byte-compile-keep-pending form))
8c731d3d 2293
997011eb
RS
2294(put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2295(defun byte-compile-file-form-require (form)
3f12e5bd
GM
2296 (let ((args (mapcar 'eval (cdr form)))
2297 (hist-orig load-history)
2298 hist-new)
997011eb 2299 (apply 'require args)
3f12e5bd
GM
2300 (when (byte-compile-warning-enabled-p 'cl-functions)
2301 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2302 (if (member (car args) '("cl" cl))
2303 (progn
2304 (byte-compile-warn "cl package required at runtime")
2305 (byte-compile-disable-warning 'cl-functions))
2306 ;; We may have required something that causes cl to be loaded, eg
2307 ;; the uncompiled version of a file that requires cl when compiling.
2308 (setq hist-new load-history)
2309 (while (and (not byte-compile-cl-functions)
2310 hist-new (not (eq hist-new hist-orig)))
2311 (and (byte-compile-cl-file-p (car (pop hist-new)))
2312 (byte-compile-find-cl-functions))))))
1c393159
JB
2313 (byte-compile-keep-pending form 'byte-compile-normal-call))
2314
2315(put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2316(put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2317(put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2318(defun byte-compile-file-form-progn (form)
ed62683d 2319 (mapc 'byte-compile-file-form (cdr form))
1c393159
JB
2320 ;; Return nil so the forms are not output twice.
2321 nil)
2322
cb4fb1d0
GM
2323(put 'with-no-warnings 'byte-hunk-handler
2324 'byte-compile-file-form-with-no-warnings)
2325(defun byte-compile-file-form-with-no-warnings (form)
2326 ;; cf byte-compile-file-form-progn.
2327 (let (byte-compile-warnings)
2328 (mapc 'byte-compile-file-form (cdr form))
2329 nil))
2330
1c393159
JB
2331;; This handler is not necessary, but it makes the output from dont-compile
2332;; and similar macros cleaner.
2333(put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2334(defun byte-compile-file-form-eval (form)
2335 (if (eq (car-safe (nth 1 form)) 'quote)
2336 (nth 1 (nth 1 form))
2337 (byte-compile-keep-pending form)))
2338
61b108cc
SM
2339(defun byte-compile-file-form-defmumble (name macro arglist body rest)
2340 "Process a `defalias' for NAME.
2341If MACRO is non-nil, the definition is known to be a macro.
2342ARGLIST is the list of arguments, if it was recognized or t otherwise.
2343BODY of the definition, or t if not recognized.
2344Return non-nil if everything went as planned, or nil to imply that it decided
2345not to take responsibility for the actual compilation of the code."
2346 (let* ((this-kind (if macro 'byte-compile-macro-environment
2347 'byte-compile-function-environment))
2348 (that-kind (if macro 'byte-compile-function-environment
2349 'byte-compile-macro-environment))
2350 (this-one (assq name (symbol-value this-kind)))
2351 (that-one (assq name (symbol-value that-kind)))
2352 (byte-compile-current-form name)) ; For warnings.
2353
ca105506 2354 (byte-compile-set-symbol-position name)
1c393159
JB
2355 ;; When a function or macro is defined, add it to the call tree so that
2356 ;; we can tell when functions are not used.
2357 (if byte-compile-generate-call-tree
61b108cc
SM
2358 (or (assq name byte-compile-call-tree)
2359 (setq byte-compile-call-tree
2360 (cons (list name nil nil) byte-compile-call-tree))))
1c393159 2361
cf637a34 2362 (if (byte-compile-warning-enabled-p 'redefine)
61b108cc
SM
2363 (byte-compile-arglist-warn name arglist macro))
2364
1c393159 2365 (if byte-compile-verbose
61b108cc
SM
2366 (message "Compiling %s... (%s)"
2367 (or byte-compile-current-file "") name))
2368 (cond ((not (or macro (listp body)))
2369 ;; We do not know positively if the definition is a macro
2370 ;; or a function, so we shouldn't emit warnings.
2371 ;; This also silences "multiple definition" warnings for defmethods.
2372 nil)
2373 (that-one
2374 (if (and (byte-compile-warning-enabled-p 'redefine)
2375 ;; Don't warn when compiling the stubs in byte-run...
2376 (not (assq name byte-compile-initial-macro-environment)))
2377 (byte-compile-warn
29a4dcb0 2378 "`%s' defined multiple times, as both function and macro"
61b108cc
SM
2379 name))
2380 (setcdr that-one nil))
2381 (this-one
2382 (when (and (byte-compile-warning-enabled-p 'redefine)
2383 ;; Hack: Don't warn when compiling the magic internal
29a4dcb0 2384 ;; byte-compiler macros in byte-run.el...
61b108cc
SM
2385 (not (assq name byte-compile-initial-macro-environment)))
2386 (byte-compile-warn "%s `%s' defined multiple times in this file"
2387 (if macro "macro" "function")
2388 name)))
2389 ((and (fboundp name)
2390 (eq (car-safe (symbol-function name))
2391 (if macro 'lambda 'macro)))
2392 (when (byte-compile-warning-enabled-p 'redefine)
2393 (byte-compile-warn "%s `%s' being redefined as a %s"
2394 (if macro "function" "macro")
2395 name
2396 (if macro "macro" "function")))
2397 ;; Shadow existing definition.
2398 (set this-kind
2399 (cons (cons name nil)
2400 (symbol-value this-kind))))
2401 )
2402
2403 (when (and (listp body)
2404 (stringp (car body))
2405 (symbolp (car-safe (cdr-safe body)))
2406 (car-safe (cdr-safe body))
2407 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2408 ;; FIXME: We've done that already just above, so this looks wrong!
2409 ;;(byte-compile-set-symbol-position name)
2410 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2411 name))
e3ac1281 2412
61b108cc
SM
2413 (if (not (listp body))
2414 ;; The precise definition requires evaluation to find out, so it
2415 ;; will only be known at runtime.
2416 ;; For a macro, that means we can't use that macro in the same file.
2417 (progn
2418 (unless macro
2419 (push (cons name (if (listp arglist) `(declared ,arglist) t))
2420 byte-compile-function-environment))
2421 ;; Tell the caller that we didn't compile it yet.
2422 nil)
2423
2424 (let* ((code (byte-compile-lambda (cons arglist body) t)))
2425 (if this-one
2426 ;; A definition in b-c-initial-m-e should always take precedence
2427 ;; during compilation, so don't let it be redefined. (Bug#8647)
2428 (or (and macro
2429 (assq name byte-compile-initial-macro-environment))
2430 (setcdr this-one code))
2431 (set this-kind
2432 (cons (cons name code)
2433 (symbol-value this-kind))))
2434
2435 (if rest
2436 ;; There are additional args to `defalias' (like maybe a docstring)
2437 ;; that the code below can't handle: punt!
2438 nil
2439 ;; Otherwise, we have a bona-fide defun/defmacro definition, and use
2440 ;; special code to allow dynamic docstrings and byte-code.
2441 (byte-compile-flush-pending)
2442 (let ((index
2443 ;; If there's no doc string, provide -1 as the "doc string
2444 ;; index" so that no element will be treated as a doc string.
2445 (if (not (stringp (car body))) -1 4)))
2446 ;; Output the form by hand, that's much simpler than having
2447 ;; b-c-output-file-form analyze the defalias.
2448 (byte-compile-output-docform
2449 "\n(defalias '"
2450 name
2451 (if macro `(" '(macro . #[" ,index "])") `(" #[" ,index "]"))
2452 (append code nil) ; Turn byte-code-function-p into list.
2453 (and (atom code) byte-compile-dynamic
2454 1)
2455 nil))
2456 (princ ")" byte-compile--outbuffer)
2457 t)))))
d82e848c 2458
d82e848c 2459(defun byte-compile-output-as-comment (exp quoted)
61b108cc
SM
2460 "Print Lisp object EXP in the output file, inside a comment,
2461and return the file (byte) position it will have.
2462If QUOTED is non-nil, print with quoting; otherwise, print without quoting."
2463 (with-current-buffer byte-compile--outbuffer
2464 (let ((position (point)))
9ec5dfe6
SM
2465
2466 ;; Insert EXP, and make it a comment with #@LENGTH.
2467 (insert " ")
2468 (if quoted
7200d79c
SM
2469 (prin1 exp byte-compile--outbuffer)
2470 (princ exp byte-compile--outbuffer))
9ec5dfe6
SM
2471 (goto-char position)
2472 ;; Quote certain special characters as needed.
2473 ;; get_doc_string in doc.c does the unquoting.
2474 (while (search-forward "\^A" nil t)
2475 (replace-match "\^A\^A" t t))
2476 (goto-char position)
2477 (while (search-forward "\000" nil t)
2478 (replace-match "\^A0" t t))
2479 (goto-char position)
2480 (while (search-forward "\037" nil t)
2481 (replace-match "\^A_" t t))
2482 (goto-char (point-max))
2483 (insert "\037")
2484 (goto-char position)
2485 (insert "#@" (format "%d" (- (position-bytes (point-max))
2486 (position-bytes position))))
2487
2488 ;; Save the file position of the object.
61b108cc
SM
2489 ;; Note we add 1 to skip the space that we inserted before the actual doc
2490 ;; string, and subtract point-min to convert from an 1-origin Emacs
2491 ;; position to a file position.
2492 (prog1
2493 (- (position-bytes (point)) (point-min) -1)
2494 (goto-char (point-max))))))
d82e848c 2495
e3ac1281 2496(defun byte-compile--reify-function (fun)
c207708c
SM
2497 "Return an expression which will evaluate to a function value FUN.
2498FUN should be either a `lambda' value or a `closure' value."
2499 (pcase-let* (((or (and `(lambda ,args . ,body) (let env nil))
2500 `(closure ,env ,args . ,body)) fun)
2501 (renv ()))
2502 ;; Turn the function's closed vars (if any) into local let bindings.
2503 (dolist (binding env)
2504 (cond
2505 ((consp binding)
2506 ;; We check shadowing by the args, so that the `let' can be moved
2507 ;; within the lambda, which can then be unfolded. FIXME: Some of those
2508 ;; bindings might be unused in `body'.
2509 (unless (memq (car binding) args) ;Shadowed.
2510 (push `(,(car binding) ',(cdr binding)) renv)))
2511 ((eq binding t))
2512 (t (push `(defvar ,binding) body))))
2513 (if (null renv)
2514 `(lambda ,args ,@body)
2515 `(lambda ,args (let ,(nreverse renv) ,@body)))))
1c393159 2516\f
fd5285f3 2517;;;###autoload
1c393159
JB
2518(defun byte-compile (form)
2519 "If FORM is a symbol, byte-compile its function definition.
2520If FORM is a lambda or a macro, byte-compile it as a function."
2521 (displaying-byte-compile-warnings
2522 (byte-compile-close-variables
c207708c
SM
2523 (let* ((lexical-binding lexical-binding)
2524 (fun (if (symbolp form)
1c393159
JB
2525 (and (fboundp form) (symbol-function form))
2526 form))
2527 (macro (eq (car-safe fun) 'macro)))
2528 (if macro
2529 (setq fun (cdr fun)))
b5771c0d
SM
2530 (cond
2531 ;; Up until Emacs-24.1, byte-compile silently did nothing when asked to
2532 ;; compile something invalid. So let's tune down the complaint from an
2533 ;; error to a simple message for the known case where signaling an error
2534 ;; causes problems.
2535 ((byte-code-function-p fun)
2536 (message "Function %s is already compiled"
2537 (if (symbolp form) form "provided"))
2538 fun)
2539 (t
2540 (when (symbolp form)
2541 (unless (memq (car-safe fun) '(closure lambda))
2542 (error "Don't know how to compile %S" fun))
5d0ccd95
SM
2543 (setq lexical-binding (eq (car fun) 'closure))
2544 (setq fun (byte-compile--reify-function fun)))
b5771c0d 2545 (unless (eq (car-safe fun) 'lambda)
c207708c 2546 (error "Don't know how to compile %S" fun))
b5771c0d
SM
2547 ;; Expand macros.
2548 (setq fun (byte-compile-preprocess fun))
2549 ;; Get rid of the `function' quote added by the `lambda' macro.
2550 (if (eq (car-safe fun) 'function) (setq fun (cadr fun)))
2551 (setq fun (byte-compile-lambda fun))
2552 (if macro (push 'macro fun))
2553 (if (symbolp form)
2554 (fset form fun)
2555 fun)))))))
1c393159
JB
2556
2557(defun byte-compile-sexp (sexp)
2558 "Compile and return SEXP."
2559 (displaying-byte-compile-warnings
2560 (byte-compile-close-variables
2ec42da9 2561 (byte-compile-top-level (byte-compile-preprocess sexp)))))
1c393159 2562
eadd6444
GM
2563(defun byte-compile-check-lambda-list (list)
2564 "Check lambda-list LIST for errors."
2565 (let (vars)
2566 (while list
2567 (let ((arg (car list)))
ccb3c8de
CW
2568 (when (symbolp arg)
2569 (byte-compile-set-symbol-position arg))
1f006824 2570 (cond ((or (not (symbolp arg))
4dd1c416 2571 (macroexp--const-symbol-p arg t))
eadd6444
GM
2572 (error "Invalid lambda variable %s" arg))
2573 ((eq arg '&rest)
2574 (unless (cdr list)
2575 (error "&rest without variable name"))
2576 (when (cddr list)
2577 (error "Garbage following &rest VAR in lambda-list")))
2578 ((eq arg '&optional)
2579 (unless (cdr list)
2580 (error "Variable name missing after &optional")))
2581 ((memq arg vars)
e34fd2f2 2582 (byte-compile-warn "repeated variable %s in lambda-list" arg))
1f006824 2583 (t
eadd6444
GM
2584 (push arg vars))))
2585 (setq list (cdr list)))))
2586
2587
ce5b520a
SM
2588(defun byte-compile-arglist-vars (arglist)
2589 "Return a list of the variables in the lambda argument list ARGLIST."
2590 (remq '&rest (remq '&optional arglist)))
2591
208d0342 2592(defun byte-compile-make-lambda-lexenv (args)
ce5b520a 2593 "Return a new lexical environment for a lambda expression FORM."
208d0342
SM
2594 (let* ((lexenv nil)
2595 (stackpos 0))
2596 ;; Add entries for each argument.
2597 (dolist (arg args)
2598 (push (cons arg stackpos) lexenv)
2599 (setq stackpos (1+ stackpos)))
2600 ;; Return the new lexical environment.
2601 lexenv))
b9598260 2602
e2abe5a1
SM
2603(defun byte-compile-make-args-desc (arglist)
2604 (let ((mandatory 0)
2605 nonrest (rest 0))
2606 (while (and arglist (not (memq (car arglist) '(&optional &rest))))
2607 (setq mandatory (1+ mandatory))
2608 (setq arglist (cdr arglist)))
2609 (setq nonrest mandatory)
2610 (when (eq (car arglist) '&optional)
2611 (setq arglist (cdr arglist))
2612 (while (and arglist (not (eq (car arglist) '&rest)))
2613 (setq nonrest (1+ nonrest))
2614 (setq arglist (cdr arglist))))
2615 (when arglist
2616 (setq rest 1))
2617 (if (> mandatory 127)
2618 (byte-compile-report-error "Too many (>127) mandatory arguments")
2619 (logior mandatory
2620 (lsh nonrest 8)
2621 (lsh rest 7)))))
2622
61b108cc 2623
ca105506 2624(defun byte-compile-lambda (fun &optional add-lambda reserved-csts)
61b108cc
SM
2625 "Byte-compile a lambda-expression and return a valid function.
2626The value is usually a compiled function but may be the original
2627lambda-expression.
2628When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2629of the list FUN and `byte-compile-set-symbol-position' is not called.
2630Use this feature to avoid calling `byte-compile-set-symbol-position'
2631for symbols generated by the byte compiler itself."
4ec5239c 2632 (if add-lambda
ca105506
SM
2633 (setq fun (cons 'lambda fun))
2634 (unless (eq 'lambda (car-safe fun))
2635 (error "Not a lambda list: %S" fun))
4ec5239c 2636 (byte-compile-set-symbol-position 'lambda))
ca105506
SM
2637 (byte-compile-check-lambda-list (nth 1 fun))
2638 (let* ((arglist (nth 1 fun))
208d0342 2639 (arglistvars (byte-compile-arglist-vars arglist))
1c393159 2640 (byte-compile-bound-variables
208d0342 2641 (append (if (not lexical-binding) arglistvars)
ce5b520a 2642 byte-compile-bound-variables))
ca105506
SM
2643 (body (cdr (cdr fun)))
2644 (doc (if (stringp (car body))
2645 (prog1 (car body)
2646 ;; Discard the doc string
2647 ;; unless it is the last element of the body.
2648 (if (cdr body)
2649 (setq body (cdr body))))))
2650 (int (assq 'interactive body)))
6c2161c4 2651 ;; Process the interactive spec.
ca105506 2652 (when int
6c2161c4
SM
2653 (byte-compile-set-symbol-position 'interactive)
2654 ;; Skip (interactive) if it is in front (the most usual location).
ca105506
SM
2655 (if (eq int (car body))
2656 (setq body (cdr body)))
2657 (cond ((consp (cdr int))
2658 (if (cdr (cdr int))
6c2161c4 2659 (byte-compile-warn "malformed interactive spec: %s"
ca105506 2660 (prin1-to-string int)))
6b61353c
KH
2661 ;; If the interactive spec is a call to `list', don't
2662 ;; compile it, because `call-interactively' looks at the
2663 ;; args of `list'. Actually, compile it to get warnings,
2664 ;; but don't use the result.
ca105506 2665 (let* ((form (nth 1 int))
d032d5e7 2666 (newform (byte-compile-top-level form)))
6c2161c4
SM
2667 (while (memq (car-safe form) '(let let* progn save-excursion))
2668 (while (consp (cdr form))
2669 (setq form (cdr form)))
2670 (setq form (car form)))
d032d5e7 2671 (if (and (eq (car-safe form) 'list)
99d99081 2672 ;; The spec is evalled in callint.c in dynamic-scoping
d032d5e7
SM
2673 ;; mode, so just leaving the form unchanged would mean
2674 ;; it won't be eval'd in the right mode.
2675 (not lexical-binding))
2676 nil
ca105506
SM
2677 (setq int `(interactive ,newform)))))
2678 ((cdr int)
6c2161c4 2679 (byte-compile-warn "malformed interactive spec: %s"
ca105506 2680 (prin1-to-string int)))))
6c2161c4 2681 ;; Process the body.
ba83908c 2682 (let ((compiled
ca105506 2683 (byte-compile-top-level (cons 'progn body) nil 'lambda
ba83908c
SM
2684 ;; If doing lexical binding, push a new
2685 ;; lexical environment containing just the
2686 ;; args (since lambda expressions should be
2687 ;; closed by now).
2688 (and lexical-binding
208d0342
SM
2689 (byte-compile-make-lambda-lexenv
2690 arglistvars))
ba83908c 2691 reserved-csts)))
6c2161c4 2692 ;; Build the actual byte-coded function.
f80efb86 2693 (cl-assert (eq 'byte-code (car-safe compiled)))
61b108cc
SM
2694 (apply #'make-byte-code
2695 (if lexical-binding
2696 (byte-compile-make-args-desc arglist)
2697 arglist)
2698 (append
2699 ;; byte-string, constants-vector, stack depth
2700 (cdr compiled)
2701 ;; optionally, the doc string.
2702 (cond (lexical-binding
2703 (require 'help-fns)
2704 (list (help-add-fundoc-usage doc arglist)))
2705 ((or doc int)
2706 (list doc)))
2707 ;; optionally, the interactive spec.
2708 (if int
2709 (list (nth 1 int))))))))
b9598260 2710
876c194c 2711(defvar byte-compile-reserved-constants 0)
1c393159
JB
2712
2713(defun byte-compile-constants-vector ()
2714 ;; Builds the constants-vector from the current variables and constants.
2715 ;; This modifies the constants from (const . nil) to (const . offset).
2716 ;; To keep the byte-codes to look up the vector as short as possible:
2717 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2718 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2719 ;; Next variables again, to get 2-byte codes for variable lookup.
2720 ;; The rest of the constants and variables need 3-byte byte-codes.
876c194c 2721 (let* ((i (1- byte-compile-reserved-constants))
1c393159
JB
2722 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2723 (other (nreverse byte-compile-constants)) ; vars often are used most.
2724 ret tmp
2725 (limits '(5 ; Use the 1-byte varref codes,
2726 63 ; 1-constlim ; 1-byte byte-constant codes,
2727 255 ; 2-byte varref codes,
f9210e18
SM
2728 65535 ; 3-byte codes for the rest.
2729 65535)) ; twice since we step when we swap.
1c393159
JB
2730 limit)
2731 (while (or rest other)
2732 (setq limit (car limits))
876c194c
SM
2733 (while (and rest (< i limit))
2734 (cond
2735 ((numberp (car rest))
f80efb86 2736 (cl-assert (< (car rest) byte-compile-reserved-constants)))
876c194c
SM
2737 ((setq tmp (assq (car (car rest)) ret))
2738 (setcdr (car rest) (cdr tmp)))
2739 (t
1c393159 2740 (setcdr (car rest) (setq i (1+ i)))
876c194c 2741 (setq ret (cons (car rest) ret))))
1c393159 2742 (setq rest (cdr rest)))
f9210e18
SM
2743 (setq limits (cdr limits) ;Step
2744 rest (prog1 other ;&Swap.
1c393159
JB
2745 (setq other rest))))
2746 (apply 'vector (nreverse (mapcar 'car ret)))))
2747
2748;; Given an expression FORM, compile it and return an equivalent byte-code
2749;; expression (a call to the function byte-code).
2ec42da9 2750(defun byte-compile-top-level (form &optional for-effect output-type
876c194c 2751 lexenv reserved-csts)
1c393159
JB
2752 ;; OUTPUT-TYPE advises about how form is expected to be used:
2753 ;; 'eval or nil -> a single form,
2754 ;; 'progn or t -> a list of forms,
2755 ;; 'lambda -> body of a lambda,
2756 ;; 'file -> used at file-level.
2ec42da9 2757 (let ((byte-compile--for-effect for-effect)
9ace101c 2758 (byte-compile-constants nil)
285cdf4e
RS
2759 (byte-compile-variables nil)
2760 (byte-compile-tag-number 0)
2761 (byte-compile-depth 0)
2762 (byte-compile-maxdepth 0)
7200d79c 2763 (byte-compile--lexical-environment lexenv)
876c194c 2764 (byte-compile-reserved-constants (or reserved-csts 0))
285cdf4e 2765 (byte-compile-output nil))
b9598260 2766 (if (memq byte-optimize '(t source))
2ec42da9 2767 (setq form (byte-optimize-form form byte-compile--for-effect)))
b9598260
SM
2768 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2769 (setq form (nth 1 form)))
29a4dcb0
SM
2770 ;; Set up things for a lexically-bound function.
2771 (when (and lexical-binding (eq output-type 'lambda))
2772 ;; See how many arguments there are, and set the current stack depth
2773 ;; accordingly.
7200d79c 2774 (setq byte-compile-depth (length byte-compile--lexical-environment))
29a4dcb0
SM
2775 ;; If there are args, output a tag to record the initial
2776 ;; stack-depth for the optimizer.
2777 (when (> byte-compile-depth 0)
2778 (byte-compile-out-tag (byte-compile-make-tag))))
2779 ;; Now compile FORM
2780 (byte-compile-form form byte-compile--for-effect)
2781 (byte-compile-out-toplevel byte-compile--for-effect output-type)))
1c393159
JB
2782
2783(defun byte-compile-out-toplevel (&optional for-effect output-type)
2784 (if for-effect
2785 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2786 (if (eq (car (car byte-compile-output)) 'byte-discard)
2787 (setq byte-compile-output (cdr byte-compile-output))
2788 (byte-compile-push-constant
2789 ;; Push any constant - preferably one which already is used, and
2790 ;; a number or symbol - ie not some big sequence. The return value
2791 ;; isn't returned, but it would be a shame if some textually large
2792 ;; constant was not optimized away because we chose to return it.
2793 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2794 (let ((tmp (reverse byte-compile-constants)))
ba76e7fa
SM
2795 (while (and tmp (not (or (symbolp (caar tmp))
2796 (numberp (caar tmp)))))
1c393159 2797 (setq tmp (cdr tmp)))
ba76e7fa 2798 (caar tmp))))))
1c393159
JB
2799 (byte-compile-out 'byte-return 0)
2800 (setq byte-compile-output (nreverse byte-compile-output))
2801 (if (memq byte-optimize '(t byte))
2802 (setq byte-compile-output
9ace101c 2803 (byte-optimize-lapcode byte-compile-output)))
1f006824 2804
1c393159
JB
2805 ;; Decompile trivial functions:
2806 ;; only constants and variables, or a single funcall except in lambdas.
2807 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2808 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2809 ;; Note that even (quote foo) must be parsed just as any subr by the
2810 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2811 ;; What to leave uncompiled:
69dc83fd
KH
2812 ;; lambda -> never. we used to leave it uncompiled if the body was
2813 ;; a single atom, but that causes confusion if the docstring
2814 ;; uses the (file . pos) syntax. Besides, now that we have
2815 ;; the Lisp_Compiled type, the compiled form is faster.
1c393159
JB
2816 ;; eval -> atom, quote or (function atom atom atom)
2817 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2818 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2819 (let (rest
2820 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2821 tmp body)
2822 (cond
2823 ;; #### This should be split out into byte-compile-nontrivial-function-p.
69dc83fd
KH
2824 ((or (eq output-type 'lambda)
2825 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
1c393159
JB
2826 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2827 (not (setq tmp (assq 'byte-return byte-compile-output)))
2828 (progn
2829 (setq rest (nreverse
2830 (cdr (memq tmp (reverse byte-compile-output)))))
2ec42da9
SM
2831 (while
2832 (cond
2833 ((memq (car (car rest)) '(byte-varref byte-constant))
2834 (setq tmp (car (cdr (car rest))))
2835 (if (if (eq (car (car rest)) 'byte-constant)
2836 (or (consp tmp)
2837 (and (symbolp tmp)
4dd1c416 2838 (not (macroexp--const-symbol-p tmp)))))
2ec42da9
SM
2839 (if maycall
2840 (setq body (cons (list 'quote tmp) body)))
2841 (setq body (cons tmp body))))
2842 ((and maycall
2843 ;; Allow a funcall if at most one atom follows it.
2844 (null (nthcdr 3 rest))
2845 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2846 (or (null (cdr rest))
2847 (and (memq output-type '(file progn t))
2848 (cdr (cdr rest))
2849 (eq (car (nth 1 rest)) 'byte-discard)
2850 (progn (setq rest (cdr rest)) t))))
2851 (setq maycall nil) ; Only allow one real function call.
2852 (setq body (nreverse body))
2853 (setq body (list
2854 (if (and (eq tmp 'funcall)
f5925cd9
SM
2855 (eq (car-safe (car body)) 'quote)
2856 (symbolp (nth 1 (car body))))
2ec42da9
SM
2857 (cons (nth 1 (car body)) (cdr body))
2858 (cons tmp body))))
2859 (or (eq output-type 'file)
2860 (not (delq nil (mapcar 'consp (cdr (car body))))))))
1c393159 2861 (setq rest (cdr rest)))
69dc83fd 2862 rest))
1c393159
JB
2863 (let ((byte-compile-vector (byte-compile-constants-vector)))
2864 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2865 byte-compile-vector byte-compile-maxdepth)))
2866 ;; it's a trivial function
2867 ((cdr body) (cons 'progn (nreverse body)))
2868 ((car body)))))
2869
ca105506
SM
2870;; Given BODY, compile it and return a new body.
2871(defun byte-compile-top-level-body (body &optional for-effect)
2872 (setq body
2873 (byte-compile-top-level (cons 'progn body) for-effect t))
2874 (cond ((eq (car-safe body) 'progn)
2875 (cdr body))
2876 (body
2877 (list body))))
d97362d7 2878
a9de04fa
SM
2879;; Special macro-expander used during byte-compilation.
2880(defun byte-compile-macroexpand-declare-function (fn file &rest args)
2881 (push (cons fn
2882 (if (and (consp args) (listp (car args)))
2883 (list 'declared (car args))
4a5f187a 2884 t)) ; Arglist not specified.
d97362d7 2885 byte-compile-function-environment)
a342aca4
GM
2886 ;; We are stating that it _will_ be defined at runtime.
2887 (setq byte-compile-noruntime-functions
a9de04fa
SM
2888 (delq fn byte-compile-noruntime-functions))
2889 ;; Delegate the rest to the normal macro definition.
2890 (macroexpand `(declare-function ,fn ,file ,@args)))
d97362d7 2891
1c393159 2892\f
c5091f25 2893;; This is the recursive entry point for compiling each subform of an
1c393159
JB
2894;; expression.
2895;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2896;; before terminating (ie no value will be left on the stack).
2ec42da9
SM
2897;; A byte-compile handler may, when byte-compile--for-effect is non-nil, choose
2898;; output code which does not leave a value on the stack, and then set
2899;; byte-compile--for-effect to nil (to prevent byte-compile-form from
2900;; outputting the byte-discard).
1c393159 2901;; If a handler wants to call another handler, it should do so via
2ec42da9
SM
2902;; byte-compile-form, or take extreme care to handle byte-compile--for-effect
2903;; correctly. (Use byte-compile-form-do-effect to reset the
2904;; byte-compile--for-effect flag too.)
1c393159
JB
2905;;
2906(defun byte-compile-form (form &optional for-effect)
2ec42da9 2907 (let ((byte-compile--for-effect for-effect))
9ace101c
SM
2908 (cond
2909 ((not (consp form))
4dd1c416 2910 (cond ((or (not (symbolp form)) (macroexp--const-symbol-p form))
9ace101c
SM
2911 (when (symbolp form)
2912 (byte-compile-set-symbol-position form))
2913 (byte-compile-constant form))
2ec42da9 2914 ((and byte-compile--for-effect byte-compile-delete-errors)
9ace101c
SM
2915 (when (symbolp form)
2916 (byte-compile-set-symbol-position form))
2ec42da9 2917 (setq byte-compile--for-effect nil))
9ace101c
SM
2918 (t
2919 (byte-compile-variable-ref form))))
2920 ((symbolp (car form))
ca105506
SM
2921 (let* ((fn (car form))
2922 (handler (get fn 'byte-compile)))
4dd1c416 2923 (when (macroexp--const-symbol-p fn)
ca105506 2924 (byte-compile-warn "`%s' called as a function" fn))
9ace101c 2925 (and (byte-compile-warning-enabled-p 'interactive-only)
ca105506 2926 (memq fn byte-compile-interactive-only-functions)
9ace101c 2927 (byte-compile-warn "`%s' used from Lisp code\n\
ca105506 2928That command is designed for interactive use only" fn))
9ace101c
SM
2929 (if (and (fboundp (car form))
2930 (eq (car-safe (symbol-function (car form))) 'macro))
9c848d8a
SM
2931 (byte-compile-log-warning
2932 (format "Forgot to expand macro %s" (car form)) nil :error))
ca105506 2933 (if (and handler
57a7d507
SM
2934 ;; Make sure that function exists.
2935 (and (functionp handler)
2936 ;; Ignore obsolete byte-compile function used by former
2937 ;; CL code to handle compiler macros (we do it
2938 ;; differently now).
2939 (not (eq handler 'cl-byte-compile-compiler-macro))))
ca105506 2940 (funcall handler form)
9ace101c
SM
2941 (byte-compile-normal-call form))
2942 (if (byte-compile-warning-enabled-p 'cl-functions)
2943 (byte-compile-cl-warn form))))
29a4dcb0
SM
2944 ((and (byte-code-function-p (car form))
2945 (memq byte-optimize '(t lap)))
2946 (byte-compile-unfold-bcf form))
2947 ((and (eq (car-safe (car form)) 'lambda)
9ace101c
SM
2948 ;; if the form comes out the same way it went in, that's
2949 ;; because it was malformed, and we couldn't unfold it.
2950 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2ec42da9
SM
2951 (byte-compile-form form byte-compile--for-effect)
2952 (setq byte-compile--for-effect nil))
9ace101c 2953 ((byte-compile-normal-call form)))
2ec42da9 2954 (if byte-compile--for-effect
9ace101c 2955 (byte-compile-discard))))
1c393159
JB
2956
2957(defun byte-compile-normal-call (form)
876c194c
SM
2958 (when (and (byte-compile-warning-enabled-p 'callargs)
2959 (symbolp (car form)))
2960 (if (memq (car form)
03408648
SM
2961 '(custom-declare-group custom-declare-variable
2962 custom-declare-face))
876c194c 2963 (byte-compile-nogroup-warn form))
a9de04fa
SM
2964 (when (get (car form) 'byte-obsolete-info)
2965 (byte-compile-warn-obsolete (car form)))
876c194c 2966 (byte-compile-callargs-warn form))
1c393159
JB
2967 (if byte-compile-generate-call-tree
2968 (byte-compile-annotate-call-tree form))
2ec42da9 2969 (when (and byte-compile--for-effect (eq (car form) 'mapcar)
cf637a34 2970 (byte-compile-warning-enabled-p 'mapcar))
89c91fdb
GM
2971 (byte-compile-set-symbol-position 'mapcar)
2972 (byte-compile-warn
2973 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
1c393159 2974 (byte-compile-push-constant (car form))
ed62683d 2975 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
1c393159
JB
2976 (byte-compile-out 'byte-call (length (cdr form))))
2977
29a4dcb0
SM
2978
2979;; Splice the given lap code into the current instruction stream.
2980;; If it has any labels in it, you're responsible for making sure there
2981;; are no collisions, and that byte-compile-tag-number is reasonable
2982;; after this is spliced in. The provided list is destroyed.
2983(defun byte-compile-inline-lapcode (lap end-depth)
2984 ;; "Replay" the operations: we used to just do
2985 ;; (setq byte-compile-output (nconc (nreverse lap) byte-compile-output))
2986 ;; but that fails to update byte-compile-depth, so we had to assume
2987 ;; that `lap' ends up adding exactly 1 element to the stack. This
2988 ;; happens to be true for byte-code generated by bytecomp.el without
2989 ;; lexical-binding, but it's not true in general, and it's not true for
2990 ;; code output by bytecomp.el with lexical-binding.
2991 (let ((endtag (byte-compile-make-tag)))
2992 (dolist (op lap)
2993 (cond
2994 ((eq (car op) 'TAG) (byte-compile-out-tag op))
2995 ((memq (car op) byte-goto-ops) (byte-compile-goto (car op) (cdr op)))
2996 ((eq (car op) 'byte-return)
2997 (byte-compile-discard (- byte-compile-depth end-depth) t)
2998 (byte-compile-goto 'byte-goto endtag))
2999 (t (byte-compile-out (car op) (cdr op)))))
3000 (byte-compile-out-tag endtag)))
3001
3002(defun byte-compile-unfold-bcf (form)
7200d79c 3003 "Inline call to byte-code-functions."
29a4dcb0
SM
3004 (let* ((byte-compile-bound-variables byte-compile-bound-variables)
3005 (fun (car form))
3006 (fargs (aref fun 0))
3007 (start-depth byte-compile-depth)
3008 (fmax2 (if (numberp fargs) (lsh fargs -7))) ;2*max+rest.
3009 ;; (fmin (if (numberp fargs) (logand fargs 127)))
3010 (alen (length (cdr form)))
3011 (dynbinds ()))
3012 (fetch-bytecode fun)
3013 (mapc 'byte-compile-form (cdr form))
3014 (unless fmax2
3015 ;; Old-style byte-code.
f80efb86 3016 (cl-assert (listp fargs))
29a4dcb0 3017 (while fargs
f58e0fd5
SM
3018 (pcase (car fargs)
3019 (`&optional (setq fargs (cdr fargs)))
3020 (`&rest (setq fmax2 (+ (* 2 (length dynbinds)) 1))
29a4dcb0
SM
3021 (push (cadr fargs) dynbinds)
3022 (setq fargs nil))
f58e0fd5 3023 (_ (push (pop fargs) dynbinds))))
29a4dcb0
SM
3024 (unless fmax2 (setq fmax2 (* 2 (length dynbinds)))))
3025 (cond
3026 ((<= (+ alen alen) fmax2)
3027 ;; Add missing &optional (or &rest) arguments.
2462470b 3028 (dotimes (_ (- (/ (1+ fmax2) 2) alen))
29a4dcb0
SM
3029 (byte-compile-push-constant nil)))
3030 ((zerop (logand fmax2 1))
3031 (byte-compile-log-warning "Too many arguments for inlined function"
3032 nil :error)
3033 (byte-compile-discard (- alen (/ fmax2 2))))
3034 (t
3035 ;; Turn &rest args into a list.
3036 (let ((n (- alen (/ (1- fmax2) 2))))
f80efb86 3037 (cl-assert (> n 0) nil "problem: fmax2=%S alen=%S n=%S" fmax2 alen n)
29a4dcb0
SM
3038 (if (< n 5)
3039 (byte-compile-out
3040 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- n))
3041 0)
3042 (byte-compile-out 'byte-listN n)))))
3043 (mapc #'byte-compile-dynamic-variable-bind dynbinds)
3044 (byte-compile-inline-lapcode
3045 (byte-decompile-bytecode-1 (aref fun 1) (aref fun 2) t)
3046 (1+ start-depth))
3047 ;; Unbind dynamic variables.
3048 (when dynbinds
3049 (byte-compile-out 'byte-unbind (length dynbinds)))
f80efb86 3050 (cl-assert (eq byte-compile-depth (1+ start-depth))
29a4dcb0
SM
3051 nil "Wrong depth start=%s end=%s" start-depth byte-compile-depth)))
3052
2403c841
SM
3053(defun byte-compile-check-variable (var access-type)
3054 "Do various error checks before a use of the variable VAR."
b9598260
SM
3055 (when (symbolp var)
3056 (byte-compile-set-symbol-position var))
4dd1c416 3057 (cond ((or (not (symbolp var)) (macroexp--const-symbol-p var))
b9598260 3058 (when (byte-compile-warning-enabled-p 'constants)
2403c841 3059 (byte-compile-warn (if (eq access-type 'let-bind)
b9598260
SM
3060 "attempt to let-bind %s `%s`"
3061 "variable reference to %s `%s'")
3062 (if (symbolp var) "constant" "nonvariable")
3063 (prin1-to-string var))))
2403c841
SM
3064 ((let ((od (get var 'byte-obsolete-variable)))
3065 (and od
3066 (not (memq var byte-compile-not-obsolete-vars))
bac7ff22 3067 (not (memq var byte-compile-global-not-obsolete-vars))
f58e0fd5
SM
3068 (or (pcase (nth 1 od)
3069 (`set (not (eq access-type 'reference)))
3070 (`get (eq access-type 'reference))
3071 (_ t)))))
b9598260
SM
3072 (byte-compile-warn-obsolete var))))
3073
3074(defsubst byte-compile-dynamic-variable-op (base-op var)
3075 (let ((tmp (assq var byte-compile-variables)))
6c2161c4 3076 (unless tmp
b9598260 3077 (setq tmp (list var))
6c2161c4 3078 (push tmp byte-compile-variables))
1c393159
JB
3079 (byte-compile-out base-op tmp)))
3080
b9598260
SM
3081(defun byte-compile-dynamic-variable-bind (var)
3082 "Generate code to bind the lexical variable VAR to the top-of-stack value."
2403c841 3083 (byte-compile-check-variable var 'let-bind)
ce5b520a 3084 (push var byte-compile-bound-variables)
b9598260
SM
3085 (byte-compile-dynamic-variable-op 'byte-varbind var))
3086
b9598260
SM
3087(defun byte-compile-variable-ref (var)
3088 "Generate code to push the value of the variable VAR on the stack."
2403c841 3089 (byte-compile-check-variable var 'reference)
7200d79c 3090 (let ((lex-binding (assq var byte-compile--lexical-environment)))
b9598260
SM
3091 (if lex-binding
3092 ;; VAR is lexically bound
ce5b520a 3093 (byte-compile-stack-ref (cdr lex-binding))
b9598260
SM
3094 ;; VAR is dynamically bound
3095 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3096 (boundp var)
3097 (memq var byte-compile-bound-variables)
3098 (memq var byte-compile-free-references))
876c194c 3099 (byte-compile-warn "reference to free variable `%S'" var)
b9598260
SM
3100 (push var byte-compile-free-references))
3101 (byte-compile-dynamic-variable-op 'byte-varref var))))
3102
3103(defun byte-compile-variable-set (var)
3104 "Generate code to set the variable VAR from the top-of-stack value."
2403c841 3105 (byte-compile-check-variable var 'assign)
7200d79c 3106 (let ((lex-binding (assq var byte-compile--lexical-environment)))
b9598260 3107 (if lex-binding
61b108cc 3108 ;; VAR is lexically bound.
ce5b520a 3109 (byte-compile-stack-set (cdr lex-binding))
61b108cc 3110 ;; VAR is dynamically bound.
b9598260
SM
3111 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3112 (boundp var)
3113 (memq var byte-compile-bound-variables)
3114 (memq var byte-compile-free-assignments))
3115 (byte-compile-warn "assignment to free variable `%s'" var)
3116 (push var byte-compile-free-assignments))
3117 (byte-compile-dynamic-variable-op 'byte-varset var))))
3118
1c393159 3119(defmacro byte-compile-get-constant (const)
1639b803 3120 `(or (if (stringp ,const)
7fb4fa10
RS
3121 ;; In a string constant, treat properties as significant.
3122 (let (result)
3123 (dolist (elt byte-compile-constants)
3124 (if (equal-including-properties (car elt) ,const)
3125 (setq result elt)))
3126 result)
1639b803
DL
3127 (assq ,const byte-compile-constants))
3128 (car (setq byte-compile-constants
3129 (cons (list ,const) byte-compile-constants)))))
1c393159 3130
2ec42da9
SM
3131;; Use this when the value of a form is a constant.
3132;; This obeys byte-compile--for-effect.
1c393159 3133(defun byte-compile-constant (const)
2ec42da9
SM
3134 (if byte-compile--for-effect
3135 (setq byte-compile--for-effect nil)
ccb3c8de
CW
3136 (when (symbolp const)
3137 (byte-compile-set-symbol-position const))
1c393159
JB
3138 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
3139
3140;; Use this for a constant that is not the value of its containing form.
2ec42da9 3141;; This ignores byte-compile--for-effect.
1c393159 3142(defun byte-compile-push-constant (const)
2ec42da9 3143 (let ((byte-compile--for-effect nil))
1c393159 3144 (inline (byte-compile-constant const))))
1c393159
JB
3145\f
3146;; Compile those primitive ordinary functions
3147;; which have special byte codes just for speed.
3148
3149(defmacro byte-defop-compiler (function &optional compile-handler)
9d28c33e
SM
3150 "Add a compiler-form for FUNCTION.
3151If function is a symbol, then the variable \"byte-SYMBOL\" must name
3152the opcode to be used. If function is a list, the first element
3153is the function and the second element is the bytecode-symbol.
3154The second element may be nil, meaning there is no opcode.
3155COMPILE-HANDLER is the function to use to compile this byte-op, or
3156may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
3157If it is nil, then the handler is \"byte-compile-SYMBOL.\""
1c393159
JB
3158 (let (opcode)
3159 (if (symbolp function)
3160 (setq opcode (intern (concat "byte-" (symbol-name function))))
3161 (setq opcode (car (cdr function))
3162 function (car function)))
3163 (let ((fnform
3164 (list 'put (list 'quote function) ''byte-compile
3165 (list 'quote
3166 (or (cdr (assq compile-handler
3167 '((0 . byte-compile-no-args)
3168 (1 . byte-compile-one-arg)
3169 (2 . byte-compile-two-args)
3170 (3 . byte-compile-three-args)
3171 (0-1 . byte-compile-zero-or-one-arg)
3172 (1-2 . byte-compile-one-or-two-args)
3173 (2-3 . byte-compile-two-or-three-args)
3174 )))
3175 compile-handler
3176 (intern (concat "byte-compile-"
3177 (symbol-name function))))))))
3178 (if opcode
3179 (list 'progn fnform
3180 (list 'put (list 'quote function)
3181 ''byte-opcode (list 'quote opcode))
3182 (list 'put (list 'quote opcode)
3183 ''byte-opcode-invert (list 'quote function)))
3184 fnform))))
3185
1c393159
JB
3186(defmacro byte-defop-compiler-1 (function &optional compile-handler)
3187 (list 'byte-defop-compiler (list function nil) compile-handler))
3188
3189\f
3190(put 'byte-call 'byte-opcode-invert 'funcall)
3191(put 'byte-list1 'byte-opcode-invert 'list)
3192(put 'byte-list2 'byte-opcode-invert 'list)
3193(put 'byte-list3 'byte-opcode-invert 'list)
3194(put 'byte-list4 'byte-opcode-invert 'list)
3195(put 'byte-listN 'byte-opcode-invert 'list)
3196(put 'byte-concat2 'byte-opcode-invert 'concat)
3197(put 'byte-concat3 'byte-opcode-invert 'concat)
3198(put 'byte-concat4 'byte-opcode-invert 'concat)
3199(put 'byte-concatN 'byte-opcode-invert 'concat)
3200(put 'byte-insertN 'byte-opcode-invert 'insert)
3201
1c393159
JB
3202(byte-defop-compiler point 0)
3203;;(byte-defop-compiler mark 0) ;; obsolete
3204(byte-defop-compiler point-max 0)
3205(byte-defop-compiler point-min 0)
3206(byte-defop-compiler following-char 0)
3207(byte-defop-compiler preceding-char 0)
3208(byte-defop-compiler current-column 0)
3209(byte-defop-compiler eolp 0)
3210(byte-defop-compiler eobp 0)
3211(byte-defop-compiler bolp 0)
3212(byte-defop-compiler bobp 0)
3213(byte-defop-compiler current-buffer 0)
3214;;(byte-defop-compiler read-char 0) ;; obsolete
7200d79c 3215;; (byte-defop-compiler interactive-p 0) ;; Obsolete.
eef899a9
GM
3216(byte-defop-compiler widen 0)
3217(byte-defop-compiler end-of-line 0-1)
3218(byte-defop-compiler forward-char 0-1)
3219(byte-defop-compiler forward-line 0-1)
1c393159
JB
3220(byte-defop-compiler symbolp 1)
3221(byte-defop-compiler consp 1)
3222(byte-defop-compiler stringp 1)
3223(byte-defop-compiler listp 1)
3224(byte-defop-compiler not 1)
3225(byte-defop-compiler (null byte-not) 1)
3226(byte-defop-compiler car 1)
3227(byte-defop-compiler cdr 1)
3228(byte-defop-compiler length 1)
3229(byte-defop-compiler symbol-value 1)
3230(byte-defop-compiler symbol-function 1)
3231(byte-defop-compiler (1+ byte-add1) 1)
3232(byte-defop-compiler (1- byte-sub1) 1)
3233(byte-defop-compiler goto-char 1)
b8ae93ad 3234(byte-defop-compiler char-after 0-1)
1c393159
JB
3235(byte-defop-compiler set-buffer 1)
3236;;(byte-defop-compiler set-mark 1) ;; obsolete
eef899a9
GM
3237(byte-defop-compiler forward-word 0-1)
3238(byte-defop-compiler char-syntax 1)
3239(byte-defop-compiler nreverse 1)
3240(byte-defop-compiler car-safe 1)
3241(byte-defop-compiler cdr-safe 1)
3242(byte-defop-compiler numberp 1)
3243(byte-defop-compiler integerp 1)
3244(byte-defop-compiler skip-chars-forward 1-2)
3245(byte-defop-compiler skip-chars-backward 1-2)
1c393159
JB
3246(byte-defop-compiler eq 2)
3247(byte-defop-compiler memq 2)
3248(byte-defop-compiler cons 2)
3249(byte-defop-compiler aref 2)
3250(byte-defop-compiler set 2)
3251(byte-defop-compiler (= byte-eqlsign) 2)
3252(byte-defop-compiler (< byte-lss) 2)
3253(byte-defop-compiler (> byte-gtr) 2)
3254(byte-defop-compiler (<= byte-leq) 2)
3255(byte-defop-compiler (>= byte-geq) 2)
3256(byte-defop-compiler get 2)
3257(byte-defop-compiler nth 2)
3258(byte-defop-compiler substring 2-3)
eef899a9
GM
3259(byte-defop-compiler (move-marker byte-set-marker) 2-3)
3260(byte-defop-compiler set-marker 2-3)
3261(byte-defop-compiler match-beginning 1)
3262(byte-defop-compiler match-end 1)
3263(byte-defop-compiler upcase 1)
3264(byte-defop-compiler downcase 1)
3265(byte-defop-compiler string= 2)
3266(byte-defop-compiler string< 2)
3267(byte-defop-compiler (string-equal byte-string=) 2)
3268(byte-defop-compiler (string-lessp byte-string<) 2)
3269(byte-defop-compiler equal 2)
3270(byte-defop-compiler nthcdr 2)
3271(byte-defop-compiler elt 2)
3272(byte-defop-compiler member 2)
3273(byte-defop-compiler assq 2)
3274(byte-defop-compiler (rplaca byte-setcar) 2)
3275(byte-defop-compiler (rplacd byte-setcdr) 2)
3276(byte-defop-compiler setcar 2)
3277(byte-defop-compiler setcdr 2)
3278(byte-defop-compiler buffer-substring 2)
3279(byte-defop-compiler delete-region 2)
3280(byte-defop-compiler narrow-to-region 2)
3281(byte-defop-compiler (% byte-rem) 2)
1c393159
JB
3282(byte-defop-compiler aset 3)
3283
3284(byte-defop-compiler max byte-compile-associative)
3285(byte-defop-compiler min byte-compile-associative)
3286(byte-defop-compiler (+ byte-plus) byte-compile-associative)
eef899a9 3287(byte-defop-compiler (* byte-mult) byte-compile-associative)
1c393159 3288
eef899a9 3289;;####(byte-defop-compiler move-to-column 1)
1c393159
JB
3290(byte-defop-compiler-1 interactive byte-compile-noop)
3291
3292\f
3293(defun byte-compile-subr-wrong-args (form n)
ccb3c8de 3294 (byte-compile-set-symbol-position (car form))
1d5c17c0 3295 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
1c393159
JB
3296 (car form) (length (cdr form))
3297 (if (= 1 (length (cdr form))) "" "s") n)
29a4dcb0 3298 ;; Get run-time wrong-number-of-args error.
1c393159
JB
3299 (byte-compile-normal-call form))
3300
3301(defun byte-compile-no-args (form)
3302 (if (not (= (length form) 1))
3303 (byte-compile-subr-wrong-args form "none")
3304 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3305
3306(defun byte-compile-one-arg (form)
3307 (if (not (= (length form) 2))
3308 (byte-compile-subr-wrong-args form 1)
3309 (byte-compile-form (car (cdr form))) ;; Push the argument
3310 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3311
3312(defun byte-compile-two-args (form)
3313 (if (not (= (length form) 3))
3314 (byte-compile-subr-wrong-args form 2)
3315 (byte-compile-form (car (cdr form))) ;; Push the arguments
3316 (byte-compile-form (nth 2 form))
3317 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3318
3319(defun byte-compile-three-args (form)
3320 (if (not (= (length form) 4))
3321 (byte-compile-subr-wrong-args form 3)
3322 (byte-compile-form (car (cdr form))) ;; Push the arguments
3323 (byte-compile-form (nth 2 form))
3324 (byte-compile-form (nth 3 form))
3325 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3326
3327(defun byte-compile-zero-or-one-arg (form)
3328 (let ((len (length form)))
3329 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3330 ((= len 2) (byte-compile-one-arg form))
3331 (t (byte-compile-subr-wrong-args form "0-1")))))
3332
3333(defun byte-compile-one-or-two-args (form)
3334 (let ((len (length form)))
3335 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3336 ((= len 3) (byte-compile-two-args form))
3337 (t (byte-compile-subr-wrong-args form "1-2")))))
3338
3339(defun byte-compile-two-or-three-args (form)
3340 (let ((len (length form)))
3341 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3342 ((= len 4) (byte-compile-three-args form))
3343 (t (byte-compile-subr-wrong-args form "2-3")))))
3344
9ace101c 3345(defun byte-compile-noop (_form)
1c393159
JB
3346 (byte-compile-constant nil))
3347
b9598260 3348(defun byte-compile-discard (&optional num preserve-tos)
2ec42da9
SM
3349 "Output byte codes to discard the NUM entries at the top of the stack.
3350NUM defaults to 1.
b9598260
SM
3351If PRESERVE-TOS is non-nil, preserve the top-of-stack value, as if it were
3352popped before discarding the num values, and then pushed back again after
3353discarding."
3354 (if (and (null num) (not preserve-tos))
3355 ;; common case
3356 (byte-compile-out 'byte-discard)
3357 ;; general case
3358 (unless num
3359 (setq num 1))
3360 (when (and preserve-tos (> num 0))
3361 ;; Preserve the top-of-stack value by writing it directly to the stack
3362 ;; location which will be at the top-of-stack after popping.
3363 (byte-compile-stack-set (1- (- byte-compile-depth num)))
3364 ;; Now we actually discard one less value, since we want to keep
3365 ;; the eventual TOS
3366 (setq num (1- num)))
3367 (while (> num 0)
3368 (byte-compile-out 'byte-discard)
3369 (setq num (1- num)))))
3370
3371(defun byte-compile-stack-ref (stack-pos)
2ec42da9 3372 "Output byte codes to push the value at stack position STACK-POS."
3e21b6a7
SM
3373 (let ((dist (- byte-compile-depth (1+ stack-pos))))
3374 (if (zerop dist)
3375 ;; A simple optimization
3376 (byte-compile-out 'byte-dup)
3377 ;; normal case
3378 (byte-compile-out 'byte-stack-ref dist))))
b9598260
SM
3379
3380(defun byte-compile-stack-set (stack-pos)
2ec42da9 3381 "Output byte codes to store the TOS value at stack position STACK-POS."
3e21b6a7 3382 (byte-compile-out 'byte-stack-set (- byte-compile-depth (1+ stack-pos))))
1c393159 3383
cb9336bd
SM
3384(byte-defop-compiler-1 internal-make-closure byte-compile-make-closure)
3385(byte-defop-compiler-1 internal-get-closed-var byte-compile-get-closed-var)
3386
cb9336bd 3387(defun byte-compile-make-closure (form)
7200d79c 3388 "Byte-compile the special `internal-make-closure' form."
2ec42da9 3389 (if byte-compile--for-effect (setq byte-compile--for-effect nil)
876c194c
SM
3390 (let* ((vars (nth 1 form))
3391 (env (nth 2 form))
3392 (body (nthcdr 3 form))
3393 (fun
3394 (byte-compile-lambda `(lambda ,vars . ,body) nil (length env))))
f80efb86
SM
3395 (cl-assert (> (length env) 0)) ;Otherwise, we don't need a closure.
3396 (cl-assert (byte-code-function-p fun))
876c194c
SM
3397 (byte-compile-form `(make-byte-code
3398 ',(aref fun 0) ',(aref fun 1)
3399 (vconcat (vector . ,env) ',(aref fun 2))
3400 ,@(nthcdr 3 (mapcar (lambda (x) `',x) fun)))))))
cb9336bd
SM
3401
3402(defun byte-compile-get-closed-var (form)
7200d79c 3403 "Byte-compile the special `internal-get-closed-var' form."
2ec42da9 3404 (if byte-compile--for-effect (setq byte-compile--for-effect nil)
7200d79c 3405 (byte-compile-out 'byte-constant (nth 1 form))))
1c393159
JB
3406
3407;; Compile a function that accepts one or more args and is right-associative.
c0f43df5
RS
3408;; We do it by left-associativity so that the operations
3409;; are done in the same order as in interpreted code.
10809e0f
RS
3410;; We treat the one-arg case, as in (+ x), like (+ x 0).
3411;; in order to convert markers to numbers, and trigger expected errors.
1c393159
JB
3412(defun byte-compile-associative (form)
3413 (if (cdr form)
c0f43df5 3414 (let ((opcode (get (car form) 'byte-opcode))
24ae8da4
CY
3415 args)
3416 (if (and (< 3 (length form))
3417 (memq opcode (list (get '+ 'byte-opcode)
3418 (get '* 'byte-opcode))))
3419 ;; Don't use binary operations for > 2 operands, as that
3420 ;; may cause overflow/truncation in float operations.
3421 (byte-compile-normal-call form)
3422 (setq args (copy-sequence (cdr form)))
3423 (byte-compile-form (car args))
3424 (setq args (cdr args))
3425 (or args (setq args '(0)
3426 opcode (get '+ 'byte-opcode)))
3427 (dolist (arg args)
3428 (byte-compile-form arg)
3429 (byte-compile-out opcode 0))))
1c393159
JB
3430 (byte-compile-constant (eval form))))
3431
3432\f
3433;; more complicated compiler macros
3434
ec448ae2 3435(byte-defop-compiler char-before)
a746fb65
GM
3436(byte-defop-compiler backward-char)
3437(byte-defop-compiler backward-word)
1c393159
JB
3438(byte-defop-compiler list)
3439(byte-defop-compiler concat)
3440(byte-defop-compiler fset)
3441(byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3442(byte-defop-compiler indent-to)
3443(byte-defop-compiler insert)
3444(byte-defop-compiler-1 function byte-compile-function-form)
3445(byte-defop-compiler-1 - byte-compile-minus)
eef899a9
GM
3446(byte-defop-compiler (/ byte-quo) byte-compile-quo)
3447(byte-defop-compiler nconc)
1c393159 3448
ec448ae2 3449(defun byte-compile-char-before (form)
961166f5
GM
3450 (cond ((or (= 1 (length form))
3451 (and (= 2 (length form)) (not (nth 1 form))))
3452 (byte-compile-form '(char-after (1- (point)))))
3453 ((= 2 (length form))
a746fb65
GM
3454 (byte-compile-form (list 'char-after (if (numberp (nth 1 form))
3455 (1- (nth 1 form))
3456 `(1- ,(nth 1 form))))))
a746fb65
GM
3457 (t (byte-compile-subr-wrong-args form "0-1"))))
3458
3459;; backward-... ==> forward-... with negated argument.
3460(defun byte-compile-backward-char (form)
961166f5
GM
3461 (cond ((or (= 1 (length form))
3462 (and (= 2 (length form)) (not (nth 1 form))))
3463 (byte-compile-form '(forward-char -1)))
3464 ((= 2 (length form))
a746fb65
GM
3465 (byte-compile-form (list 'forward-char (if (numberp (nth 1 form))
3466 (- (nth 1 form))
3467 `(- ,(nth 1 form))))))
a746fb65
GM
3468 (t (byte-compile-subr-wrong-args form "0-1"))))
3469
3470(defun byte-compile-backward-word (form)
961166f5
GM
3471 (cond ((or (= 1 (length form))
3472 (and (= 2 (length form)) (not (nth 1 form))))
3473 (byte-compile-form '(forward-word -1)))
3474 ((= 2 (length form))
a746fb65
GM
3475 (byte-compile-form (list 'forward-word (if (numberp (nth 1 form))
3476 (- (nth 1 form))
3477 `(- ,(nth 1 form))))))
a746fb65 3478 (t (byte-compile-subr-wrong-args form "0-1"))))
ec448ae2 3479
1c393159
JB
3480(defun byte-compile-list (form)
3481 (let ((count (length (cdr form))))
3482 (cond ((= count 0)
3483 (byte-compile-constant nil))
3484 ((< count 5)
ed62683d 3485 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3486 (byte-compile-out
3487 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
e5c89ce9 3488 ((< count 256)
ed62683d 3489 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3490 (byte-compile-out 'byte-listN count))
3491 (t (byte-compile-normal-call form)))))
3492
3493(defun byte-compile-concat (form)
3494 (let ((count (length (cdr form))))
3495 (cond ((and (< 1 count) (< count 5))
ed62683d 3496 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3497 (byte-compile-out
3498 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3499 0))
3500 ;; Concat of one arg is not a no-op if arg is not a string.
3501 ((= count 0)
3502 (byte-compile-form ""))
e5c89ce9 3503 ((< count 256)
ed62683d 3504 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3505 (byte-compile-out 'byte-concatN count))
3506 ((byte-compile-normal-call form)))))
3507
3508(defun byte-compile-minus (form)
24ae8da4
CY
3509 (let ((len (length form)))
3510 (cond
3511 ((= 1 len) (byte-compile-constant 0))
3512 ((= 2 len)
3513 (byte-compile-form (cadr form))
3514 (byte-compile-out 'byte-negate 0))
2b9c3b12 3515 ((= 3 len)
24ae8da4
CY
3516 (byte-compile-form (nth 1 form))
3517 (byte-compile-form (nth 2 form))
3518 (byte-compile-out 'byte-diff 0))
3519 ;; Don't use binary operations for > 2 operands, as that may
3520 ;; cause overflow/truncation in float operations.
3521 (t (byte-compile-normal-call form)))))
1c393159
JB
3522
3523(defun byte-compile-quo (form)
3524 (let ((len (length form)))
3525 (cond ((<= len 2)
3526 (byte-compile-subr-wrong-args form "2 or more"))
24ae8da4
CY
3527 ((= len 3)
3528 (byte-compile-two-args form))
1c393159 3529 (t
24ae8da4
CY
3530 ;; Don't use binary operations for > 2 operands, as that
3531 ;; may cause overflow/truncation in float operations.
3532 (byte-compile-normal-call form)))))
1c393159
JB
3533
3534(defun byte-compile-nconc (form)
3535 (let ((len (length form)))
3536 (cond ((= len 1)
3537 (byte-compile-constant nil))
3538 ((= len 2)
3539 ;; nconc of one arg is a noop, even if that arg isn't a list.
3540 (byte-compile-form (nth 1 form)))
3541 (t
3542 (byte-compile-form (car (setq form (cdr form))))
3543 (while (setq form (cdr form))
3544 (byte-compile-form (car form))
3545 (byte-compile-out 'byte-nconc 0))))))
3546
3547(defun byte-compile-fset (form)
3548 ;; warn about forms like (fset 'foo '(lambda () ...))
3549 ;; (where the lambda expression is non-trivial...)
3550 (let ((fn (nth 2 form))
3551 body)
3552 (if (and (eq (car-safe fn) 'quote)
3553 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3554 (progn
3555 (setq body (cdr (cdr fn)))
3556 (if (stringp (car body)) (setq body (cdr body)))
3557 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3558 (if (and (consp (car body))
3559 (not (eq 'byte-code (car (car body)))))
3560 (byte-compile-warn
1d5c17c0 3561 "A quoted lambda form is the second argument of `fset'. This is probably
1c393159 3562 not what you want, as that lambda cannot be compiled. Consider using
29a4dcb0 3563 the syntax #'(lambda (...) ...) instead.")))))
1c393159
JB
3564 (byte-compile-two-args form))
3565
1c393159
JB
3566;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3567;; Otherwise it will be incompatible with the interpreter,
3568;; and (funcall (function foo)) will lose with autoloads.
3569
3570(defun byte-compile-function-form (form)
bbca48fe
SM
3571 (byte-compile-constant (if (eq 'lambda (car-safe (nth 1 form)))
3572 (byte-compile-lambda (nth 1 form))
3573 (nth 1 form))))
1c393159
JB
3574
3575(defun byte-compile-indent-to (form)
3576 (let ((len (length form)))
3577 (cond ((= len 2)
3578 (byte-compile-form (car (cdr form)))
3579 (byte-compile-out 'byte-indent-to 0))
3580 ((= len 3)
3581 ;; no opcode for 2-arg case.
3582 (byte-compile-normal-call form))
3583 (t
3584 (byte-compile-subr-wrong-args form "1-2")))))
3585
3586(defun byte-compile-insert (form)
3587 (cond ((null (cdr form))
3588 (byte-compile-constant nil))
e5c89ce9 3589 ((<= (length form) 256)
ed62683d 3590 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3591 (if (cdr (cdr form))
3592 (byte-compile-out 'byte-insertN (length (cdr form)))
3593 (byte-compile-out 'byte-insert 0)))
3594 ((memq t (mapcar 'consp (cdr (cdr form))))
3595 (byte-compile-normal-call form))
3596 ;; We can split it; there is no function call after inserting 1st arg.
3597 (t
3598 (while (setq form (cdr form))
3599 (byte-compile-form (car form))
3600 (byte-compile-out 'byte-insert 0)
3601 (if (cdr form)
3602 (byte-compile-discard))))))
3603
1c393159
JB
3604\f
3605(byte-defop-compiler-1 setq)
3606(byte-defop-compiler-1 setq-default)
3607(byte-defop-compiler-1 quote)
1c393159
JB
3608
3609(defun byte-compile-setq (form)
ca105506
SM
3610 (let ((args (cdr form)))
3611 (if args
3612 (while args
3613 (byte-compile-form (car (cdr args)))
3614 (or byte-compile--for-effect (cdr (cdr args))
1c393159 3615 (byte-compile-out 'byte-dup 0))
ca105506
SM
3616 (byte-compile-variable-set (car args))
3617 (setq args (cdr (cdr args))))
1c393159 3618 ;; (setq), with no arguments.
2ec42da9
SM
3619 (byte-compile-form nil byte-compile--for-effect))
3620 (setq byte-compile--for-effect nil)))
1c393159
JB
3621
3622(defun byte-compile-setq-default (form)
9ae0c310 3623 (setq form (cdr form))
c548f821
GM
3624 (if (null form) ; (setq-default), with no arguments
3625 (byte-compile-form nil byte-compile--for-effect)
3626 (if (> (length form) 2)
3627 (let ((setters ()))
3628 (while (consp form)
3629 (push `(setq-default ,(pop form) ,(pop form)) setters))
3630 (byte-compile-form (cons 'progn (nreverse setters))))
3631 (let ((var (car form)))
3632 (and (or (not (symbolp var))
3633 (macroexp--const-symbol-p var t))
3634 (byte-compile-warning-enabled-p 'constants)
3635 (byte-compile-warn
3636 "variable assignment to %s `%s'"
3637 (if (symbolp var) "constant" "nonvariable")
3638 (prin1-to-string var)))
3639 (byte-compile-normal-call `(set-default ',var ,@(cdr form)))))))
9ae0c310
SM
3640
3641(byte-defop-compiler-1 set-default)
3642(defun byte-compile-set-default (form)
3643 (let ((varexp (car-safe (cdr-safe form))))
3644 (if (eq (car-safe varexp) 'quote)
3645 ;; If the varexp is constant, compile it as a setq-default
3646 ;; so we get more warnings.
3647 (byte-compile-setq-default `(setq-default ,(car-safe (cdr varexp))
3648 ,@(cddr form)))
3649 (byte-compile-normal-call form))))
1c393159
JB
3650
3651(defun byte-compile-quote (form)
3652 (byte-compile-constant (car (cdr form))))
1c393159
JB
3653\f
3654;;; control structures
3655
ca105506
SM
3656(defun byte-compile-body (body &optional for-effect)
3657 (while (cdr body)
3658 (byte-compile-form (car body) t)
3659 (setq body (cdr body)))
3660 (byte-compile-form (car body) for-effect))
1c393159 3661
ca105506
SM
3662(defsubst byte-compile-body-do-effect (body)
3663 (byte-compile-body body byte-compile--for-effect)
2ec42da9 3664 (setq byte-compile--for-effect nil))
1c393159 3665
52799cb8 3666(defsubst byte-compile-form-do-effect (form)
2ec42da9
SM
3667 (byte-compile-form form byte-compile--for-effect)
3668 (setq byte-compile--for-effect nil))
1c393159
JB
3669
3670(byte-defop-compiler-1 inline byte-compile-progn)
3671(byte-defop-compiler-1 progn)
3672(byte-defop-compiler-1 prog1)
3673(byte-defop-compiler-1 prog2)
3674(byte-defop-compiler-1 if)
3675(byte-defop-compiler-1 cond)
3676(byte-defop-compiler-1 and)
3677(byte-defop-compiler-1 or)
3678(byte-defop-compiler-1 while)
3679(byte-defop-compiler-1 funcall)
1c393159 3680(byte-defop-compiler-1 let)
b38b1ec0 3681(byte-defop-compiler-1 let* byte-compile-let)
1c393159
JB
3682
3683(defun byte-compile-progn (form)
3684 (byte-compile-body-do-effect (cdr form)))
3685
3686(defun byte-compile-prog1 (form)
3687 (byte-compile-form-do-effect (car (cdr form)))
3688 (byte-compile-body (cdr (cdr form)) t))
3689
3690(defun byte-compile-prog2 (form)
3691 (byte-compile-form (nth 1 form) t)
3692 (byte-compile-form-do-effect (nth 2 form))
3693 (byte-compile-body (cdr (cdr (cdr form))) t))
3694
3695(defmacro byte-compile-goto-if (cond discard tag)
1639b803
DL
3696 `(byte-compile-goto
3697 (if ,cond
3698 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3699 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3700 ,tag))
1c393159 3701
70f41945
DN
3702;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3703;; Only return items that are not in ONLY-IF-NOT-PRESENT.
516b3653
JB
3704(defun byte-compile-find-bound-condition (condition-param
3705 pred-list
70f41945
DN
3706 &optional only-if-not-present)
3707 (let ((result nil)
3708 (nth-one nil)
516b3653 3709 (cond-list
70f41945
DN
3710 (if (memq (car-safe condition-param) pred-list)
3711 ;; The condition appears by itself.
3712 (list condition-param)
3713 ;; If the condition is an `and', look for matches among the
3714 ;; `and' arguments.
3715 (when (eq 'and (car-safe condition-param))
3716 (cdr condition-param)))))
516b3653 3717
70f41945
DN
3718 (dolist (crt cond-list)
3719 (when (and (memq (car-safe crt) pred-list)
3720 (eq 'quote (car-safe (setq nth-one (nth 1 crt))))
3721 ;; Ignore if the symbol is already on the unresolved
3722 ;; list.
3723 (not (assq (nth 1 nth-one) ; the relevant symbol
3724 only-if-not-present)))
3725 (push (nth 1 (nth 1 crt)) result)))
3726 result))
3727
6b61353c
KH
3728(defmacro byte-compile-maybe-guarded (condition &rest body)
3729 "Execute forms in BODY, potentially guarded by CONDITION.
82a726b4 3730CONDITION is a variable whose value is a test in an `if' or `cond'.
d6dc41d5
GM
3731BODY is the code to compile in the first arm of the if or the body of
3732the cond clause. If CONDITION's value is of the form (fboundp 'foo)
ad50a502 3733or (boundp 'foo), the relevant warnings from BODY about foo's
8480fc7c 3734being undefined (or obsolete) will be suppressed.
82a726b4 3735
b2e948ee 3736If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
ad50a502 3737that suppresses all warnings during execution of BODY."
6b61353c 3738 (declare (indent 1) (debug t))
516b3653 3739 `(let* ((fbound-list (byte-compile-find-bound-condition
e703069f 3740 ,condition '(fboundp functionp)
70f41945 3741 byte-compile-unresolved-functions))
516b3653 3742 (bound-list (byte-compile-find-bound-condition
e703069f 3743 ,condition '(boundp default-boundp)))
6b61353c
KH
3744 ;; Maybe add to the bound list.
3745 (byte-compile-bound-variables
ce5b520a 3746 (append bound-list byte-compile-bound-variables)))
82a726b4 3747 (unwind-protect
2ec42da9
SM
3748 ;; If things not being bound at all is ok, so must them being
3749 ;; obsolete. Note that we add to the existing lists since Tramp
3750 ;; (ab)uses this feature.
8480fc7c
GM
3751 (let ((byte-compile-not-obsolete-vars
3752 (append byte-compile-not-obsolete-vars bound-list))
3753 (byte-compile-not-obsolete-funcs
3754 (append byte-compile-not-obsolete-funcs fbound-list)))
3755 ,@body)
82a726b4 3756 ;; Maybe remove the function symbol from the unresolved list.
70f41945
DN
3757 (dolist (fbound fbound-list)
3758 (when fbound
82a726b4
RS
3759 (setq byte-compile-unresolved-functions
3760 (delq (assq fbound byte-compile-unresolved-functions)
70f41945 3761 byte-compile-unresolved-functions)))))))
6b61353c 3762
1c393159
JB
3763(defun byte-compile-if (form)
3764 (byte-compile-form (car (cdr form)))
b8234c84 3765 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
9858f6c3 3766 ;; and avoid warnings about the relevant symbols in the consequent.
6b61353c
KH
3767 (let ((clause (nth 1 form))
3768 (donetag (byte-compile-make-tag)))
b8234c84
DL
3769 (if (null (nthcdr 3 form))
3770 ;; No else-forms
3771 (progn
2ec42da9 3772 (byte-compile-goto-if nil byte-compile--for-effect donetag)
6b61353c 3773 (byte-compile-maybe-guarded clause
2ec42da9 3774 (byte-compile-form (nth 2 form) byte-compile--for-effect))
b8234c84
DL
3775 (byte-compile-out-tag donetag))
3776 (let ((elsetag (byte-compile-make-tag)))
3777 (byte-compile-goto 'byte-goto-if-nil elsetag)
6b61353c 3778 (byte-compile-maybe-guarded clause
2ec42da9 3779 (byte-compile-form (nth 2 form) byte-compile--for-effect))
b8234c84
DL
3780 (byte-compile-goto 'byte-goto donetag)
3781 (byte-compile-out-tag elsetag)
300f994a 3782 (byte-compile-maybe-guarded (list 'not clause)
2ec42da9 3783 (byte-compile-body (cdr (cdr (cdr form))) byte-compile--for-effect))
b8234c84 3784 (byte-compile-out-tag donetag))))
2ec42da9 3785 (setq byte-compile--for-effect nil))
1c393159
JB
3786
3787(defun byte-compile-cond (clauses)
3788 (let ((donetag (byte-compile-make-tag))
3789 nexttag clause)
3790 (while (setq clauses (cdr clauses))
3791 (setq clause (car clauses))
3792 (cond ((or (eq (car clause) t)
3793 (and (eq (car-safe (car clause)) 'quote)
3794 (car-safe (cdr-safe (car clause)))))
3795 ;; Unconditional clause
3796 (setq clause (cons t clause)
3797 clauses nil))
3798 ((cdr clauses)
3799 (byte-compile-form (car clause))
3800 (if (null (cdr clause))
3801 ;; First clause is a singleton.
2ec42da9 3802 (byte-compile-goto-if t byte-compile--for-effect donetag)
82a726b4
RS
3803 (setq nexttag (byte-compile-make-tag))
3804 (byte-compile-goto 'byte-goto-if-nil nexttag)
3805 (byte-compile-maybe-guarded (car clause)
2ec42da9 3806 (byte-compile-body (cdr clause) byte-compile--for-effect))
82a726b4
RS
3807 (byte-compile-goto 'byte-goto donetag)
3808 (byte-compile-out-tag nexttag)))))
1c393159 3809 ;; Last clause
6b61353c
KH
3810 (let ((guard (car clause)))
3811 (and (cdr clause) (not (eq guard t))
3812 (progn (byte-compile-form guard)
2ec42da9 3813 (byte-compile-goto-if nil byte-compile--for-effect donetag)
6b61353c
KH
3814 (setq clause (cdr clause))))
3815 (byte-compile-maybe-guarded guard
3816 (byte-compile-body-do-effect clause)))
1c393159
JB
3817 (byte-compile-out-tag donetag)))
3818
3819(defun byte-compile-and (form)
3820 (let ((failtag (byte-compile-make-tag))
ca105506
SM
3821 (args (cdr form)))
3822 (if (null args)
1c393159 3823 (byte-compile-form-do-effect t)
ca105506 3824 (byte-compile-and-recursion args failtag))))
8877fa6f 3825
83b0af6e 3826;; Handle compilation of a nontrivial `and' call.
8877fa6f
RS
3827;; We use tail recursion so we can use byte-compile-maybe-guarded.
3828(defun byte-compile-and-recursion (rest failtag)
3829 (if (cdr rest)
3830 (progn
3831 (byte-compile-form (car rest))
2ec42da9 3832 (byte-compile-goto-if nil byte-compile--for-effect failtag)
8877fa6f
RS
3833 (byte-compile-maybe-guarded (car rest)
3834 (byte-compile-and-recursion (cdr rest) failtag)))
3835 (byte-compile-form-do-effect (car rest))
3836 (byte-compile-out-tag failtag)))
1c393159
JB
3837
3838(defun byte-compile-or (form)
3839 (let ((wintag (byte-compile-make-tag))
ca105506
SM
3840 (args (cdr form)))
3841 (if (null args)
1c393159 3842 (byte-compile-form-do-effect nil)
ca105506 3843 (byte-compile-or-recursion args wintag))))
83b0af6e
RS
3844
3845;; Handle compilation of a nontrivial `or' call.
3846;; We use tail recursion so we can use byte-compile-maybe-guarded.
3847(defun byte-compile-or-recursion (rest wintag)
3848 (if (cdr rest)
3849 (progn
3850 (byte-compile-form (car rest))
2ec42da9 3851 (byte-compile-goto-if t byte-compile--for-effect wintag)
83b0af6e
RS
3852 (byte-compile-maybe-guarded (list 'not (car rest))
3853 (byte-compile-or-recursion (cdr rest) wintag)))
3854 (byte-compile-form-do-effect (car rest))
3855 (byte-compile-out-tag wintag)))
1c393159
JB
3856
3857(defun byte-compile-while (form)
3858 (let ((endtag (byte-compile-make-tag))
3859 (looptag (byte-compile-make-tag)))
3860 (byte-compile-out-tag looptag)
3861 (byte-compile-form (car (cdr form)))
2ec42da9 3862 (byte-compile-goto-if nil byte-compile--for-effect endtag)
1c393159
JB
3863 (byte-compile-body (cdr (cdr form)) t)
3864 (byte-compile-goto 'byte-goto looptag)
3865 (byte-compile-out-tag endtag)
2ec42da9 3866 (setq byte-compile--for-effect nil)))
1c393159
JB
3867
3868(defun byte-compile-funcall (form)
ed62683d 3869 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3870 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3871
b9598260
SM
3872\f
3873;; let binding
3874
ce5b520a 3875(defun byte-compile-push-binding-init (clause)
b9598260 3876 "Emit byte-codes to push the initialization value for CLAUSE on the stack.
ce5b520a
SM
3877Return the offset in the form (VAR . OFFSET)."
3878 (let* ((var (if (consp clause) (car clause) clause)))
208d0342
SM
3879 ;; We record the stack position even of dynamic bindings; we'll put
3880 ;; them in the proper place later.
ce5b520a 3881 (prog1 (cons var byte-compile-depth)
b9598260 3882 (if (consp clause)
ce5b520a
SM
3883 (byte-compile-form (cadr clause))
3884 (byte-compile-push-constant nil)))))
3885
3886(defun byte-compile-not-lexical-var-p (var)
b38b1ec0
SM
3887 (or (not (symbolp var))
3888 (special-variable-p var)
ce5b520a
SM
3889 (memq var byte-compile-bound-variables)
3890 (memq var '(nil t))
3891 (keywordp var)))
3892
3893(defun byte-compile-bind (var init-lexenv)
7200d79c 3894 "Emit byte-codes to bind VAR and update `byte-compile--lexical-environment'.
ce5b520a
SM
3895INIT-LEXENV should be a lexical-environment alist describing the
3896positions of the init value that have been pushed on the stack.
3897Return non-nil if the TOS value was popped."
208d0342 3898 ;; The mix of lexical and dynamic bindings mean that we may have to
b38b1ec0
SM
3899 ;; juggle things on the stack, to move them to TOS for
3900 ;; dynamic binding.
208d0342
SM
3901 (if (and lexical-binding (not (byte-compile-not-lexical-var-p var)))
3902 ;; VAR is a simple stack-allocated lexical variable.
3903 (progn (push (assq var init-lexenv)
3904 byte-compile--lexical-environment)
3905 nil)
3906 ;; VAR should be dynamically bound.
3907 (while (assq var byte-compile--lexical-environment)
3908 ;; This dynamic binding shadows a lexical binding.
3909 (setq byte-compile--lexical-environment
3910 (remq (assq var byte-compile--lexical-environment)
3911 byte-compile--lexical-environment)))
3912 (cond
3913 ((eq var (caar init-lexenv))
3914 ;; VAR is dynamic and is on the top of the
3915 ;; stack, so we can just bind it like usual.
3916 (byte-compile-dynamic-variable-bind var)
3917 t)
3918 (t
3919 ;; VAR is dynamic, but we have to get its
3920 ;; value out of the middle of the stack.
3921 (let ((stack-pos (cdr (assq var init-lexenv))))
3922 (byte-compile-stack-ref stack-pos)
3923 (byte-compile-dynamic-variable-bind var)
3924 ;; Now we have to store nil into its temporary
3925 ;; stack position so it doesn't prevent the value from being GC'd.
3926 ;; FIXME: Not worth the trouble.
3927 ;; (byte-compile-push-constant nil)
3928 ;; (byte-compile-stack-set stack-pos)
3929 )
3930 nil))))
3931
3932(defun byte-compile-unbind (clauses init-lexenv preserve-body-value)
ce5b520a
SM
3933 "Emit byte-codes to unbind the variables bound by CLAUSES.
3934CLAUSES is a `let'-style variable binding list. INIT-LEXENV should be a
3935lexical-environment alist describing the positions of the init value that
3936have been pushed on the stack. If PRESERVE-BODY-VALUE is true,
3937then an additional value on the top of the stack, above any lexical binding
3938slots, is preserved, so it will be on the top of the stack after all
3939binding slots have been popped."
208d0342 3940 ;; Unbind dynamic variables.
ce5b520a
SM
3941 (let ((num-dynamic-bindings 0))
3942 (dolist (clause clauses)
3943 (unless (assq (if (consp clause) (car clause) clause)
7200d79c 3944 byte-compile--lexical-environment)
ce5b520a
SM
3945 (setq num-dynamic-bindings (1+ num-dynamic-bindings))))
3946 (unless (zerop num-dynamic-bindings)
3947 (byte-compile-out 'byte-unbind num-dynamic-bindings)))
3948 ;; Pop lexical variables off the stack, possibly preserving the
3949 ;; return value of the body.
3950 (when init-lexenv
208d0342 3951 ;; INIT-LEXENV contains all init values left on the stack.
ce5b520a 3952 (byte-compile-discard (length init-lexenv) preserve-body-value)))
1c393159
JB
3953
3954(defun byte-compile-let (form)
208d0342 3955 "Generate code for the `let' or `let*' form FORM."
b38b1ec0 3956 (let ((clauses (cadr form))
208d0342
SM
3957 (init-lexenv nil)
3958 (is-let (eq (car form) 'let)))
3959 (when is-let
b38b1ec0
SM
3960 ;; First compute the binding values in the old scope.
3961 (dolist (var clauses)
3962 (push (byte-compile-push-binding-init var) init-lexenv)))
3963 ;; New scope.
3964 (let ((byte-compile-bound-variables byte-compile-bound-variables)
7200d79c
SM
3965 (byte-compile--lexical-environment
3966 byte-compile--lexical-environment))
b38b1ec0
SM
3967 ;; Bind the variables.
3968 ;; For `let', do it in reverse order, because it makes no
3969 ;; semantic difference, but it is a lot more efficient since the
3970 ;; values are now in reverse order on the stack.
208d0342
SM
3971 (dolist (var (if is-let (reverse clauses) clauses))
3972 (unless is-let
b38b1ec0
SM
3973 (push (byte-compile-push-binding-init var) init-lexenv))
3974 (let ((var (if (consp var) (car var) var)))
208d0342
SM
3975 (if (byte-compile-bind var init-lexenv)
3976 (pop init-lexenv))))
ce5b520a 3977 ;; Emit the body.
b38b1ec0
SM
3978 (let ((init-stack-depth byte-compile-depth))
3979 (byte-compile-body-do-effect (cdr (cdr form)))
208d0342
SM
3980 ;; Unbind both lexical and dynamic variables.
3981 (cl-assert (or (eq byte-compile-depth init-stack-depth)
3982 (eq byte-compile-depth (1+ init-stack-depth))))
3983 (byte-compile-unbind clauses init-lexenv
3984 (> byte-compile-depth init-stack-depth))))))
1c393159 3985
b9598260 3986\f
1c393159
JB
3987
3988(byte-defop-compiler-1 /= byte-compile-negated)
3989(byte-defop-compiler-1 atom byte-compile-negated)
3990(byte-defop-compiler-1 nlistp byte-compile-negated)
3991
3992(put '/= 'byte-compile-negated-op '=)
3993(put 'atom 'byte-compile-negated-op 'consp)
3994(put 'nlistp 'byte-compile-negated-op 'listp)
3995
3996(defun byte-compile-negated (form)
3997 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3998
3999;; Even when optimization is off, /= is optimized to (not (= ...)).
4000(defun byte-compile-negation-optimizer (form)
4001 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
ccb3c8de 4002 (byte-compile-set-symbol-position (car form))
1c393159
JB
4003 (list 'not
4004 (cons (or (get (car form) 'byte-compile-negated-op)
4005 (error
52799cb8 4006 "Compiler error: `%s' has no `byte-compile-negated-op' property"
1c393159
JB
4007 (car form)))
4008 (cdr form))))
4009\f
4010;;; other tricky macro-like special-forms
4011
4012(byte-defop-compiler-1 catch)
4013(byte-defop-compiler-1 unwind-protect)
4014(byte-defop-compiler-1 condition-case)
4015(byte-defop-compiler-1 save-excursion)
f3e472b0 4016(byte-defop-compiler-1 save-current-buffer)
1c393159 4017(byte-defop-compiler-1 save-restriction)
7200d79c
SM
4018;; (byte-defop-compiler-1 save-window-excursion) ;Obsolete: now a macro.
4019;; (byte-defop-compiler-1 with-output-to-temp-buffer) ;Obsolete: now a macro.
6e8d0db7 4020(byte-defop-compiler-1 track-mouse)
1c393159
JB
4021
4022(defun byte-compile-catch (form)
4023 (byte-compile-form (car (cdr form)))
d779e73c
SM
4024 (pcase (cddr form)
4025 (`(:fun-body ,f)
4026 (byte-compile-form `(list 'funcall ,f)))
4027 (body
4028 (byte-compile-push-constant
2ec42da9 4029 (byte-compile-top-level (cons 'progn body) byte-compile--for-effect))))
1c393159
JB
4030 (byte-compile-out 'byte-catch 0))
4031
4032(defun byte-compile-unwind-protect (form)
d779e73c
SM
4033 (pcase (cddr form)
4034 (`(:fun-body ,f)
4035 (byte-compile-form `(list (list 'funcall ,f))))
4036 (handlers
4037 (byte-compile-push-constant
4038 (byte-compile-top-level-body handlers t))))
1c393159
JB
4039 (byte-compile-out 'byte-unwind-protect 0)
4040 (byte-compile-form-do-effect (car (cdr form)))
4041 (byte-compile-out 'byte-unbind 1))
4042
6e8d0db7 4043(defun byte-compile-track-mouse (form)
d7846e08 4044 (byte-compile-form
d779e73c
SM
4045 (pcase form
4046 (`(,_ :fun-body ,f) `(eval (list 'track-mouse (list 'funcall ,f))))
4047 (_ `(eval '(track-mouse ,@(byte-compile-top-level-body (cdr form))))))))
6e8d0db7 4048
1c393159
JB
4049(defun byte-compile-condition-case (form)
4050 (let* ((var (nth 1 form))
ce5b520a
SM
4051 (fun-bodies (eq var :fun-body))
4052 (byte-compile-bound-variables
4053 (if (and var (not fun-bodies))
4054 (cons var byte-compile-bound-variables)
1c393159 4055 byte-compile-bound-variables)))
ccb3c8de
CW
4056 (byte-compile-set-symbol-position 'condition-case)
4057 (unless (symbolp var)
4058 (byte-compile-warn
1d5c17c0 4059 "`%s' is not a variable-name or nil (in condition-case)" var))
d779e73c 4060 (if fun-bodies (setq var (make-symbol "err")))
1c393159 4061 (byte-compile-push-constant var)
d779e73c
SM
4062 (if fun-bodies
4063 (byte-compile-form `(list 'funcall ,(nth 2 form)))
4064 (byte-compile-push-constant
2ec42da9 4065 (byte-compile-top-level (nth 2 form) byte-compile--for-effect)))
d779e73c
SM
4066 (let ((compiled-clauses
4067 (mapcar
4068 (lambda (clause)
4069 (let ((condition (car clause)))
4070 (cond ((not (or (symbolp condition)
4071 (and (listp condition)
4072 (let ((ok t))
4073 (dolist (sym condition)
4074 (if (not (symbolp sym))
4075 (setq ok nil)))
4076 ok))))
4077 (byte-compile-warn
4078 "`%S' is not a condition name or list of such (in condition-case)"
4079 condition))
4080 ;; (not (or (eq condition 't)
4081 ;; (and (stringp (get condition 'error-message))
4082 ;; (consp (get condition
4083 ;; 'error-conditions)))))
4084 ;; (byte-compile-warn
4085 ;; "`%s' is not a known condition name
4086 ;; (in condition-case)"
4087 ;; condition))
4088 )
4089 (if fun-bodies
4090 `(list ',condition (list 'funcall ,(cadr clause) ',var))
4091 (cons condition
4092 (byte-compile-top-level-body
2ec42da9 4093 (cdr clause) byte-compile--for-effect)))))
d779e73c
SM
4094 (cdr (cdr (cdr form))))))
4095 (if fun-bodies
4096 (byte-compile-form `(list ,@compiled-clauses))
4097 (byte-compile-push-constant compiled-clauses)))
1c393159
JB
4098 (byte-compile-out 'byte-condition-case 0)))
4099
4100
4101(defun byte-compile-save-excursion (form)
62a258a7
SM
4102 (if (and (eq 'set-buffer (car-safe (car-safe (cdr form))))
4103 (byte-compile-warning-enabled-p 'suspicious))
0a57d256
SM
4104 (byte-compile-warn
4105 "Use `with-current-buffer' rather than save-excursion+set-buffer"))
1c393159
JB
4106 (byte-compile-out 'byte-save-excursion 0)
4107 (byte-compile-body-do-effect (cdr form))
4108 (byte-compile-out 'byte-unbind 1))
4109
4110(defun byte-compile-save-restriction (form)
4111 (byte-compile-out 'byte-save-restriction 0)
4112 (byte-compile-body-do-effect (cdr form))
4113 (byte-compile-out 'byte-unbind 1))
4114
f3e472b0
RS
4115(defun byte-compile-save-current-buffer (form)
4116 (byte-compile-out 'byte-save-current-buffer 0)
4117 (byte-compile-body-do-effect (cdr form))
4118 (byte-compile-out 'byte-unbind 1))
1c393159
JB
4119\f
4120;;; top-level forms elsewhere
4121
1c393159
JB
4122(byte-defop-compiler-1 defvar)
4123(byte-defop-compiler-1 defconst byte-compile-defvar)
4124(byte-defop-compiler-1 autoload)
4125(byte-defop-compiler-1 lambda byte-compile-lambda-form)
4126
3aaaa6f1
SM
4127;; If foo.el declares `toto' as obsolete, it is likely that foo.el will
4128;; actually use `toto' in order for this obsolete variable to still work
4129;; correctly, so paradoxically, while byte-compiling foo.el, the presence
4130;; of a make-obsolete-variable call for `toto' is an indication that `toto'
4131;; should not trigger obsolete-warnings in foo.el.
4132(byte-defop-compiler-1 make-obsolete-variable)
4133(defun byte-compile-make-obsolete-variable (form)
4134 (when (eq 'quote (car-safe (nth 1 form)))
bac7ff22 4135 (push (nth 1 (nth 1 form)) byte-compile-global-not-obsolete-vars))
3aaaa6f1
SM
4136 (byte-compile-normal-call form))
4137
f3934f6f
SM
4138(defconst byte-compile-tmp-var (make-symbol "def-tmp-var"))
4139
1c393159 4140(defun byte-compile-defvar (form)
f3934f6f 4141 ;; This is not used for file-level defvar/consts.
4f1e9960 4142 (when (and (symbolp (nth 1 form))
3fe6ef4e 4143 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
4f1e9960 4144 (byte-compile-warning-enabled-p 'lexical))
7a16788b 4145 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
4f1e9960 4146 (nth 1 form)))
1bc20d83
GM
4147 (let ((fun (nth 0 form))
4148 (var (nth 1 form))
1c393159
JB
4149 (value (nth 2 form))
4150 (string (nth 3 form)))
ccb3c8de 4151 (byte-compile-set-symbol-position fun)
6c2161c4
SM
4152 (when (or (> (length form) 4)
4153 (and (eq fun 'defconst) (null (cddr form))))
d0e07261
SM
4154 (let ((ncall (length (cdr form))))
4155 (byte-compile-warn
1d5c17c0 4156 "`%s' called with %d argument%s, but %s %s"
d0e07261
SM
4157 fun ncall
4158 (if (= 1 ncall) "" "s")
4159 (if (< ncall 2) "requires" "accepts only")
4160 "2-3")))
2aea6521
GM
4161 (push var byte-compile-bound-variables)
4162 (if (eq fun 'defconst)
4163 (push var byte-compile-const-variables))
f3934f6f
SM
4164 (when (and string (not (stringp string)))
4165 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
4166 fun var string))
4167 (byte-compile-form-do-effect
4168 (if (cddr form) ; `value' provided
4169 ;; Quote with `quote' to prevent byte-compiling the body,
4170 ;; which would lead to an inf-loop.
4171 `(funcall '(lambda (,byte-compile-tmp-var)
4172 (,fun ,var ,byte-compile-tmp-var ,@(nthcdr 3 form)))
4173 ,value)
4174 (if (eq fun 'defconst)
4175 ;; This will signal an appropriate error at runtime.
4176 `(eval ',form)
4177 ;; A simple (defvar foo) just returns foo.
4178 `',var)))))
1c393159
JB
4179
4180(defun byte-compile-autoload (form)
ccb3c8de 4181 (byte-compile-set-symbol-position 'autoload)
4dd1c416
SM
4182 (and (macroexp-const-p (nth 1 form))
4183 (macroexp-const-p (nth 5 form))
1c393159
JB
4184 (eval (nth 5 form)) ; macro-p
4185 (not (fboundp (eval (nth 1 form))))
4186 (byte-compile-warn
c5091f25 4187 "The compiler ignores `autoload' except at top level. You should
1c393159
JB
4188 probably put the autoload of the macro `%s' at top-level."
4189 (eval (nth 1 form))))
4190 (byte-compile-normal-call form))
4191
c5091f25 4192;; Lambdas in valid places are handled as special cases by various code.
1c393159 4193;; The ones that remain are errors.
9ace101c 4194(defun byte-compile-lambda-form (_form)
ccb3c8de 4195 (byte-compile-set-symbol-position 'lambda)
1c393159
JB
4196 (error "`lambda' used as function name is invalid"))
4197
5286a842 4198;; Compile normally, but deal with warnings for the function being defined.
977b50fb 4199(put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
d1dc2cc2 4200;; Used for eieio--defalias as well.
977b50fb 4201(defun byte-compile-file-form-defalias (form)
61b108cc
SM
4202 ;; For the compilation itself, we could largely get rid of this hunk-handler,
4203 ;; if it weren't for the fact that we need to figure out when a defalias
4204 ;; defines a macro, so as to add it to byte-compile-macro-environment.
4205 ;;
4206 ;; FIXME: we also use this hunk-handler to implement the function's dynamic
4207 ;; docstring feature. We could actually implement it more elegantly in
4208 ;; byte-compile-lambda so it applies to all lambdas, but the problem is that
4209 ;; the resulting .elc format will not be recognized by make-docfile, so
4210 ;; either we stop using DOC for the docstrings of preloaded elc files (at the
4211 ;; cost of around 24KB on 32bit hosts, double on 64bit hosts) or we need to
4212 ;; build DOC in a more clever way (e.g. handle anonymous elements).
4213 (let ((byte-compile-free-references nil)
4214 (byte-compile-free-assignments nil))
4215 (pcase form
4216 ;; Decompose `form' into:
4217 ;; - `name' is the name of the defined function.
4218 ;; - `arg' is the expression to which it is defined.
4219 ;; - `rest' is the rest of the arguments.
4220 (`(,_ ',name ,arg . ,rest)
4221 (pcase-let*
4222 ;; `macro' is non-nil if it defines a macro.
4223 ;; `fun' is the function part of `arg' (defaults to `arg').
4224 (((or (and (or `(cons 'macro ,fun) `'(macro . ,fun)) (let macro t))
4225 (and (let fun arg) (let macro nil)))
4226 arg)
4227 ;; `lam' is the lambda expression in `fun' (or nil if not
4228 ;; recognized).
4229 ((or `(,(or `quote `function) ,lam) (let lam nil))
4230 fun)
4231 ;; `arglist' is the list of arguments (or t if not recognized).
4232 ;; `body' is the body of `lam' (or t if not recognized).
4233 ((or `(lambda ,arglist . ,body)
4234 ;; `(closure ,_ ,arglist . ,body)
4235 (and `(internal-make-closure ,arglist . ,_) (let body t))
4236 (and (let arglist t) (let body t)))
4237 lam))
4238 (unless (byte-compile-file-form-defmumble
4239 name macro arglist body rest)
4240 (byte-compile-keep-pending form))))
4241
4242 ;; We used to just do: (byte-compile-normal-call form)
4243 ;; But it turns out that this fails to optimize the code.
4244 ;; So instead we now do the same as what other byte-hunk-handlers do,
4245 ;; which is to call back byte-compile-file-form and then return nil.
4246 ;; Except that we can't just call byte-compile-file-form since it would
4247 ;; call us right back.
4248 (t (byte-compile-keep-pending form)))))
3c9dc1cf
RS
4249
4250(byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
4251(defun byte-compile-no-warnings (form)
4252 (let (byte-compile-warnings)
a4f66531 4253 (byte-compile-form (cons 'progn (cdr form)))))
01e4a4fa
SM
4254
4255;; Warn about misuses of make-variable-buffer-local.
49fec531
SM
4256(byte-defop-compiler-1 make-variable-buffer-local
4257 byte-compile-make-variable-buffer-local)
01e4a4fa 4258(defun byte-compile-make-variable-buffer-local (form)
15ce9dcf 4259 (if (and (eq (car-safe (car-safe (cdr-safe form))) 'quote)
cf637a34 4260 (byte-compile-warning-enabled-p 'make-local))
01e4a4fa
SM
4261 (byte-compile-warn
4262 "`make-variable-buffer-local' should be called at toplevel"))
4263 (byte-compile-normal-call form))
4264(put 'make-variable-buffer-local
4265 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
4266(defun byte-compile-form-make-variable-buffer-local (form)
4267 (byte-compile-keep-pending form 'byte-compile-normal-call))
4268
478d6f95
SM
4269(byte-defop-compiler-1 add-to-list byte-compile-add-to-list)
4270(defun byte-compile-add-to-list (form)
4271 ;; FIXME: This could be used for `set' as well, except that it's got
4272 ;; its own opcode, so the final `byte-compile-normal-call' needs to
4273 ;; be replaced with something else.
4274 (pcase form
4275 (`(,fun ',var . ,_)
4276 (byte-compile-check-variable var 'assign)
4277 (if (assq var byte-compile--lexical-environment)
4278 (byte-compile-log-warning
4279 (format "%s cannot use lexical var `%s'" fun var)
4280 nil :error)
4281 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
4282 (boundp var)
4283 (memq var byte-compile-bound-variables)
4284 (memq var byte-compile-free-references))
4285 (byte-compile-warn "assignment to free variable `%S'" var)
4286 (push var byte-compile-free-references)))))
4287 (byte-compile-normal-call form))
1c393159
JB
4288\f
4289;;; tags
4290
4291;; Note: Most operations will strip off the 'TAG, but it speeds up
4292;; optimization to have the 'TAG as a part of the tag.
4293;; Tags will be (TAG . (tag-number . stack-depth)).
4294(defun byte-compile-make-tag ()
4295 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
4296
4297
4298(defun byte-compile-out-tag (tag)
4299 (setq byte-compile-output (cons tag byte-compile-output))
4300 (if (cdr (cdr tag))
4301 (progn
4302 ;; ## remove this someday
4303 (and byte-compile-depth
b38b1ec0
SM
4304 (not (= (cdr (cdr tag)) byte-compile-depth))
4305 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
1c393159
JB
4306 (setq byte-compile-depth (cdr (cdr tag))))
4307 (setcdr (cdr tag) byte-compile-depth)))
4308
4309(defun byte-compile-goto (opcode tag)
6c2161c4 4310 (push (cons opcode tag) byte-compile-output)
1c393159
JB
4311 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
4312 (1- byte-compile-depth)
4313 byte-compile-depth))
4314 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
4315 (1- byte-compile-depth))))
4316
b9598260
SM
4317(defun byte-compile-stack-adjustment (op operand)
4318 "Return the amount by which an operation adjusts the stack.
4319OP and OPERAND are as passed to `byte-compile-out'."
4320 (if (memq op '(byte-call byte-discardN byte-discardN-preserve-tos))
4321 ;; For calls, OPERAND is the number of args, so we pop OPERAND + 1
4322 ;; elements, and the push the result, for a total of -OPERAND.
4323 ;; For discardN*, of course, we just pop OPERAND elements.
4324 (- operand)
4325 (or (aref byte-stack+-info (symbol-value op))
4326 ;; Ops with a nil entry in `byte-stack+-info' are byte-codes
4327 ;; that take OPERAND values off the stack and push a result, for
4328 ;; a total of 1 - OPERAND
4329 (- 1 operand))))
7200d79c 4330
b9598260
SM
4331(defun byte-compile-out (op &optional operand)
4332 (push (cons op operand) byte-compile-output)
4333 (if (eq op 'byte-return)
4334 ;; This is actually an unnecessary case, because there should be no
4335 ;; more ops behind byte-return.
4336 (setq byte-compile-depth nil)
4337 (setq byte-compile-depth
4338 (+ byte-compile-depth (byte-compile-stack-adjustment op operand)))
4339 (setq byte-compile-maxdepth (max byte-compile-depth byte-compile-maxdepth))
4340 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
4341 ))
1c393159
JB
4342\f
4343;;; call tree stuff
4344
4345(defun byte-compile-annotate-call-tree (form)
4346 (let (entry)
4347 ;; annotate the current call
4348 (if (setq entry (assq (car form) byte-compile-call-tree))
4349 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
4350 (setcar (cdr entry)
4351 (cons byte-compile-current-form (nth 1 entry))))
4352 (setq byte-compile-call-tree
4353 (cons (list (car form) (list byte-compile-current-form) nil)
4354 byte-compile-call-tree)))
4355 ;; annotate the current function
4356 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
4357 (or (memq (car form) (nth 2 entry)) ;called
4358 (setcar (cdr (cdr entry))
4359 (cons (car form) (nth 2 entry))))
4360 (setq byte-compile-call-tree
4361 (cons (list byte-compile-current-form nil (list (car form)))
4362 byte-compile-call-tree)))
4363 ))
4364
52799cb8
RS
4365;; Renamed from byte-compile-report-call-tree
4366;; to avoid interfering with completion of byte-compile-file.
fd5285f3 4367;;;###autoload
52799cb8
RS
4368(defun display-call-tree (&optional filename)
4369 "Display a call graph of a specified file.
4370This lists which functions have been called, what functions called
4371them, and what functions they call. The list includes all functions
4372whose definitions have been compiled in this Emacs session, as well as
4373all functions called by those functions.
1c393159 4374
52799cb8
RS
4375The call graph does not include macros, inline functions, or
4376primitives that the byte-code interpreter knows about directly \(eq,
4377cons, etc.\).
1c393159
JB
4378
4379The call tree also lists those functions which are not known to be called
52799cb8
RS
4380\(that is, to which no calls have been compiled\), and which cannot be
4381invoked interactively."
1c393159
JB
4382 (interactive)
4383 (message "Generating call tree...")
4384 (with-output-to-temp-buffer "*Call-Tree*"
4385 (set-buffer "*Call-Tree*")
4386 (erase-buffer)
47cf9d3a 4387 (message "Generating call tree... (sorting on %s)"
1c393159
JB
4388 byte-compile-call-tree-sort)
4389 (insert "Call tree for "
4390 (cond ((null byte-compile-current-file) (or filename "???"))
4391 ((stringp byte-compile-current-file)
4392 byte-compile-current-file)
4393 (t (buffer-name byte-compile-current-file)))
4394 " sorted on "
4395 (prin1-to-string byte-compile-call-tree-sort)
4396 ":\n\n")
4397 (if byte-compile-call-tree-sort
4398 (setq byte-compile-call-tree
4399 (sort byte-compile-call-tree
f58e0fd5
SM
4400 (pcase byte-compile-call-tree-sort
4401 (`callers
2ec42da9
SM
4402 (lambda (x y) (< (length (nth 1 x))
4403 (length (nth 1 y)))))
f58e0fd5 4404 (`calls
2ec42da9
SM
4405 (lambda (x y) (< (length (nth 2 x))
4406 (length (nth 2 y)))))
f58e0fd5 4407 (`calls+callers
2ec42da9
SM
4408 (lambda (x y) (< (+ (length (nth 1 x))
4409 (length (nth 2 x)))
4410 (+ (length (nth 1 y))
4411 (length (nth 2 y))))))
f58e0fd5 4412 (`name
2ec42da9 4413 (lambda (x y) (string< (car x) (car y))))
f58e0fd5 4414 (_ (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
2ec42da9 4415 byte-compile-call-tree-sort))))))
1c393159
JB
4416 (message "Generating call tree...")
4417 (let ((rest byte-compile-call-tree)
4418 (b (current-buffer))
4419 f p
4420 callers calls)
4421 (while rest
4422 (prin1 (car (car rest)) b)
4423 (setq callers (nth 1 (car rest))
4424 calls (nth 2 (car rest)))
4425 (insert "\t"
4426 (cond ((not (fboundp (setq f (car (car rest)))))
4427 (if (null f)
4428 " <top level>";; shouldn't insert nil then, actually -sk
4429 " <not defined>"))
4430 ((subrp (setq f (symbol-function f)))
4431 " <subr>")
4432 ((symbolp f)
4433 (format " ==> %s" f))
ed015bdd 4434 ((byte-code-function-p f)
1c393159
JB
4435 "<compiled function>")
4436 ((not (consp f))
4437 "<malformed function>")
4438 ((eq 'macro (car f))
ed015bdd 4439 (if (or (byte-code-function-p (cdr f))
1c393159
JB
4440 (assq 'byte-code (cdr (cdr (cdr f)))))
4441 " <compiled macro>"
4442 " <macro>"))
4443 ((assq 'byte-code (cdr (cdr f)))
4444 "<compiled lambda>")
4445 ((eq 'lambda (car f))
4446 "<function>")
4447 (t "???"))
4448 (format " (%d callers + %d calls = %d)"
4449 ;; Does the optimizer eliminate common subexpressions?-sk
4450 (length callers)
4451 (length calls)
4452 (+ (length callers) (length calls)))
4453 "\n")
4454 (if callers
4455 (progn
4456 (insert " called by:\n")
4457 (setq p (point))
4458 (insert " " (if (car callers)
4459 (mapconcat 'symbol-name callers ", ")
4460 "<top level>"))
4461 (let ((fill-prefix " "))
78bba1c8
TTN
4462 (fill-region-as-paragraph p (point)))
4463 (unless (= 0 (current-column))
4464 (insert "\n"))))
1c393159
JB
4465 (if calls
4466 (progn
4467 (insert " calls:\n")
4468 (setq p (point))
4469 (insert " " (mapconcat 'symbol-name calls ", "))
4470 (let ((fill-prefix " "))
78bba1c8
TTN
4471 (fill-region-as-paragraph p (point)))
4472 (unless (= 0 (current-column))
4473 (insert "\n"))))
1c393159
JB
4474 (setq rest (cdr rest)))
4475
4476 (message "Generating call tree...(finding uncalled functions...)")
4477 (setq rest byte-compile-call-tree)
416d3588 4478 (let (uncalled def)
1c393159
JB
4479 (while rest
4480 (or (nth 1 (car rest))
416d3588
GM
4481 (null (setq f (caar rest)))
4482 (progn
4483 (setq def (byte-compile-fdefinition f t))
4484 (and (eq (car-safe def) 'macro)
4485 (eq (car-safe (cdr-safe def)) 'lambda)
4486 (setq def (cdr def)))
4487 (functionp def))
4488 (progn
4489 (setq def (byte-compile-fdefinition f nil))
4490 (and (eq (car-safe def) 'macro)
4491 (eq (car-safe (cdr-safe def)) 'lambda)
4492 (setq def (cdr def)))
4493 (commandp def))
1c393159
JB
4494 (setq uncalled (cons f uncalled)))
4495 (setq rest (cdr rest)))
4496 (if uncalled
4497 (let ((fill-prefix " "))
4498 (insert "Noninteractive functions not known to be called:\n ")
4499 (setq p (point))
4500 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
416d3588
GM
4501 (fill-region-as-paragraph p (point))))))
4502 (message "Generating call tree...done.")))
1c393159
JB
4503
4504\f
814c447f 4505;;;###autoload
7e7d0f8b
RS
4506(defun batch-byte-compile-if-not-done ()
4507 "Like `byte-compile-file' but doesn't recompile if already up to date.
4508Use this from the command line, with `-batch';
4509it won't work in an interactive Emacs."
4510 (batch-byte-compile t))
4511
1c393159
JB
4512;;; by crl@newton.purdue.edu
4513;;; Only works noninteractively.
fd5285f3 4514;;;###autoload
7e7d0f8b 4515(defun batch-byte-compile (&optional noforce)
52799cb8
RS
4516 "Run `byte-compile-file' on the files remaining on the command line.
4517Use this from the command line, with `-batch';
4518it won't work in an interactive Emacs.
4519Each file is processed even if an error occurred previously.
7e7d0f8b
RS
4520For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4521If NOFORCE is non-nil, don't recompile a file that seems to be
4522already up-to-date."
2ec42da9
SM
4523 ;; command-line-args-left is what is left of the command line, from
4524 ;; startup.el.
1c393159
JB
4525 (defvar command-line-args-left) ;Avoid 'free variable' warning
4526 (if (not noninteractive)
52799cb8 4527 (error "`batch-byte-compile' is to be used only with -batch"))
ca105506 4528 (let ((error nil))
1c393159
JB
4529 (while command-line-args-left
4530 (if (file-directory-p (expand-file-name (car command-line-args-left)))
7e7d0f8b 4531 ;; Directory as argument.
ca105506
SM
4532 (let (source dest)
4533 (dolist (file (directory-files (car command-line-args-left)))
4534 (if (and (string-match emacs-lisp-file-regexp file)
4535 (not (auto-save-file-name-p file))
4536 (setq source
4537 (expand-file-name file
1c3b663f 4538 (car command-line-args-left)))
ca105506
SM
4539 (setq dest (byte-compile-dest-file source))
4540 (file-exists-p dest)
4541 (file-newer-than-file-p source dest))
4542 (if (null (batch-byte-compile-file source))
4543 (setq error t)))))
7e7d0f8b
RS
4544 ;; Specific file argument
4545 (if (or (not noforce)
ca105506
SM
4546 (let* ((source (car command-line-args-left))
4547 (dest (byte-compile-dest-file source)))
4548 (or (not (file-exists-p dest))
4549 (file-newer-than-file-p source dest))))
7e7d0f8b 4550 (if (null (batch-byte-compile-file (car command-line-args-left)))
ca105506 4551 (setq error t))))
1c393159 4552 (setq command-line-args-left (cdr command-line-args-left)))
ca105506 4553 (kill-emacs (if error 1 0))))
1c393159 4554
ca105506 4555(defun batch-byte-compile-file (file)
3858bfe7
SM
4556 (let ((byte-compile-root-dir (or byte-compile-root-dir default-directory)))
4557 (if debug-on-error
4558 (byte-compile-file file)
4559 (condition-case err
4560 (byte-compile-file file)
4561 (file-error
4562 (message (if (cdr err)
4563 ">>Error occurred processing %s: %s (%s)"
4564 ">>Error occurred processing %s: %s")
4565 file
4566 (get (car err) 'error-message)
4567 (prin1-to-string (cdr err)))
4568 (let ((destfile (byte-compile-dest-file file)))
4569 (if (file-exists-p destfile)
4570 (delete-file destfile)))
4571 nil)
4572 (error
4573 (message (if (cdr err)
4574 ">>Error occurred processing %s: %s (%s)"
4575 ">>Error occurred processing %s: %s")
4576 file
4577 (get (car err) 'error-message)
4578 (prin1-to-string (cdr err)))
4579 nil)))))
1c393159 4580
49fec531
SM
4581(defun byte-compile-refresh-preloaded ()
4582 "Reload any Lisp file that was changed since Emacs was dumped.
4583Use with caution."
4584 (let* ((argv0 (car command-line-args))
4585 (emacs-file (executable-find argv0)))
4586 (if (not (and emacs-file (file-executable-p emacs-file)))
4587 (message "Can't find %s to refresh preloaded Lisp files" argv0)
4588 (dolist (f (reverse load-history))
4589 (setq f (car f))
4590 (if (string-match "elc\\'" f) (setq f (substring f 0 -1)))
4591 (when (and (file-readable-p f)
d032d5e7
SM
4592 (file-newer-than-file-p f emacs-file)
4593 ;; Don't reload the source version of the files below
4594 ;; because that causes subsequent byte-compilation to
4595 ;; be a lot slower and need a higher max-lisp-eval-depth,
4596 ;; so it can cause recompilation to fail.
4597 (not (member (file-name-nondirectory f)
4598 '("pcase.el" "bytecomp.el" "macroexp.el"
4599 "cconv.el" "byte-opt.el"))))
49fec531
SM
4600 (message "Reloading stale %s" (file-name-nondirectory f))
4601 (condition-case nil
4602 (load f 'noerror nil 'nosuffix)
4603 ;; Probably shouldn't happen, but in case of an error, it seems
4604 ;; at least as useful to ignore it as it is to stop compilation.
4605 (error nil)))))))
4606
e9681c45 4607;;;###autoload
6f8e3590 4608(defun batch-byte-recompile-directory (&optional arg)
4f6d5bf0 4609 "Run `byte-recompile-directory' on the dirs remaining on the command line.
79c6071d 4610Must be used only with `-batch', and kills Emacs on completion.
defe3b41
EZ
4611For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4612
4613Optional argument ARG is passed as second argument ARG to
516b3653 4614`byte-recompile-directory'; see there for its possible values
defe3b41 4615and corresponding effects."
e27c3564
JB
4616 ;; command-line-args-left is what is left of the command line (startup.el)
4617 (defvar command-line-args-left) ;Avoid 'free variable' warning
4618 (if (not noninteractive)
4619 (error "batch-byte-recompile-directory is to be used only with -batch"))
4620 (or command-line-args-left
4621 (setq command-line-args-left '(".")))
4622 (while command-line-args-left
6f8e3590 4623 (byte-recompile-directory (car command-line-args-left) arg)
e27c3564
JB
4624 (setq command-line-args-left (cdr command-line-args-left)))
4625 (kill-emacs 0))
4626
c4c8444a
SM
4627;;; Core compiler macros.
4628
4629(put 'featurep 'compiler-macro
4630 (lambda (form feature &rest _ignore)
4631 ;; Emacs-21's byte-code doesn't run under XEmacs or SXEmacs anyway, so
4632 ;; we can safely optimize away this test.
4633 (if (member feature '('xemacs 'sxemacs 'emacs))
4634 (eval form)
4635 form)))
4636
1c393159 4637(provide 'byte-compile)
200503bb 4638(provide 'bytecomp)
1c393159
JB
4639
4640\f
4641;;; report metering (see the hacks in bytecode.c)
4642
08d21785 4643(defvar byte-code-meter)
52799cb8 4644(defun byte-compile-report-ops ()
5a972c36
GM
4645 (or (boundp 'byte-metering-on)
4646 (error "You must build Emacs with -DBYTE_CODE_METER to use this"))
52799cb8
RS
4647 (with-output-to-temp-buffer "*Meter*"
4648 (set-buffer "*Meter*")
4649 (let ((i 0) n op off)
4650 (while (< i 256)
4651 (setq n (aref (aref byte-code-meter 0) i)
4652 off nil)
4653 (if t ;(not (zerop n))
4654 (progn
4655 (setq op i)
4656 (setq off nil)
4657 (cond ((< op byte-nth)
4658 (setq off (logand op 7))
4659 (setq op (logand op 248)))
4660 ((>= op byte-constant)
4661 (setq off (- op byte-constant)
4662 op byte-constant)))
4663 (setq op (aref byte-code-vector op))
4664 (insert (format "%-4d" i))
4665 (insert (symbol-name op))
4666 (if off (insert " [" (int-to-string off) "]"))
4667 (indent-to 40)
4668 (insert (int-to-string n) "\n")))
4669 (setq i (1+ i))))))
1c393159
JB
4670\f
4671;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4672;; itself, compile some of its most used recursive functions (at load time).
4673;;
4674(eval-when-compile
591655c7
SM
4675 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4676 (assq 'byte-code (symbol-function 'byte-compile-form))
4677 (let ((byte-optimize nil) ; do it fast
4678 (byte-compile-warnings nil))
86da2828
GM
4679 (mapc (lambda (x)
4680 (or noninteractive (message "compiling %s..." x))
4681 (byte-compile x)
4682 (or noninteractive (message "compiling %s...done" x)))
4683 '(byte-compile-normal-call
4684 byte-compile-form
4685 byte-compile-body
4686 ;; Inserted some more than necessary, to speed it up.
4687 byte-compile-top-level
4688 byte-compile-out-toplevel
4689 byte-compile-constant
4690 byte-compile-variable-ref))))
591655c7 4691 nil)
fd5285f3 4692
3433c43f
DL
4693(run-hooks 'bytecomp-load-hook)
4694
fd5285f3 4695;;; bytecomp.el ends here