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