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