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