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