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