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