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