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