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