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