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