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