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