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