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