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