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