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