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