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