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