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