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