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