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