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