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