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