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