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