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