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