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