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