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