(line_draw_cost): Fix invalid glyph check.
[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
SM
1121 (let* ((new (get (car form) 'byte-obsolete-info))
1122 (handler (nth 1 new))
1123 (when (nth 2 new)))
ccb3c8de 1124 (byte-compile-set-symbol-position (car form))
cf637a34 1125 (if (byte-compile-warning-enabled-p 'obsolete)
1d5c17c0 1126 (byte-compile-warn "`%s' is an obsolete function%s; %s" (car form)
f1953880 1127 (if when (concat " (as of Emacs " when ")") "")
9290191f
RS
1128 (if (stringp (car new))
1129 (car new)
1d5c17c0 1130 (format "use `%s' instead." (car new)))))
20482b70 1131 (funcall (or handler 'byte-compile-normal-call) form)))
1c393159
JB
1132\f
1133;; Compiler options
1134
52799cb8
RS
1135;; (defvar byte-compiler-valid-options
1136;; '((optimize byte-optimize (t nil source byte) val)
1137;; (file-format byte-compile-compatibility (emacs18 emacs19)
1138;; (eq val 'emacs18))
1139;; ;; (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
1140;; (delete-errors byte-compile-delete-errors (t nil) val)
1141;; (verbose byte-compile-verbose (t nil) val)
1142;; (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
1143;; val)))
1c393159
JB
1144
1145;; Inhibit v18/v19 selectors if the version is hardcoded.
c5091f25 1146;; #### This should print a warning if the user tries to change something
1c393159 1147;; than can't be changed because the running compiler doesn't support it.
52799cb8
RS
1148;; (cond
1149;; ((byte-compile-single-version)
1150;; (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
1151;; (list (byte-compile-version-cond
1152;; byte-compile-generate-emacs19-bytecodes)))
1153;; (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
1154;; (if (byte-compile-version-cond byte-compile-compatibility)
1155;; '(emacs18) '(emacs19)))))
1156
1157;; (defun byte-compiler-options-handler (&rest args)
1158;; (let (key val desc choices)
1159;; (while args
1160;; (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
1161;; (error "Malformed byte-compiler option `%s'" (car args)))
1162;; (setq key (car (car args))
1163;; val (car (cdr (car args)))
1164;; desc (assq key byte-compiler-valid-options))
1165;; (or desc
1166;; (error "Unknown byte-compiler option `%s'" key))
1167;; (setq choices (nth 2 desc))
1168;; (if (consp (car choices))
1169;; (let (this
1170;; (handler 'cons)
1171;; (ret (and (memq (car val) '(+ -))
1172;; (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
1173;; choices
1174;; (symbol-value (nth 1 desc)))))))
1175;; (setq choices (car choices))
1176;; (while val
1177;; (setq this (car val))
1178;; (cond ((memq this choices)
1179;; (setq ret (funcall handler this ret)))
1180;; ((eq this '+) (setq handler 'cons))
1181;; ((eq this '-) (setq handler 'delq))
1182;; ((error "`%s' only accepts %s" key choices)))
1183;; (setq val (cdr val)))
1184;; (set (nth 1 desc) ret))
1185;; (or (memq val choices)
1186;; (error "`%s' must be one of `%s'" key choices))
1187;; (set (nth 1 desc) (eval (nth 3 desc))))
1188;; (setq args (cdr args)))
1189;; nil))
1c393159
JB
1190\f
1191;;; sanity-checking arglists
1192
a7a7ddf1
RS
1193;; If a function has an entry saying (FUNCTION . t).
1194;; that means we know it is defined but we don't know how.
1195;; If a function has an entry saying (FUNCTION . nil),
1196;; that means treat it as not defined.
1c393159
JB
1197(defun byte-compile-fdefinition (name macro-p)
1198 (let* ((list (if macro-p
1199 byte-compile-macro-environment
5286a842 1200 byte-compile-function-environment))
1c393159
JB
1201 (env (cdr (assq name list))))
1202 (or env
1203 (let ((fn name))
1204 (while (and (symbolp fn)
1205 (fboundp fn)
1206 (or (symbolp (symbol-function fn))
1207 (consp (symbol-function fn))
1208 (and (not macro-p)
ed015bdd 1209 (byte-code-function-p (symbol-function fn)))))
1c393159 1210 (setq fn (symbol-function fn)))
ed015bdd 1211 (if (and (not macro-p) (byte-code-function-p fn))
1c393159
JB
1212 fn
1213 (and (consp fn)
1214 (if (eq 'macro (car fn))
1215 (cdr fn)
1216 (if macro-p
1217 nil
1218 (if (eq 'autoload (car fn))
1219 nil
1220 fn)))))))))
1221
1222(defun byte-compile-arglist-signature (arglist)
1223 (let ((args 0)
1224 opts
1225 restp)
1226 (while arglist
1227 (cond ((eq (car arglist) '&optional)
1228 (or opts (setq opts 0)))
1229 ((eq (car arglist) '&rest)
1230 (if (cdr arglist)
1231 (setq restp t
1232 arglist nil)))
1233 (t
1234 (if opts
1235 (setq opts (1+ opts))
1236 (setq args (1+ args)))))
1237 (setq arglist (cdr arglist)))
1238 (cons args (if restp nil (if opts (+ args opts) args)))))
1239
1240
1241(defun byte-compile-arglist-signatures-congruent-p (old new)
1242 (not (or
1243 (> (car new) (car old)) ; requires more args now
a7acbbe4 1244 (and (null (cdr old)) ; took rest-args, doesn't any more
1c393159
JB
1245 (cdr new))
1246 (and (cdr new) (cdr old) ; can't take as many args now
1247 (< (cdr new) (cdr old)))
1248 )))
1249
1250(defun byte-compile-arglist-signature-string (signature)
1251 (cond ((null (cdr signature))
1252 (format "%d+" (car signature)))
1253 ((= (car signature) (cdr signature))
1254 (format "%d" (car signature)))
1255 (t (format "%d-%d" (car signature) (cdr signature)))))
1256
1257
52799cb8 1258;; Warn if the form is calling a function with the wrong number of arguments.
1c393159 1259(defun byte-compile-callargs-warn (form)
1c393159
JB
1260 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1261 (byte-compile-fdefinition (car form) t)))
a7a7ddf1 1262 (sig (if (and def (not (eq def t)))
ed62683d 1263 (byte-compile-arglist-signature
d97362d7 1264 (if (memq (car-safe def) '(declared lambda))
ed62683d
DL
1265 (nth 1 def)
1266 (if (byte-code-function-p def)
1267 (aref def 0)
1268 '(&rest def))))
1269 (if (and (fboundp (car form))
1270 (subrp (symbol-function (car form))))
1271 (subr-arity (symbol-function (car form))))))
1c393159 1272 (ncall (length (cdr form))))
ed62683d
DL
1273 ;; Check many or unevalled from subr-arity.
1274 (if (and (cdr-safe sig)
1275 (not (numberp (cdr sig))))
1276 (setcdr sig nil))
1c393159 1277 (if sig
ccb3c8de 1278 (when (or (< ncall (car sig))
1c393159 1279 (and (cdr sig) (> ncall (cdr sig))))
ccb3c8de
CW
1280 (byte-compile-set-symbol-position (car form))
1281 (byte-compile-warn
1282 "%s called with %d argument%s, but %s %s"
1283 (car form) ncall
1284 (if (= 1 ncall) "" "s")
1285 (if (< ncall (car sig))
1286 "requires"
1287 "accepts only")
ba76e7fa 1288 (byte-compile-arglist-signature-string sig))))
6b61353c 1289 (byte-compile-format-warn form)
ba76e7fa
SM
1290 ;; Check to see if the function will be available at runtime
1291 ;; and/or remember its arity if it's unknown.
a7a7ddf1 1292 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
6b61353c 1293 (not (memq (car form) byte-compile-noruntime-functions)))
ba76e7fa
SM
1294 (eq (car form) byte-compile-current-form) ; ## this doesn't work
1295 ; with recursion.
1296 ;; It's a currently-undefined function.
1297 ;; Remember number of args in call.
1298 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1299 (n (length (cdr form))))
1300 (if cons
1301 (or (memq n (cdr cons))
1302 (setcdr cons (cons n (cdr cons))))
977b50fb
SM
1303 (push (list (car form) n)
1304 byte-compile-unresolved-functions))))))
1c393159 1305
6b61353c
KH
1306(defun byte-compile-format-warn (form)
1307 "Warn if FORM is `format'-like with inconsistent args.
1308Applies if head of FORM is a symbol with non-nil property
1309`byte-compile-format-like' and first arg is a constant string.
1310Then check the number of format fields matches the number of
1311extra args."
1312 (when (and (symbolp (car form))
1313 (stringp (nth 1 form))
1314 (get (car form) 'byte-compile-format-like))
1315 (let ((nfields (with-temp-buffer
1316 (insert (nth 1 form))
b8104a2b 1317 (goto-char (point-min))
6b61353c
KH
1318 (let ((n 0))
1319 (while (re-search-forward "%." nil t)
1320 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1321 (setq n (1+ n))))
1322 n)))
1323 (nargs (- (length form) 2)))
1324 (unless (= nargs nfields)
1325 (byte-compile-warn
1326 "`%s' called with %d args to fill %d format field(s)" (car form)
1327 nargs nfields)))))
1328
1329(dolist (elt '(format message error))
1330 (put elt 'byte-compile-format-like t))
1331
11efeb9b
RS
1332;; Warn if a custom definition fails to specify :group.
1333(defun byte-compile-nogroup-warn (form)
1334 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
3ab6a7ae 1335 (name (cadr form)))
019472f4 1336 (or (not (eq (car-safe name) 'quote))
3ab6a7ae
SM
1337 (and (eq (car form) 'custom-declare-group)
1338 (equal name ''emacs))
1339 (plist-get keyword-args :group)
1340 (not (and (consp name) (eq (car name) 'quote)))
1341 (byte-compile-warn
1342 "%s for `%s' fails to specify containing group"
1343 (cdr (assq (car form)
1344 '((custom-declare-group . defgroup)
1345 (custom-declare-face . defface)
1346 (custom-declare-variable . defcustom))))
1347 (cadr name)))))
11efeb9b 1348
52799cb8
RS
1349;; Warn if the function or macro is being redefined with a different
1350;; number of arguments.
1c393159 1351(defun byte-compile-arglist-warn (form macrop)
1c393159 1352 (let ((old (byte-compile-fdefinition (nth 1 form) macrop)))
a7a7ddf1 1353 (if (and old (not (eq old t)))
1c393159
JB
1354 (let ((sig1 (byte-compile-arglist-signature
1355 (if (eq 'lambda (car-safe old))
1356 (nth 1 old)
d82e848c 1357 (if (byte-code-function-p old)
5286a842
RS
1358 (aref old 0)
1359 '(&rest def)))))
1c393159 1360 (sig2 (byte-compile-arglist-signature (nth 2 form))))
ccb3c8de
CW
1361 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
1362 (byte-compile-set-symbol-position (nth 1 form))
1363 (byte-compile-warn
1364 "%s %s used to take %s %s, now takes %s"
1365 (if (eq (car form) 'defun) "function" "macro")
1366 (nth 1 form)
1367 (byte-compile-arglist-signature-string sig1)
1368 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1369 (byte-compile-arglist-signature-string sig2))))
1c393159
JB
1370 ;; This is the first definition. See if previous calls are compatible.
1371 (let ((calls (assq (nth 1 form) byte-compile-unresolved-functions))
1372 nums sig min max)
1373 (if calls
1374 (progn
1375 (setq sig (byte-compile-arglist-signature (nth 2 form))
1376 nums (sort (copy-sequence (cdr calls)) (function <))
1377 min (car nums)
1378 max (car (nreverse nums)))
ccb3c8de 1379 (when (or (< min (car sig))
1c393159 1380 (and (cdr sig) (> max (cdr sig))))
ccb3c8de
CW
1381 (byte-compile-set-symbol-position (nth 1 form))
1382 (byte-compile-warn
1383 "%s being defined to take %s%s, but was previously called with %s"
1384 (nth 1 form)
1385 (byte-compile-arglist-signature-string sig)
1386 (if (equal sig '(1 . 1)) " arg" " args")
1387 (byte-compile-arglist-signature-string (cons min max))))
1f006824 1388
1c393159
JB
1389 (setq byte-compile-unresolved-functions
1390 (delq calls byte-compile-unresolved-functions)))))
1391 )))
1392
95c997fa
RS
1393(defvar byte-compile-cl-functions nil
1394 "List of functions defined in CL.")
1395
1396(defun byte-compile-find-cl-functions ()
1397 (unless byte-compile-cl-functions
1398 (dolist (elt load-history)
c43008c4 1399 (when (and (stringp (car elt))
7940bf7d
MR
1400 (string-match
1401 "^cl\\>" (file-name-nondirectory (car elt))))
95c997fa
RS
1402 (setq byte-compile-cl-functions
1403 (append byte-compile-cl-functions
1404 (cdr elt)))))
1405 (let ((tail byte-compile-cl-functions))
1406 (while tail
1407 (if (and (consp (car tail))
1408 (eq (car (car tail)) 'autoload))
1409 (setcar tail (cdr (car tail))))
1410 (setq tail (cdr tail))))))
1411
4795d1c7
RS
1412(defun byte-compile-cl-warn (form)
1413 "Warn if FORM is a call of a function from the CL package."
95c997fa
RS
1414 (let ((func (car-safe form)))
1415 (if (and byte-compile-cl-functions
1416 (memq func byte-compile-cl-functions)
6b61353c 1417 ;; Aliases which won't have been expanded at this point.
4795d1c7
RS
1418 ;; These aren't all aliases of subrs, so not trivial to
1419 ;; avoid hardwiring the list.
1420 (not (memq func
9cb9a7bc
RS
1421 '(cl-block-wrapper cl-block-throw
1422 multiple-value-call nth-value
95c997fa 1423 copy-seq first second rest endp cl-member
d1a57439
RS
1424 ;; These are included in generated code
1425 ;; that can't be called except at compile time
1426 ;; or unless cl is loaded anyway.
1427 cl-defsubst-expand cl-struct-setf-expander
8f876842
RS
1428 ;; These would sometimes be warned about
1429 ;; but such warnings are never useful,
1430 ;; so don't warn about them.
118861df
DL
1431 macroexpand cl-macroexpand-all
1432 cl-compiling-file)))
1433 ;; Avoid warnings for things which are safe because they
1434 ;; have suitable compiler macros, but those aren't
1435 ;; expanded at this stage. There should probably be more
1436 ;; here than caaar and friends.
1437 (not (and (eq (get func 'byte-compile)
1438 'cl-byte-compile-compiler-macro)
6640c250 1439 (string-match "\\`c[ad]+r\\'" (symbol-name func)))))
4795d1c7
RS
1440 (byte-compile-warn "Function `%s' from cl package called at runtime"
1441 func)))
1442 form)
1443
a586093f 1444(defun byte-compile-print-syms (str1 strn syms)
ccb3c8de
CW
1445 (when syms
1446 (byte-compile-set-symbol-position (car syms) t))
b8175fe6
GM
1447 (cond ((and (cdr syms) (not noninteractive))
1448 (let* ((str strn)
1449 (L (length str))
1450 s)
1451 (while syms
1452 (setq s (symbol-name (pop syms))
1453 L (+ L (length s) 2))
1454 (if (< L (1- fill-column))
1455 (setq str (concat str " " s (and syms ",")))
1456 (setq str (concat str "\n " s (and syms ","))
1457 L (+ (length s) 4))))
1458 (byte-compile-warn "%s" str)))
1459 ((cdr syms)
1f006824 1460 (byte-compile-warn "%s %s"
b8175fe6
GM
1461 strn
1462 (mapconcat #'symbol-name syms ", ")))
1463
1464 (syms
1465 (byte-compile-warn str1 (car syms)))))
a586093f 1466
1f006824 1467;; If we have compiled any calls to functions which are not known to be
52799cb8
RS
1468;; defined, issue a warning enumerating them.
1469;; `unresolved' in the list `byte-compile-warnings' disables this.
1c393159 1470(defun byte-compile-warn-about-unresolved-functions ()
cf637a34 1471 (when (byte-compile-warning-enabled-p 'unresolved)
b8175fe6 1472 (let ((byte-compile-current-form :end)
a586093f
SM
1473 (noruntime nil)
1474 (unresolved nil))
1475 ;; Separate the functions that will not be available at runtime
1476 ;; from the truly unresolved ones.
1477 (dolist (f byte-compile-unresolved-functions)
1478 (setq f (car f))
1479 (if (fboundp f) (push f noruntime) (push f unresolved)))
1480 ;; Complain about the no-run-time functions
1481 (byte-compile-print-syms
b8175fe6
GM
1482 "the function `%s' might not be defined at runtime."
1483 "the following functions might not be defined at runtime:"
a586093f
SM
1484 noruntime)
1485 ;; Complain about the unresolved functions
1486 (byte-compile-print-syms
b8175fe6
GM
1487 "the function `%s' is not known to be defined."
1488 "the following functions are not known to be defined:"
a586093f 1489 unresolved)))
1c393159
JB
1490 nil)
1491
1492\f
582a857c 1493(defsubst byte-compile-const-symbol-p (symbol &optional any-value)
6c2161c4 1494 "Non-nil if SYMBOL is constant.
582a857c 1495If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
6c2161c4 1496symbol itself."
1639b803 1497 (or (memq symbol '(nil t))
6c2161c4 1498 (keywordp symbol)
582a857c 1499 (if any-value (memq symbol byte-compile-const-variables))))
1639b803 1500
1c393159 1501(defmacro byte-compile-constp (form)
c5091f25 1502 "Return non-nil if FORM is a constant."
1639b803
DL
1503 `(cond ((consp ,form) (eq (car ,form) 'quote))
1504 ((not (symbolp ,form)))
1505 ((byte-compile-const-symbol-p ,form))))
1c393159
JB
1506
1507(defmacro byte-compile-close-variables (&rest body)
1508 (cons 'let
1509 (cons '(;;
1510 ;; Close over these variables to encapsulate the
1511 ;; compilation state
1512 ;;
1513 (byte-compile-macro-environment
1514 ;; Copy it because the compiler may patch into the
1515 ;; macroenvironment.
1516 (copy-alist byte-compile-initial-macro-environment))
1517 (byte-compile-function-environment nil)
1518 (byte-compile-bound-variables nil)
6c2161c4 1519 (byte-compile-const-variables nil)
1c393159
JB
1520 (byte-compile-free-references nil)
1521 (byte-compile-free-assignments nil)
1522 ;;
1523 ;; Close over these variables so that `byte-compiler-options'
1524 ;; can change them on a per-file basis.
1525 ;;
1526 (byte-compile-verbose byte-compile-verbose)
1527 (byte-optimize byte-optimize)
d82e848c
RS
1528 (byte-compile-compatibility byte-compile-compatibility)
1529 (byte-compile-dynamic byte-compile-dynamic)
1530 (byte-compile-dynamic-docstrings
1531 byte-compile-dynamic-docstrings)
52799cb8
RS
1532;; (byte-compile-generate-emacs19-bytecodes
1533;; byte-compile-generate-emacs19-bytecodes)
cf637a34 1534 (byte-compile-warnings byte-compile-warnings)
1c393159
JB
1535 )
1536 body)))
1537
1c393159 1538(defmacro displaying-byte-compile-warnings (&rest body)
4390021b
RS
1539 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1540 (warning-series-started
1541 (and (markerp warning-series)
1542 (eq (marker-buffer warning-series)
1543 (get-buffer "*Compile-Log*")))))
95c997fa 1544 (byte-compile-find-cl-functions)
4390021b
RS
1545 (if (or (eq warning-series 'byte-compile-warning-series)
1546 warning-series-started)
1547 ;; warning-series does come from compilation,
1548 ;; so don't bind it, but maybe do set it.
1549 (let (tem)
1550 ;; Log the file name. Record position of that text.
1551 (setq tem (byte-compile-log-file))
1552 (unless warning-series-started
1553 (setq warning-series (or tem 'byte-compile-warning-series)))
1554 (if byte-compile-debug
1555 (funcall --displaying-byte-compile-warnings-fn)
1556 (condition-case error-info
1557 (funcall --displaying-byte-compile-warnings-fn)
1558 (error (byte-compile-report-error error-info)))))
1559 ;; warning-series does not come from compilation, so bind it.
1560 (let ((warning-series
1561 ;; Log the file name. Record position of that text.
1562 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1563 (if byte-compile-debug
22788fb8 1564 (funcall --displaying-byte-compile-warnings-fn)
4390021b
RS
1565 (condition-case error-info
1566 (funcall --displaying-byte-compile-warnings-fn)
1567 (error (byte-compile-report-error error-info))))))))
1c393159 1568\f
fd5285f3 1569;;;###autoload
9742dbc0
RS
1570(defun byte-force-recompile (directory)
1571 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1572Files in subdirectories of DIRECTORY are processed also."
c0f43df5 1573 (interactive "DByte force recompile (directory): ")
9742dbc0
RS
1574 (byte-recompile-directory directory nil t))
1575
1576;;;###autoload
1577(defun byte-recompile-directory (directory &optional arg force)
1c393159
JB
1578 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1579This is if a `.elc' file exists but is older than the `.el' file.
691e7e76 1580Files in subdirectories of DIRECTORY are processed also.
1c393159 1581
c4f2cabd
RS
1582If the `.elc' file does not exist, normally this function *does not*
1583compile the corresponding `.el' file. However,
1584if ARG (the prefix argument) is 0, that means do compile all those files.
1585A nonzero ARG means ask the user, for each such `.el' file,
1586whether to compile it.
691e7e76 1587
c4f2cabd 1588A nonzero ARG also means ask about each subdirectory before scanning it.
9742dbc0
RS
1589
1590If the third argument FORCE is non-nil,
1591recompile every `.el' file that already has a `.elc' file."
1c393159 1592 (interactive "DByte recompile directory: \nP")
0dea0bbe
RM
1593 (if arg
1594 (setq arg (prefix-numeric-value arg)))
e27c3564
JB
1595 (if noninteractive
1596 nil
1597 (save-some-buffers)
ba901388 1598 (force-mode-line-update))
008e2c2a 1599 (with-current-buffer (get-buffer-create "*Compile-Log*")
6c2161c4 1600 (setq default-directory (expand-file-name directory))
977f31f8
RS
1601 ;; compilation-mode copies value of default-directory.
1602 (unless (eq major-mode 'compilation-mode)
1603 (compilation-mode))
ea1cb2bd 1604 (let ((directories (list default-directory))
4eb4926c
RS
1605 (default-directory default-directory)
1606 (skip-count 0)
1607 (fail-count 0)
1608 (file-count 0)
1609 (dir-count 0)
1610 last-dir)
1611 (displaying-byte-compile-warnings
1612 (while directories
1613 (setq directory (car directories))
1614 (message "Checking %s..." directory)
1615 (let ((files (directory-files directory))
1616 source dest)
1617 (dolist (file files)
1618 (setq source (expand-file-name file directory))
6b61353c
KH
1619 (if (and (not (member file '("RCS" "CVS")))
1620 (not (eq ?\. (aref file 0)))
4eb4926c
RS
1621 (file-directory-p source)
1622 (not (file-symlink-p source)))
1623 ;; This file is a subdirectory. Handle them differently.
1624 (when (or (null arg)
1625 (eq 0 arg)
1626 (y-or-n-p (concat "Check " source "? ")))
1627 (setq directories
1628 (nconc directories (list source))))
1629 ;; It is an ordinary file. Decide whether to compile it.
1630 (if (and (string-match emacs-lisp-file-regexp source)
1631 (file-readable-p source)
1632 (not (auto-save-file-name-p source))
1633 (setq dest (byte-compile-dest-file source))
1634 (if (file-exists-p dest)
1635 ;; File was already compiled.
1636 (or force (file-newer-than-file-p source dest))
1637 ;; No compiled file exists yet.
1638 (and arg
1639 (or (eq 0 arg)
1640 (y-or-n-p (concat "Compile " source "? "))))))
1641 (progn (if (and noninteractive (not byte-compile-verbose))
1642 (message "Compiling %s..." source))
1643 (let ((res (byte-compile-file source)))
1644 (cond ((eq res 'no-byte-compile)
1645 (setq skip-count (1+ skip-count)))
1646 ((eq res t)
1647 (setq file-count (1+ file-count)))
1648 ((eq res nil)
1649 (setq fail-count (1+ fail-count)))))
1650 (or noninteractive
1651 (message "Checking %s..." directory))
1652 (if (not (eq last-dir directory))
1653 (setq last-dir directory
1654 dir-count (1+ dir-count)))
1655 )))))
1656 (setq directories (cdr directories))))
1657 (message "Done (Total of %d file%s compiled%s%s%s)"
1658 file-count (if (= file-count 1) "" "s")
1659 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1660 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1661 (if (> dir-count 1) (format " in %d directories" dir-count) "")))))
1c393159 1662
fef3407e
SM
1663(defvar no-byte-compile nil
1664 "Non-nil to prevent byte-compiling of emacs-lisp code.
1665This is normally set in local file variables at the end of the elisp file:
1666
1667;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
631c8020 1668;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
fef3407e 1669
fd5285f3 1670;;;###autoload
1c393159
JB
1671(defun byte-compile-file (filename &optional load)
1672 "Compile a file of Lisp code named FILENAME into a file of byte code.
f9b4b5d8
JB
1673The output file's name is generated by passing FILENAME to the
1674`byte-compile-dest-file' function (which see).
3614fc84 1675With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
d90a41e8 1676The value is non-nil if there were no errors, nil if errors."
1c393159
JB
1677;; (interactive "fByte compile file: \nP")
1678 (interactive
1679 (let ((file buffer-file-name)
1680 (file-name nil)
1681 (file-dir nil))
1682 (and file
1683 (eq (cdr (assq 'major-mode (buffer-local-variables)))
1684 'emacs-lisp-mode)
1685 (setq file-name (file-name-nondirectory file)
1686 file-dir (file-name-directory file)))
52799cb8
RS
1687 (list (read-file-name (if current-prefix-arg
1688 "Byte compile and load file: "
1689 "Byte compile file: ")
79c6071d 1690 file-dir file-name nil)
fd5285f3 1691 current-prefix-arg)))
1c393159
JB
1692 ;; Expand now so we get the current buffer's defaults
1693 (setq filename (expand-file-name filename))
1694
1695 ;; If we're compiling a file that's in a buffer and is modified, offer
1696 ;; to save it first.
1697 (or noninteractive
1698 (let ((b (get-file-buffer (expand-file-name filename))))
1699 (if (and b (buffer-modified-p b)
a586093f 1700 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
008e2c2a 1701 (with-current-buffer b (save-buffer)))))
1c393159 1702
4390021b
RS
1703 ;; Force logging of the file name for each file compiled.
1704 (setq byte-compile-last-logged-file nil)
3ea1f391 1705 (let ((byte-compile-current-file filename)
dc14ae36 1706 (set-auto-coding-for-load t)
d82e848c
RS
1707 target-file input-buffer output-buffer
1708 byte-compile-dest-file)
1709 (setq target-file (byte-compile-dest-file filename))
1710 (setq byte-compile-dest-file target-file)
ea1cb2bd 1711 (with-current-buffer
008e2c2a 1712 (setq input-buffer (get-buffer-create " *Compiler Input*"))
1c393159 1713 (erase-buffer)
7a28e3b1 1714 (setq buffer-file-coding-system nil)
746dd298 1715 ;; Always compile an Emacs Lisp file as multibyte
b92dd692 1716 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
746dd298 1717 (set-buffer-multibyte t)
1c393159 1718 (insert-file-contents filename)
844da0ff
KH
1719 ;; Mimic the way after-insert-file-set-coding can make the
1720 ;; buffer unibyte when visiting this file.
7a28e3b1
RS
1721 (when (or (eq last-coding-system-used 'no-conversion)
1722 (eq (coding-system-type last-coding-system-used) 5))
1723 ;; For coding systems no-conversion and raw-text...,
1724 ;; edit the buffer as unibyte.
1725 (set-buffer-multibyte nil))
1c393159
JB
1726 ;; Run hooks including the uncompression hook.
1727 ;; If they change the file name, then change it for the output also.
d82e848c 1728 (let ((buffer-file-name filename)
a096f13f 1729 (default-major-mode 'emacs-lisp-mode)
aa9addfa
RS
1730 ;; Ignore unsafe local variables.
1731 ;; We only care about a few of them for our purposes.
1732 (enable-local-variables :safe)
d82e848c 1733 (enable-local-eval nil))
aa9addfa
RS
1734 ;; Arg of t means don't alter enable-local-variables.
1735 (normal-mode t)
cd891e68
RS
1736 (setq filename buffer-file-name))
1737 ;; Set the default directory, in case an eval-when-compile uses it.
1738 (setq default-directory (file-name-directory filename)))
3614fc84
GM
1739 ;; Check if the file's local variables explicitly specify not to
1740 ;; compile this file.
fef3407e 1741 (if (with-current-buffer input-buffer no-byte-compile)
3614fc84 1742 (progn
6b61353c
KH
1743 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1744 ;; (file-relative-name filename)
1745 ;; (with-current-buffer input-buffer no-byte-compile))
1746 (when (file-exists-p target-file)
1747 (message "%s deleted because of `no-byte-compile: %s'"
1748 (file-relative-name target-file)
1749 (buffer-local-value 'no-byte-compile input-buffer))
1750 (condition-case nil (delete-file target-file) (error nil)))
82345a9a 1751 ;; We successfully didn't compile this file.
d90a41e8 1752 'no-byte-compile)
ccb3c8de
CW
1753 (when byte-compile-verbose
1754 (message "Compiling %s..." filename))
82345a9a
SM
1755 (setq byte-compiler-error-flag nil)
1756 ;; It is important that input-buffer not be current at this call,
1757 ;; so that the value of point set in input-buffer
1758 ;; within byte-compile-from-buffer lingers in that buffer.
4f6d5bf0
SM
1759 (setq output-buffer
1760 (save-current-buffer
1761 (byte-compile-from-buffer input-buffer filename)))
82345a9a
SM
1762 (if byte-compiler-error-flag
1763 nil
ccb3c8de
CW
1764 (when byte-compile-verbose
1765 (message "Compiling %s...done" filename))
82345a9a
SM
1766 (kill-buffer input-buffer)
1767 (with-current-buffer output-buffer
1768 (goto-char (point-max))
1769 (insert "\n") ; aaah, unix.
1770 (let ((vms-stmlf-recfm t))
1771 (if (file-writable-p target-file)
1772 ;; We must disable any code conversion here.
1773 (let ((coding-system-for-write 'no-conversion))
1774 (if (memq system-type '(ms-dos 'windows-nt))
1775 (setq buffer-file-type t))
1776 (when (file-exists-p target-file)
1777 ;; Remove the target before writing it, so that any
1778 ;; hard-links continue to point to the old file (this makes
1779 ;; it possible for installed files to share disk space with
1780 ;; the build tree, without causing problems when emacs-lisp
1781 ;; files in the build tree are recompiled).
1782 (delete-file target-file))
ba76e7fa 1783 (write-region (point-min) (point-max) target-file))
82345a9a
SM
1784 ;; This is just to give a better error message than write-region
1785 (signal 'file-error
1786 (list "Opening output file"
1787 (if (file-exists-p target-file)
1788 "cannot overwrite file"
1789 "directory not writable or nonexistent")
1790 target-file))))
1791 (kill-buffer (current-buffer)))
1792 (if (and byte-compile-generate-call-tree
1793 (or (eq t byte-compile-generate-call-tree)
1794 (y-or-n-p (format "Report call tree for %s? " filename))))
1795 (save-excursion
1796 (display-call-tree filename)))
1797 (if load
1798 (load target-file))
1799 t))))
1c393159 1800
52799cb8
RS
1801;;(defun byte-compile-and-load-file (&optional filename)
1802;; "Compile a file of Lisp code named FILENAME into a file of byte code,
c5091f25 1803;;and then load it. The output file's name is made by appending \"c\" to
52799cb8
RS
1804;;the end of FILENAME."
1805;; (interactive)
1806;; (if filename ; I don't get it, (interactive-p) doesn't always work
1807;; (byte-compile-file filename t)
1808;; (let ((current-prefix-arg '(4)))
1809;; (call-interactively 'byte-compile-file))))
1810
1811;;(defun byte-compile-buffer (&optional buffer)
1812;; "Byte-compile and evaluate contents of BUFFER (default: the current buffer)."
1813;; (interactive "bByte compile buffer: ")
1814;; (setq buffer (if buffer (get-buffer buffer) (current-buffer)))
1815;; (message "Compiling %s..." (buffer-name buffer))
1816;; (let* ((filename (or (buffer-file-name buffer)
1817;; (concat "#<buffer " (buffer-name buffer) ">")))
1818;; (byte-compile-current-file buffer))
8a5dd086 1819;; (byte-compile-from-buffer buffer nil))
52799cb8
RS
1820;; (message "Compiling %s...done" (buffer-name buffer))
1821;; t)
1c393159
JB
1822
1823;;; compiling a single function
fd5285f3 1824;;;###autoload
52799cb8 1825(defun compile-defun (&optional arg)
1c393159 1826 "Compile and evaluate the current top-level form.
6b61353c 1827Print the result in the echo area.
1c393159
JB
1828With argument, insert value in current buffer after the form."
1829 (interactive "P")
1830 (save-excursion
1831 (end-of-defun)
1832 (beginning-of-defun)
1833 (let* ((byte-compile-current-file nil)
ccb3c8de
CW
1834 (byte-compile-current-buffer (current-buffer))
1835 (byte-compile-read-position (point))
1836 (byte-compile-last-position byte-compile-read-position)
1c393159 1837 (byte-compile-last-warned-form 'nothing)
ccb3c8de 1838 (value (eval
9cb9a7bc 1839 (let ((read-with-symbol-positions (current-buffer))
ccb3c8de
CW
1840 (read-symbol-positions-list nil))
1841 (displaying-byte-compile-warnings
1842 (byte-compile-sexp (read (current-buffer))))))))
1c393159
JB
1843 (cond (arg
1844 (message "Compiling from buffer... done.")
1845 (prin1 value (current-buffer))
1846 (insert "\n"))
1847 ((message "%s" (prin1-to-string value)))))))
1848
1849
8a5dd086
RS
1850(defun byte-compile-from-buffer (inbuffer &optional filename)
1851 ;; Filename is used for the loading-into-Emacs-18 error message.
d82e848c 1852 (let (outbuffer
ccb3c8de
CW
1853 (byte-compile-current-buffer inbuffer)
1854 (byte-compile-read-position nil)
1855 (byte-compile-last-position nil)
d82e848c
RS
1856 ;; Prevent truncation of flonums and lists as we read and print them
1857 (float-output-format nil)
1858 (case-fold-search nil)
1859 (print-length nil)
95e7d933 1860 (print-level nil)
74dfd056
RS
1861 ;; Prevent edebug from interfering when we compile
1862 ;; and put the output into a file.
ccb3c8de
CW
1863;; (edebug-all-defs nil)
1864;; (edebug-all-forms nil)
d82e848c
RS
1865 ;; Simulate entry to byte-compile-top-level
1866 (byte-compile-constants nil)
1867 (byte-compile-variables nil)
1868 (byte-compile-tag-number 0)
1869 (byte-compile-depth 0)
1870 (byte-compile-maxdepth 0)
1871 (byte-compile-output nil)
ccb3c8de 1872 ;; This allows us to get the positions of symbols read; it's
bf247b6e 1873 ;; new in Emacs 22.1.
ccb3c8de
CW
1874 (read-with-symbol-positions inbuffer)
1875 (read-symbol-positions-list nil)
d82e848c 1876 ;; #### This is bound in b-c-close-variables.
cf637a34 1877 ;; (byte-compile-warnings byte-compile-warnings)
d82e848c
RS
1878 )
1879 (byte-compile-close-variables
b8104a2b
SM
1880 (with-current-buffer
1881 (setq outbuffer (get-buffer-create " *Compiler Output*"))
08b59cd3 1882 (set-buffer-multibyte t)
d82e848c
RS
1883 (erase-buffer)
1884 ;; (emacs-lisp-mode)
1885 (setq case-fold-search nil)
d82e848c
RS
1886 ;; This is a kludge. Some operating systems (OS/2, DOS) need to
1887 ;; write files containing binary information specially.
1888 ;; Under most circumstances, such files will be in binary
1889 ;; overwrite mode, so those OS's use that flag to guess how
1890 ;; they should write their data. Advise them that .elc files
1891 ;; need to be written carefully.
1892 (setq overwrite-mode 'overwrite-mode-binary))
1893 (displaying-byte-compile-warnings
fb639443 1894 (and filename (byte-compile-insert-header filename inbuffer outbuffer))
b8104a2b
SM
1895 (with-current-buffer inbuffer
1896 (goto-char (point-min))
2cb63a7c
AM
1897 ;; Should we always do this? When calling multiple files, it
1898 ;; would be useful to delay this warning until all have been
1899 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1900 ;; previous byte-compile.
1901 (setq byte-compile-unresolved-functions nil)
d82e848c
RS
1902
1903 ;; Compile the forms from the input buffer.
1904 (while (progn
1905 (while (progn (skip-chars-forward " \t\n\^l")
1906 (looking-at ";"))
1907 (forward-line 1))
1908 (not (eobp)))
ccb3c8de
CW
1909 (setq byte-compile-read-position (point)
1910 byte-compile-last-position byte-compile-read-position)
36e65f70
SM
1911 (let* ((old-style-backquotes nil)
1912 (form (read inbuffer)))
1913 ;; Warn about the use of old-style backquotes.
1914 (when old-style-backquotes
1915 (byte-compile-warn "!! The file uses old-style backquotes !!
1916This functionality has been obsolete for more than 10 years already
1917and will be removed soon. See (elisp)Backquote in the manual."))
ccb3c8de 1918 (byte-compile-file-form form)))
d82e848c
RS
1919 ;; Compile pending forms at end of file.
1920 (byte-compile-flush-pending)
977f31f8
RS
1921 ;; Make warnings about unresolved functions
1922 ;; give the end of the file as their position.
1923 (setq byte-compile-last-position (point-max))
2cb63a7c 1924 (byte-compile-warn-about-unresolved-functions))
fb639443
RS
1925 ;; Fix up the header at the front of the output
1926 ;; if the buffer contains multibyte characters.
1927 (and filename (byte-compile-fix-header filename inbuffer outbuffer))))
285cdf4e 1928 outbuffer))
8a5dd086 1929
fb639443 1930(defun byte-compile-fix-header (filename inbuffer outbuffer)
6c2161c4 1931 (with-current-buffer outbuffer
fb639443 1932 ;; See if the buffer has any multibyte characters.
447a052b 1933 (when (< (point-max) (position-bytes (point-max)))
fb639443
RS
1934 (when (byte-compile-version-cond byte-compile-compatibility)
1935 (error "Version-18 compatibility not valid with multibyte characters"))
1936 (goto-char (point-min))
1937 ;; Find the comment that describes the version test.
1938 (search-forward "\n;;; This file")
1939 (beginning-of-line)
1940 (narrow-to-region (point) (point-max))
1941 ;; Find the line of ballast semicolons.
1942 (search-forward ";;;;;;;;;;")
1943 (beginning-of-line)
1944
1945 (narrow-to-region (point-min) (point))
1946 (let ((old-header-end (point))
1947 delta)
1948 (goto-char (point-min))
1949 (delete-region (point) (progn (re-search-forward "^(")
1950 (beginning-of-line)
1951 (point)))
351697be
DL
1952 (insert ";;; This file contains utf-8 non-ASCII characters\n"
1953 ";;; and therefore cannot be loaded into Emacs 21 or earlier.\n")
1954 ;; Replace "19" or "19.29" with "22", twice.
fb639443 1955 (re-search-forward "19\\(\\.[0-9]+\\)")
8589dc17 1956 (replace-match "23")
fb639443 1957 (re-search-forward "19\\(\\.[0-9]+\\)")
8589dc17 1958 (replace-match "23")
fb639443
RS
1959 ;; Now compensate for the change in size,
1960 ;; to make sure all positions in the file remain valid.
1961 (setq delta (- (point-max) old-header-end))
1962 (goto-char (point-max))
1963 (widen)
1964 (delete-char delta)))))
1965
f1f32df9 1966(defun byte-compile-insert-header (filename inbuffer outbuffer)
a5832373
RS
1967 (with-current-buffer inbuffer
1968 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1969 (dynamic byte-compile-dynamic))
1970 (set-buffer outbuffer)
1971 (goto-char (point-min))
1972 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
430d2ee2 1973 ;; that is the file-format version number (18, 19, 20, or 23) as a
a5832373
RS
1974 ;; byte, followed by some nulls. The primary motivation for doing
1975 ;; this is to get some binary characters up in the first line of
1976 ;; the file so that `diff' will simply say "Binary files differ"
1977 ;; instead of actually doing a diff of two .elc files. An extra
1978 ;; benefit is that you can add this to /etc/magic:
1979
1980 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1981 ;; >4 byte x version %d
1982
1983 (insert
1984 ";ELC"
430d2ee2 1985 (if (byte-compile-version-cond byte-compile-compatibility) 18 23)
a5832373
RS
1986 "\000\000\000\n"
1987 )
1988 (insert ";;; Compiled by "
1989 (or (and (boundp 'user-mail-address) user-mail-address)
1990 (concat (user-login-name) "@" (system-name)))
1991 " on "
1992 (current-time-string) "\n;;; from file " filename "\n")
1993 (insert ";;; in Emacs version " emacs-version "\n")
1994 (insert ";;; "
1995 (cond
1996 ((eq byte-optimize 'source) "with source-level optimization only")
1997 ((eq byte-optimize 'byte) "with byte-level optimization only")
1998 (byte-optimize "with all optimizations")
1999 (t "without optimization"))
2000 (if (byte-compile-version-cond byte-compile-compatibility)
2001 "; compiled with Emacs 18 compatibility.\n"
2002 ".\n"))
2003 (if dynamic
2004 (insert ";;; Function definitions are lazy-loaded.\n"))
2005 (if (not (byte-compile-version-cond byte-compile-compatibility))
2006 (let (intro-string minimum-version)
2007 ;; Figure out which Emacs version to require,
2008 ;; and what comment to use to explain why.
2009 ;; Note that this fails to take account of whether
2010 ;; the buffer contains multibyte characters. We may have to
2011 ;; compensate at the end in byte-compile-fix-header.
2012 (if dynamic-docstrings
1596952e 2013 (setq intro-string
fb639443
RS
2014 ";;; This file uses dynamic docstrings, first added in Emacs 19.29.\n"
2015 minimum-version "19.29")
2016 (setq intro-string
2017 ";;; This file uses opcodes which do not exist in Emacs 18.\n"
2018 minimum-version "19"))
1596952e
RS
2019 ;; Now insert the comment and the error check.
2020 (insert
fb639443 2021 "\n"
1596952e
RS
2022 intro-string
2023 ;; Have to check if emacs-version is bound so that this works
2024 ;; in files loaded early in loadup.el.
fb639443 2025 "(if (and (boundp 'emacs-version)\n"
1596952e
RS
2026 ;; If there is a name at the end of emacs-version,
2027 ;; don't try to check the version number.
2028 "\t (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
2029 "\t (or (and (boundp 'epoch::version) epoch::version)\n"
2030 (format "\t (string-lessp emacs-version \"%s\")))\n"
2031 minimum-version)
2032 " (error \"`"
2033 ;; prin1-to-string is used to quote backslashes.
2034 (substring (prin1-to-string (file-name-nondirectory filename))
2035 1 -1)
2036 (format "' was compiled for Emacs %s or later\"))\n\n"
fb639443
RS
2037 minimum-version)
2038 ;; Insert semicolons as ballast, so that byte-compile-fix-header
2039 ;; can delete them so as to keep the buffer positions
2040 ;; constant for the actual compiled code.
351697be 2041 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))
1596952e 2042 ;; Here if we want Emacs 18 compatibility.
fb639443
RS
2043 (when dynamic-docstrings
2044 (error "Version-18 compatibility doesn't support dynamic doc strings"))
2045 (when byte-compile-dynamic
2046 (error "Version-18 compatibility doesn't support dynamic byte code"))
f1f32df9 2047 (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n"
a5832373 2048 "\n")))))
1c393159
JB
2049
2050(defun byte-compile-output-file-form (form)
2051 ;; writes the given form to the output buffer, being careful of docstrings
36b7e523
RS
2052 ;; in defun, defmacro, defvar, defconst, autoload and
2053 ;; custom-declare-variable because make-docfile is so amazingly stupid.
c36881cf
ER
2054 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
2055 ;; it does not pay to first build the defalias in defmumble and then parse
2056 ;; it here.
36b7e523
RS
2057 (if (and (memq (car-safe form) '(defun defmacro defvar defconst autoload
2058 custom-declare-variable))
1c393159 2059 (stringp (nth 3 form)))
d82e848c 2060 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
36b7e523
RS
2061 (memq (car form)
2062 '(autoload custom-declare-variable)))
1c393159 2063 (let ((print-escape-newlines t)
37c29340
KH
2064 (print-length nil)
2065 (print-level nil)
77308fd7 2066 (print-quoted t)
5e51de79 2067 (print-gensym t)
0e66b003
KH
2068 (print-circle ; handle circular data structures
2069 (not byte-compile-disable-print-circle)))
1c393159
JB
2070 (princ "\n" outbuffer)
2071 (prin1 form outbuffer)
2072 nil)))
2073
6c2161c4
SM
2074(defvar print-gensym-alist) ;Used before print-circle existed.
2075
d82e848c 2076(defun byte-compile-output-docform (preface name info form specindex quoted)
dac6f673
RS
2077 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2078If PREFACE and NAME are non-nil, print them too,
2079before INFO and the FORM but after the doc string itself.
2080If SPECINDEX is non-nil, it is the index in FORM
2081of the function bytecode string. In that case,
2082we output that argument and the following argument (the constants vector)
2083together, for lazy loading.
2084QUOTED says that we have to put a quote before the
2085list that represents a doc string reference.
36b7e523 2086`autoload' and `custom-declare-variable' need that."
dac6f673
RS
2087 ;; We need to examine byte-compile-dynamic-docstrings
2088 ;; in the input buffer (now current), not in the output buffer.
2089 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
9ec5dfe6
SM
2090 (with-current-buffer outbuffer
2091 (let (position)
2092
2093 ;; Insert the doc string, and make it a comment with #@LENGTH.
2094 (and (>= (nth 1 info) 0)
2095 dynamic-docstrings
2096 (not byte-compile-compatibility)
2097 (progn
2098 ;; Make the doc string start at beginning of line
2099 ;; for make-docfile's sake.
2100 (insert "\n")
2101 (setq position
2102 (byte-compile-output-as-comment
2103 (nth (nth 1 info) form) nil))
2104 (setq position (- (position-bytes position) (point-min) -1))
2105 ;; If the doc string starts with * (a user variable),
2106 ;; negate POSITION.
2107 (if (and (stringp (nth (nth 1 info) form))
2108 (> (length (nth (nth 1 info) form)) 0)
2109 (eq (aref (nth (nth 1 info) form) 0) ?*))
2110 (setq position (- position)))))
2111
2112 (if preface
2113 (progn
2114 (insert preface)
2115 (prin1 name outbuffer)))
2116 (insert (car info))
2117 (let ((print-escape-newlines t)
2118 (print-quoted t)
2119 ;; For compatibility with code before print-circle,
2120 ;; use a cons cell to say that we want
2121 ;; print-gensym-alist not to be cleared
2122 ;; between calls to print functions.
2123 (print-gensym '(t))
2124 (print-circle ; handle circular data structures
2125 (not byte-compile-disable-print-circle))
2126 print-gensym-alist ; was used before print-circle existed.
2127 (print-continuous-numbering t)
2128 print-number-table
2129 (index 0))
2130 (prin1 (car form) outbuffer)
2131 (while (setq form (cdr form))
2132 (setq index (1+ index))
2133 (insert " ")
2134 (cond ((and (numberp specindex) (= index specindex)
2135 ;; Don't handle the definition dynamically
2136 ;; if it refers (or might refer)
2137 ;; to objects already output
2138 ;; (for instance, gensyms in the arg list).
2139 (let (non-nil)
2140 (dotimes (i (length print-number-table))
2141 (if (aref print-number-table i)
2142 (setq non-nil t)))
2143 (not non-nil)))
2144 ;; Output the byte code and constants specially
2145 ;; for lazy dynamic loading.
2146 (let ((position
2147 (byte-compile-output-as-comment
2148 (cons (car form) (nth 1 form))
2149 t)))
2150 (setq position (- (position-bytes position) (point-min) -1))
2151 (princ (format "(#$ . %d) nil" position) outbuffer)
2152 (setq form (cdr form))
2153 (setq index (1+ index))))
2154 ((= index (nth 1 info))
2155 (if position
2156 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2157 position)
2158 outbuffer)
2159 (let ((print-escape-newlines nil))
2160 (goto-char (prog1 (1+ (point))
2161 (prin1 (car form) outbuffer)))
2162 (insert "\\\n")
2163 (goto-char (point-max)))))
2164 (t
2165 (prin1 (car form) outbuffer)))))
2166 (insert (nth 2 info)))))
1c393159
JB
2167 nil)
2168
2169(defun byte-compile-keep-pending (form &optional handler)
2170 (if (memq byte-optimize '(t source))
2171 (setq form (byte-optimize-form form t)))
2172 (if handler
2173 (let ((for-effect t))
2174 ;; To avoid consing up monstrously large forms at load time, we split
2175 ;; the output regularly.
b4ff4a23
RS
2176 (and (memq (car-safe form) '(fset defalias))
2177 (nthcdr 300 byte-compile-output)
1c393159
JB
2178 (byte-compile-flush-pending))
2179 (funcall handler form)
2180 (if for-effect
2181 (byte-compile-discard)))
2182 (byte-compile-form form t))
2183 nil)
2184
2185(defun byte-compile-flush-pending ()
2186 (if byte-compile-output
2187 (let ((form (byte-compile-out-toplevel t 'file)))
2188 (cond ((eq (car-safe form) 'progn)
ed62683d 2189 (mapc 'byte-compile-output-file-form (cdr form)))
1c393159
JB
2190 (form
2191 (byte-compile-output-file-form form)))
2192 (setq byte-compile-constants nil
2193 byte-compile-variables nil
2194 byte-compile-depth 0
2195 byte-compile-maxdepth 0
2196 byte-compile-output nil))))
2197
2198(defun byte-compile-file-form (form)
2199 (let ((byte-compile-current-form nil) ; close over this for warnings.
2200 handler)
2201 (cond
2202 ((not (consp form))
2203 (byte-compile-keep-pending form))
2204 ((and (symbolp (car form))
2205 (setq handler (get (car form) 'byte-hunk-handler)))
2206 (cond ((setq form (funcall handler form))
2207 (byte-compile-flush-pending)
2208 (byte-compile-output-file-form form))))
2209 ((eq form (setq form (macroexpand form byte-compile-macro-environment)))
2210 (byte-compile-keep-pending form))
2211 (t
2212 (byte-compile-file-form form)))))
2213
2214;; Functions and variables with doc strings must be output separately,
2215;; so make-docfile can recognise them. Most other things can be output
2216;; as byte-code.
2217
2218(put 'defsubst 'byte-hunk-handler 'byte-compile-file-form-defsubst)
2219(defun byte-compile-file-form-defsubst (form)
6c2161c4
SM
2220 (when (assq (nth 1 form) byte-compile-unresolved-functions)
2221 (setq byte-compile-current-form (nth 1 form))
1d5c17c0 2222 (byte-compile-warn "defsubst `%s' was used before it was defined"
6c2161c4 2223 (nth 1 form)))
1c393159
JB
2224 (byte-compile-file-form
2225 (macroexpand form byte-compile-macro-environment))
2226 ;; Return nil so the form is not output twice.
2227 nil)
2228
2229(put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2230(defun byte-compile-file-form-autoload (form)
2231 (and (let ((form form))
2232 (while (if (setq form (cdr form)) (byte-compile-constp (car form))))
2233 (null form)) ;Constants only
2234 (eval (nth 5 form)) ;Macro
2235 (eval form)) ;Define the autoload.
c5091f25 2236 ;; Avoid undefined function warnings for the autoload.
c3b2784b 2237 (if (and (consp (nth 1 form))
c5091f25
DL
2238 (eq (car (nth 1 form)) 'quote)
2239 (consp (cdr (nth 1 form)))
2240 (symbolp (nth 1 (nth 1 form))))
977b50fb
SM
2241 (push (cons (nth 1 (nth 1 form))
2242 (cons 'autoload (cdr (cdr form))))
2243 byte-compile-function-environment))
1c393159
JB
2244 (if (stringp (nth 3 form))
2245 form
2246 ;; No doc string, so we can compile this as a normal form.
2247 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2248
2249(put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2250(put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2251(defun byte-compile-file-form-defvar (form)
2252 (if (null (nth 3 form))
2253 ;; Since there is no doc string, we can compile this as a normal form,
2254 ;; and not do a file-boundary.
2255 (byte-compile-keep-pending form)
cf637a34 2256 (when (byte-compile-warning-enabled-p 'free-vars)
8898f44e 2257 (push (nth 1 form) byte-compile-bound-variables)
6c2161c4
SM
2258 (if (eq (car form) 'defconst)
2259 (push (nth 1 form) byte-compile-const-variables)))
1c393159
JB
2260 (cond ((consp (nth 2 form))
2261 (setq form (copy-sequence form))
2262 (setcar (cdr (cdr form))
2263 (byte-compile-top-level (nth 2 form) nil 'file))))
2264 form))
2265
b7c76a30
SM
2266(put 'define-abbrev-table 'byte-hunk-handler 'byte-compile-file-form-define-abbrev-table)
2267(defun byte-compile-file-form-define-abbrev-table (form)
2268 (when (and (byte-compile-warning-enabled-p 'free-vars)
2269 (eq 'quote (car-safe (car-safe (cdr form)))))
2270 (push (car-safe (cdr (cadr form))) byte-compile-bound-variables))
2271 (byte-compile-keep-pending form))
2272
8c731d3d
RS
2273(put 'custom-declare-variable 'byte-hunk-handler
2274 'byte-compile-file-form-custom-declare-variable)
2275(defun byte-compile-file-form-custom-declare-variable (form)
cf637a34 2276 (when (byte-compile-warning-enabled-p 'callargs)
fe33e7c8 2277 (byte-compile-nogroup-warn form))
cf637a34 2278 (when (byte-compile-warning-enabled-p 'free-vars)
6c2161c4 2279 (push (nth 1 (nth 1 form)) byte-compile-bound-variables))
2546bcdd
SM
2280 ;; Don't compile the expression because it may be displayed to the user.
2281 ;; (when (eq (car-safe (nth 2 form)) 'quote)
2282 ;; ;; (nth 2 form) is meant to evaluate to an expression, so if we have the
2283 ;; ;; final value already, we can byte-compile it.
2284 ;; (setcar (cdr (nth 2 form))
2285 ;; (byte-compile-top-level (cadr (nth 2 form)) nil 'file)))
347a36bc
RS
2286 (let ((tail (nthcdr 4 form)))
2287 (while tail
2546bcdd
SM
2288 (unless (keywordp (car tail)) ;No point optimizing keywords.
2289 ;; Compile the keyword arguments.
2290 (setcar tail (byte-compile-top-level (car tail) nil 'file)))
347a36bc 2291 (setq tail (cdr tail))))
8c731d3d
RS
2292 form)
2293
997011eb
RS
2294(put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2295(defun byte-compile-file-form-require (form)
b8104a2b 2296 (let ((args (mapcar 'eval (cdr form))))
997011eb 2297 (apply 'require args)
4db98503 2298 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
997011eb 2299 (if (member (car args) '("cl" cl))
cf637a34 2300 (byte-compile-disable-warning 'cl-functions)))
1c393159
JB
2301 (byte-compile-keep-pending form 'byte-compile-normal-call))
2302
2303(put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2304(put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2305(put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2306(defun byte-compile-file-form-progn (form)
ed62683d 2307 (mapc 'byte-compile-file-form (cdr form))
1c393159
JB
2308 ;; Return nil so the forms are not output twice.
2309 nil)
2310
2311;; This handler is not necessary, but it makes the output from dont-compile
2312;; and similar macros cleaner.
2313(put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2314(defun byte-compile-file-form-eval (form)
2315 (if (eq (car-safe (nth 1 form)) 'quote)
2316 (nth 1 (nth 1 form))
2317 (byte-compile-keep-pending form)))
2318
2319(put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun)
2320(defun byte-compile-file-form-defun (form)
2321 (byte-compile-file-form-defmumble form nil))
2322
2323(put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro)
2324(defun byte-compile-file-form-defmacro (form)
2325 (byte-compile-file-form-defmumble form t))
2326
2327(defun byte-compile-file-form-defmumble (form macrop)
2328 (let* ((name (car (cdr form)))
2329 (this-kind (if macrop 'byte-compile-macro-environment
2330 'byte-compile-function-environment))
2331 (that-kind (if macrop 'byte-compile-function-environment
2332 'byte-compile-macro-environment))
2333 (this-one (assq name (symbol-value this-kind)))
2334 (that-one (assq name (symbol-value that-kind)))
2335 (byte-compile-free-references nil)
2336 (byte-compile-free-assignments nil))
ccb3c8de 2337 (byte-compile-set-symbol-position name)
1c393159
JB
2338 ;; When a function or macro is defined, add it to the call tree so that
2339 ;; we can tell when functions are not used.
2340 (if byte-compile-generate-call-tree
2341 (or (assq name byte-compile-call-tree)
2342 (setq byte-compile-call-tree
2343 (cons (list name nil nil) byte-compile-call-tree))))
2344
2345 (setq byte-compile-current-form name) ; for warnings
cf637a34 2346 (if (byte-compile-warning-enabled-p 'redefine)
1c393159
JB
2347 (byte-compile-arglist-warn form macrop))
2348 (if byte-compile-verbose
47cf9d3a 2349 (message "Compiling %s... (%s)" (or filename "") (nth 1 form)))
1c393159 2350 (cond (that-one
cf637a34 2351 (if (and (byte-compile-warning-enabled-p 'redefine)
52799cb8 2352 ;; don't warn when compiling the stubs in byte-run...
1c393159
JB
2353 (not (assq (nth 1 form)
2354 byte-compile-initial-macro-environment)))
2355 (byte-compile-warn
1d5c17c0 2356 "`%s' defined multiple times, as both function and macro"
1c393159
JB
2357 (nth 1 form)))
2358 (setcdr that-one nil))
2359 (this-one
cf637a34 2360 (when (and (byte-compile-warning-enabled-p 'redefine)
1c393159 2361 ;; hack: don't warn when compiling the magic internal
52799cb8 2362 ;; byte-compiler macros in byte-run.el...
1c393159
JB
2363 (not (assq (nth 1 form)
2364 byte-compile-initial-macro-environment)))
1d5c17c0 2365 (byte-compile-warn "%s `%s' defined multiple times in this file"
ccb3c8de
CW
2366 (if macrop "macro" "function")
2367 (nth 1 form))))
1c393159
JB
2368 ((and (fboundp name)
2369 (eq (car-safe (symbol-function name))
2370 (if macrop 'lambda 'macro)))
cf637a34 2371 (when (byte-compile-warning-enabled-p 'redefine)
1d5c17c0 2372 (byte-compile-warn "%s `%s' being redefined as a %s"
ccb3c8de
CW
2373 (if macrop "function" "macro")
2374 (nth 1 form)
2375 (if macrop "macro" "function")))
1c393159
JB
2376 ;; shadow existing definition
2377 (set this-kind
2378 (cons (cons name nil) (symbol-value this-kind))))
2379 )
2380 (let ((body (nthcdr 3 form)))
ccb3c8de
CW
2381 (when (and (stringp (car body))
2382 (symbolp (car-safe (cdr-safe body)))
2383 (car-safe (cdr-safe body))
2384 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2385 (byte-compile-set-symbol-position (nth 1 form))
2386 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2387 (nth 1 form))))
6b8c2efc 2388
985b4686
GM
2389 ;; Generate code for declarations in macro definitions.
2390 ;; Remove declarations from the body of the macro definition.
2391 (when macrop
2392 (let ((tail (nthcdr 2 form)))
2393 (when (stringp (car (cdr tail)))
2394 (setq tail (cdr tail)))
2395 (while (and (consp (car (cdr tail)))
2396 (eq (car (car (cdr tail))) 'declare))
2397 (let ((declaration (car (cdr tail))))
2398 (setcdr tail (cdr (cdr tail)))
8bd91fd0 2399 (prin1 `(if macro-declaration-function
985b4686
GM
2400 (funcall macro-declaration-function
2401 ',name ',declaration))
2402 outbuffer)))))
6b8c2efc 2403
4ec5239c 2404 (let* ((new-one (byte-compile-lambda (nthcdr 2 form) t))
1c393159
JB
2405 (code (byte-compile-byte-code-maker new-one)))
2406 (if this-one
2407 (setcdr this-one new-one)
2408 (set this-kind
2409 (cons (cons name new-one) (symbol-value this-kind))))
2410 (if (and (stringp (nth 3 form))
2411 (eq 'quote (car-safe code))
2412 (eq 'lambda (car-safe (nth 1 code))))
2413 (cons (car form)
2414 (cons name (cdr (nth 1 code))))
d82e848c 2415 (byte-compile-flush-pending)
1c393159 2416 (if (not (stringp (nth 3 form)))
d82e848c
RS
2417 ;; No doc string. Provide -1 as the "doc string index"
2418 ;; so that no element will be treated as a doc string.
2419 (byte-compile-output-docform
2420 (if (byte-compile-version-cond byte-compile-compatibility)
2421 "\n(fset '" "\n(defalias '")
2422 name
2423 (cond ((atom code)
2424 (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]")))
2425 ((eq (car code) 'quote)
2426 (setq code new-one)
2427 (if macrop '(" '(macro " -1 ")") '(" '(" -1 ")")))
2428 ((if macrop '(" (cons 'macro (" -1 "))") '(" (" -1 ")"))))
2429 (append code nil)
2430 (and (atom code) byte-compile-dynamic
2431 1)
2432 nil)
1c393159 2433 ;; Output the form by hand, that's much simpler than having
c36881cf 2434 ;; b-c-output-file-form analyze the defalias.
1c393159 2435 (byte-compile-output-docform
d82e848c
RS
2436 (if (byte-compile-version-cond byte-compile-compatibility)
2437 "\n(fset '" "\n(defalias '")
2438 name
1c393159
JB
2439 (cond ((atom code)
2440 (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2441 ((eq (car code) 'quote)
2442 (setq code new-one)
2443 (if macrop '(" '(macro " 2 ")") '(" '(" 2 ")")))
2444 ((if macrop '(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
d82e848c
RS
2445 (append code nil)
2446 (and (atom code) byte-compile-dynamic
2447 1)
2448 nil))
2449 (princ ")" outbuffer)
2450 nil))))
2451
2452;; Print Lisp object EXP in the output file, inside a comment,
2453;; and return the file position it will have.
2454;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2455(defun byte-compile-output-as-comment (exp quoted)
2d5975fa 2456 (let ((position (point)))
9ec5dfe6
SM
2457 (with-current-buffer outbuffer
2458
2459 ;; Insert EXP, and make it a comment with #@LENGTH.
2460 (insert " ")
2461 (if quoted
2462 (prin1 exp outbuffer)
2463 (princ exp outbuffer))
2464 (goto-char position)
2465 ;; Quote certain special characters as needed.
2466 ;; get_doc_string in doc.c does the unquoting.
2467 (while (search-forward "\^A" nil t)
2468 (replace-match "\^A\^A" t t))
2469 (goto-char position)
2470 (while (search-forward "\000" nil t)
2471 (replace-match "\^A0" t t))
2472 (goto-char position)
2473 (while (search-forward "\037" nil t)
2474 (replace-match "\^A_" t t))
2475 (goto-char (point-max))
2476 (insert "\037")
2477 (goto-char position)
2478 (insert "#@" (format "%d" (- (position-bytes (point-max))
2479 (position-bytes position))))
2480
2481 ;; Save the file position of the object.
2482 ;; Note we should add 1 to skip the space
2483 ;; that we inserted before the actual doc string,
2484 ;; and subtract 1 to convert from an 1-origin Emacs position
2485 ;; to a file position; they cancel.
2486 (setq position (point))
2487 (goto-char (point-max)))
d82e848c
RS
2488 position))
2489
1c393159
JB
2490
2491\f
fd5285f3 2492;;;###autoload
1c393159
JB
2493(defun byte-compile (form)
2494 "If FORM is a symbol, byte-compile its function definition.
2495If FORM is a lambda or a macro, byte-compile it as a function."
2496 (displaying-byte-compile-warnings
2497 (byte-compile-close-variables
2498 (let* ((fun (if (symbolp form)
2499 (and (fboundp form) (symbol-function form))
2500 form))
2501 (macro (eq (car-safe fun) 'macro)))
2502 (if macro
2503 (setq fun (cdr fun)))
2504 (cond ((eq (car-safe fun) 'lambda)
2505 (setq fun (if macro
2506 (cons 'macro (byte-compile-lambda fun))
2507 (byte-compile-lambda fun)))
2508 (if (symbolp form)
c36881cf 2509 (defalias form fun)
1c393159
JB
2510 fun)))))))
2511
2512(defun byte-compile-sexp (sexp)
2513 "Compile and return SEXP."
2514 (displaying-byte-compile-warnings
2515 (byte-compile-close-variables
2516 (byte-compile-top-level sexp))))
2517
2518;; Given a function made by byte-compile-lambda, make a form which produces it.
2519(defun byte-compile-byte-code-maker (fun)
2520 (cond
52799cb8 2521 ((byte-compile-version-cond byte-compile-compatibility)
1c393159
JB
2522 ;; Return (quote (lambda ...)).
2523 (list 'quote (byte-compile-byte-code-unmake fun)))
2524 ;; ## atom is faster than compiled-func-p.
2525 ((atom fun) ; compiled function.
2526 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2527 ;; would have produced a lambda.
469414a0 2528 fun)
1c393159 2529 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
52799cb8 2530 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
1c393159
JB
2531 ((let (tmp)
2532 (if (and (setq tmp (assq 'byte-code (cdr-safe (cdr fun))))
2533 (null (cdr (memq tmp fun))))
2534 ;; Generate a make-byte-code call.
2535 (let* ((interactive (assq 'interactive (cdr (cdr fun)))))
2536 (nconc (list 'make-byte-code
2537 (list 'quote (nth 1 fun)) ;arglist
2538 (nth 1 tmp) ;bytes
2539 (nth 2 tmp) ;consts
2540 (nth 3 tmp)) ;depth
2541 (cond ((stringp (nth 2 fun))
2542 (list (nth 2 fun))) ;doc
2543 (interactive
2544 (list nil)))
2545 (cond (interactive
2546 (list (if (or (null (nth 1 interactive))
2547 (stringp (nth 1 interactive)))
2548 (nth 1 interactive)
2549 ;; Interactive spec is a list or a variable
2550 ;; (if it is correct).
2551 (list 'quote (nth 1 interactive))))))))
2552 ;; a non-compiled function (probably trivial)
2553 (list 'quote fun))))))
2554
2555;; Turn a function into an ordinary lambda. Needed for v18 files.
2556(defun byte-compile-byte-code-unmake (function)
2557 (if (consp function)
2558 function;;It already is a lambda.
2559 (setq function (append function nil)) ; turn it into a list
2560 (nconc (list 'lambda (nth 0 function))
2561 (and (nth 4 function) (list (nth 4 function)))
2562 (if (nthcdr 5 function)
2563 (list (cons 'interactive (if (nth 5 function)
2564 (nthcdr 5 function)))))
2565 (list (list 'byte-code
2566 (nth 1 function) (nth 2 function)
2567 (nth 3 function))))))
2568
2569
eadd6444
GM
2570(defun byte-compile-check-lambda-list (list)
2571 "Check lambda-list LIST for errors."
2572 (let (vars)
2573 (while list
2574 (let ((arg (car list)))
ccb3c8de
CW
2575 (when (symbolp arg)
2576 (byte-compile-set-symbol-position arg))
1f006824 2577 (cond ((or (not (symbolp arg))
6c2161c4 2578 (byte-compile-const-symbol-p arg t))
eadd6444
GM
2579 (error "Invalid lambda variable %s" arg))
2580 ((eq arg '&rest)
2581 (unless (cdr list)
2582 (error "&rest without variable name"))
2583 (when (cddr list)
2584 (error "Garbage following &rest VAR in lambda-list")))
2585 ((eq arg '&optional)
2586 (unless (cdr list)
2587 (error "Variable name missing after &optional")))
2588 ((memq arg vars)
e34fd2f2 2589 (byte-compile-warn "repeated variable %s in lambda-list" arg))
1f006824 2590 (t
eadd6444
GM
2591 (push arg vars))))
2592 (setq list (cdr list)))))
2593
2594
1c393159
JB
2595;; Byte-compile a lambda-expression and return a valid function.
2596;; The value is usually a compiled function but may be the original
2597;; lambda-expression.
4ec5239c
LH
2598;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2599;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2600;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2601;; for symbols generated by the byte compiler itself.
2602(defun byte-compile-lambda (fun &optional add-lambda)
2603 (if add-lambda
2604 (setq fun (cons 'lambda fun))
2605 (unless (eq 'lambda (car-safe fun))
2606 (error "Not a lambda list: %S" fun))
2607 (byte-compile-set-symbol-position 'lambda))
eadd6444 2608 (byte-compile-check-lambda-list (nth 1 fun))
1c393159
JB
2609 (let* ((arglist (nth 1 fun))
2610 (byte-compile-bound-variables
cf637a34 2611 (nconc (and (byte-compile-warning-enabled-p 'free-vars)
1c393159
JB
2612 (delq '&rest (delq '&optional (copy-sequence arglist))))
2613 byte-compile-bound-variables))
2614 (body (cdr (cdr fun)))
2615 (doc (if (stringp (car body))
2616 (prog1 (car body)
d8f59f56
RS
2617 ;; Discard the doc string
2618 ;; unless it is the last element of the body.
b9edcafb 2619 (if (cdr body)
d8f59f56 2620 (setq body (cdr body))))))
1c393159 2621 (int (assq 'interactive body)))
6c2161c4
SM
2622 ;; Process the interactive spec.
2623 (when int
2624 (byte-compile-set-symbol-position 'interactive)
2625 ;; Skip (interactive) if it is in front (the most usual location).
2626 (if (eq int (car body))
2627 (setq body (cdr body)))
2628 (cond ((consp (cdr int))
2629 (if (cdr (cdr int))
2630 (byte-compile-warn "malformed interactive spec: %s"
2631 (prin1-to-string int)))
6b61353c
KH
2632 ;; If the interactive spec is a call to `list', don't
2633 ;; compile it, because `call-interactively' looks at the
2634 ;; args of `list'. Actually, compile it to get warnings,
2635 ;; but don't use the result.
6c2161c4
SM
2636 (let ((form (nth 1 int)))
2637 (while (memq (car-safe form) '(let let* progn save-excursion))
2638 (while (consp (cdr form))
2639 (setq form (cdr form)))
2640 (setq form (car form)))
6b61353c
KH
2641 (if (eq (car-safe form) 'list)
2642 (byte-compile-top-level (nth 1 int))
2643 (setq int (list 'interactive
2644 (byte-compile-top-level (nth 1 int)))))))
6c2161c4
SM
2645 ((cdr int)
2646 (byte-compile-warn "malformed interactive spec: %s"
2647 (prin1-to-string int)))))
2648 ;; Process the body.
1c393159 2649 (let ((compiled (byte-compile-top-level (cons 'progn body) nil 'lambda)))
6c2161c4 2650 ;; Build the actual byte-coded function.
1c393159 2651 (if (and (eq 'byte-code (car-safe compiled))
b890df1a
RS
2652 (not (byte-compile-version-cond
2653 byte-compile-compatibility)))
1c393159
JB
2654 (apply 'make-byte-code
2655 (append (list arglist)
2656 ;; byte-string, constants-vector, stack depth
2657 (cdr compiled)
2658 ;; optionally, the doc string.
2659 (if (or doc int)
2660 (list doc))
2661 ;; optionally, the interactive spec.
2662 (if int
2663 (list (nth 1 int)))))
2664 (setq compiled
2665 (nconc (if int (list int))
2666 (cond ((eq (car-safe compiled) 'progn) (cdr compiled))
2667 (compiled (list compiled)))))
2668 (nconc (list 'lambda arglist)
2669 (if (or doc (stringp (car compiled)))
2670 (cons doc (cond (compiled)
2671 (body (list nil))))
2672 compiled))))))
2673
2674(defun byte-compile-constants-vector ()
2675 ;; Builds the constants-vector from the current variables and constants.
2676 ;; This modifies the constants from (const . nil) to (const . offset).
2677 ;; To keep the byte-codes to look up the vector as short as possible:
2678 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2679 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2680 ;; Next variables again, to get 2-byte codes for variable lookup.
2681 ;; The rest of the constants and variables need 3-byte byte-codes.
2682 (let* ((i -1)
2683 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2684 (other (nreverse byte-compile-constants)) ; vars often are used most.
2685 ret tmp
2686 (limits '(5 ; Use the 1-byte varref codes,
2687 63 ; 1-constlim ; 1-byte byte-constant codes,
2688 255 ; 2-byte varref codes,
2689 65535)) ; 3-byte codes for the rest.
2690 limit)
2691 (while (or rest other)
2692 (setq limit (car limits))
2693 (while (and rest (not (eq i limit)))
2694 (if (setq tmp (assq (car (car rest)) ret))
2695 (setcdr (car rest) (cdr tmp))
2696 (setcdr (car rest) (setq i (1+ i)))
2697 (setq ret (cons (car rest) ret)))
2698 (setq rest (cdr rest)))
2699 (setq limits (cdr limits)
2700 rest (prog1 other
2701 (setq other rest))))
2702 (apply 'vector (nreverse (mapcar 'car ret)))))
2703
2704;; Given an expression FORM, compile it and return an equivalent byte-code
2705;; expression (a call to the function byte-code).
2706(defun byte-compile-top-level (form &optional for-effect output-type)
2707 ;; OUTPUT-TYPE advises about how form is expected to be used:
2708 ;; 'eval or nil -> a single form,
2709 ;; 'progn or t -> a list of forms,
2710 ;; 'lambda -> body of a lambda,
2711 ;; 'file -> used at file-level.
285cdf4e
RS
2712 (let ((byte-compile-constants nil)
2713 (byte-compile-variables nil)
2714 (byte-compile-tag-number 0)
2715 (byte-compile-depth 0)
2716 (byte-compile-maxdepth 0)
2717 (byte-compile-output nil))
d9e42bcf
RS
2718 (if (memq byte-optimize '(t source))
2719 (setq form (byte-optimize-form form for-effect)))
2720 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2721 (setq form (nth 1 form)))
2722 (if (and (eq 'byte-code (car-safe form))
2723 (not (memq byte-optimize '(t byte)))
2724 (stringp (nth 1 form)) (vectorp (nth 2 form))
2725 (natnump (nth 3 form)))
2726 form
2727 (byte-compile-form form for-effect)
285cdf4e 2728 (byte-compile-out-toplevel for-effect output-type))))
1c393159
JB
2729
2730(defun byte-compile-out-toplevel (&optional for-effect output-type)
2731 (if for-effect
2732 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2733 (if (eq (car (car byte-compile-output)) 'byte-discard)
2734 (setq byte-compile-output (cdr byte-compile-output))
2735 (byte-compile-push-constant
2736 ;; Push any constant - preferably one which already is used, and
2737 ;; a number or symbol - ie not some big sequence. The return value
2738 ;; isn't returned, but it would be a shame if some textually large
2739 ;; constant was not optimized away because we chose to return it.
2740 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2741 (let ((tmp (reverse byte-compile-constants)))
ba76e7fa
SM
2742 (while (and tmp (not (or (symbolp (caar tmp))
2743 (numberp (caar tmp)))))
1c393159 2744 (setq tmp (cdr tmp)))
ba76e7fa 2745 (caar tmp))))))
1c393159
JB
2746 (byte-compile-out 'byte-return 0)
2747 (setq byte-compile-output (nreverse byte-compile-output))
2748 (if (memq byte-optimize '(t byte))
2749 (setq byte-compile-output
2750 (byte-optimize-lapcode byte-compile-output for-effect)))
1f006824 2751
1c393159
JB
2752 ;; Decompile trivial functions:
2753 ;; only constants and variables, or a single funcall except in lambdas.
2754 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2755 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2756 ;; Note that even (quote foo) must be parsed just as any subr by the
2757 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2758 ;; What to leave uncompiled:
69dc83fd
KH
2759 ;; lambda -> never. we used to leave it uncompiled if the body was
2760 ;; a single atom, but that causes confusion if the docstring
2761 ;; uses the (file . pos) syntax. Besides, now that we have
2762 ;; the Lisp_Compiled type, the compiled form is faster.
1c393159
JB
2763 ;; eval -> atom, quote or (function atom atom atom)
2764 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2765 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2766 (let (rest
2767 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2768 tmp body)
2769 (cond
2770 ;; #### This should be split out into byte-compile-nontrivial-function-p.
69dc83fd
KH
2771 ((or (eq output-type 'lambda)
2772 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
1c393159
JB
2773 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2774 (not (setq tmp (assq 'byte-return byte-compile-output)))
2775 (progn
2776 (setq rest (nreverse
2777 (cdr (memq tmp (reverse byte-compile-output)))))
2778 (while (cond
2779 ((memq (car (car rest)) '(byte-varref byte-constant))
2780 (setq tmp (car (cdr (car rest))))
469414a0
RS
2781 (if (if (eq (car (car rest)) 'byte-constant)
2782 (or (consp tmp)
2783 (and (symbolp tmp)
1639b803 2784 (not (byte-compile-const-symbol-p tmp)))))
469414a0
RS
2785 (if maycall
2786 (setq body (cons (list 'quote tmp) body)))
2787 (setq body (cons tmp body))))
1c393159
JB
2788 ((and maycall
2789 ;; Allow a funcall if at most one atom follows it.
2790 (null (nthcdr 3 rest))
2791 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2792 (or (null (cdr rest))
2793 (and (memq output-type '(file progn t))
2794 (cdr (cdr rest))
2795 (eq (car (nth 1 rest)) 'byte-discard)
2796 (progn (setq rest (cdr rest)) t))))
2797 (setq maycall nil) ; Only allow one real function call.
2798 (setq body (nreverse body))
2799 (setq body (list
2800 (if (and (eq tmp 'funcall)
2801 (eq (car-safe (car body)) 'quote))
2802 (cons (nth 1 (car body)) (cdr body))
2803 (cons tmp body))))
2804 (or (eq output-type 'file)
2805 (not (delq nil (mapcar 'consp (cdr (car body))))))))
2806 (setq rest (cdr rest)))
69dc83fd 2807 rest))
1c393159
JB
2808 (let ((byte-compile-vector (byte-compile-constants-vector)))
2809 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2810 byte-compile-vector byte-compile-maxdepth)))
2811 ;; it's a trivial function
2812 ((cdr body) (cons 'progn (nreverse body)))
2813 ((car body)))))
2814
2815;; Given BODY, compile it and return a new body.
2816(defun byte-compile-top-level-body (body &optional for-effect)
2817 (setq body (byte-compile-top-level (cons 'progn body) for-effect t))
2818 (cond ((eq (car-safe body) 'progn)
2819 (cdr body))
2820 (body
2821 (list body))))
d97362d7
GM
2822
2823(put 'declare-function 'byte-hunk-handler 'byte-compile-declare-function)
2824(defun byte-compile-declare-function (form)
2825 (push (cons (nth 1 form)
7628b337
GM
2826 (if (and (> (length form) 3)
2827 (listp (nth 3 form)))
2828 (list 'declared (nth 3 form))
2829 t)) ; arglist not specified
d97362d7 2830 byte-compile-function-environment)
a342aca4
GM
2831 ;; We are stating that it _will_ be defined at runtime.
2832 (setq byte-compile-noruntime-functions
2833 (delq (nth 1 form) byte-compile-noruntime-functions))
d97362d7
GM
2834 nil)
2835
1c393159 2836\f
c5091f25 2837;; This is the recursive entry point for compiling each subform of an
1c393159
JB
2838;; expression.
2839;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2840;; before terminating (ie no value will be left on the stack).
2841;; A byte-compile handler may, when for-effect is non-nil, choose output code
2842;; which does not leave a value on the stack, and then set for-effect to nil
2843;; (to prevent byte-compile-form from outputting the byte-discard).
2844;; If a handler wants to call another handler, it should do so via
2845;; byte-compile-form, or take extreme care to handle for-effect correctly.
2846;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2847;;
2848(defun byte-compile-form (form &optional for-effect)
2849 (setq form (macroexpand form byte-compile-macro-environment))
2850 (cond ((not (consp form))
1639b803 2851 (cond ((or (not (symbolp form)) (byte-compile-const-symbol-p form))
0b46acbf
RS
2852 (when (symbolp form)
2853 (byte-compile-set-symbol-position form))
1c393159
JB
2854 (byte-compile-constant form))
2855 ((and for-effect byte-compile-delete-errors)
0b46acbf
RS
2856 (when (symbolp form)
2857 (byte-compile-set-symbol-position form))
1c393159
JB
2858 (setq for-effect nil))
2859 (t (byte-compile-variable-ref 'byte-varref form))))
2860 ((symbolp (car form))
2861 (let* ((fn (car form))
2862 (handler (get fn 'byte-compile)))
ccb3c8de 2863 (when (byte-compile-const-symbol-p fn)
1d5c17c0 2864 (byte-compile-warn "`%s' called as a function" fn))
cf637a34 2865 (and (byte-compile-warning-enabled-p 'interactive-only)
11efeb9b 2866 (memq fn byte-compile-interactive-only-functions)
086af77c
RS
2867 (byte-compile-warn "`%s' used from Lisp code\n\
2868That command is designed for interactive use only" fn))
1c393159 2869 (if (and handler
67438f77
SM
2870 ;; Make sure that function exists. This is important
2871 ;; for CL compiler macros since the symbol may be
2872 ;; `cl-byte-compile-compiler-macro' but if CL isn't
2873 ;; loaded, this function doesn't exist.
2874 (or (not (memq handler '(cl-byte-compile-compiler-macro)))
e0b4be6c 2875 (functionp handler))
67438f77
SM
2876 (not (and (byte-compile-version-cond
2877 byte-compile-compatibility)
2878 (get (get fn 'byte-opcode) 'emacs19-opcode))))
4ec5239c 2879 (funcall handler form)
cf637a34 2880 (when (byte-compile-warning-enabled-p 'callargs)
11efeb9b
RS
2881 (if (memq fn '(custom-declare-group custom-declare-variable custom-declare-face))
2882 (byte-compile-nogroup-warn form))
2883 (byte-compile-callargs-warn form))
4795d1c7 2884 (byte-compile-normal-call form))
cf637a34 2885 (if (byte-compile-warning-enabled-p 'cl-functions)
4795d1c7 2886 (byte-compile-cl-warn form))))
ed015bdd 2887 ((and (or (byte-code-function-p (car form))
1c393159
JB
2888 (eq (car-safe (car form)) 'lambda))
2889 ;; if the form comes out the same way it went in, that's
2890 ;; because it was malformed, and we couldn't unfold it.
2891 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2892 (byte-compile-form form for-effect)
2893 (setq for-effect nil))
2894 ((byte-compile-normal-call form)))
2895 (if for-effect
2896 (byte-compile-discard)))
2897
2898(defun byte-compile-normal-call (form)
2899 (if byte-compile-generate-call-tree
2900 (byte-compile-annotate-call-tree form))
86da2828 2901 (when (and for-effect (eq (car form) 'mapcar)
cf637a34 2902 (byte-compile-warning-enabled-p 'mapcar))
89c91fdb
GM
2903 (byte-compile-set-symbol-position 'mapcar)
2904 (byte-compile-warn
2905 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
1c393159 2906 (byte-compile-push-constant (car form))
ed62683d 2907 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
1c393159
JB
2908 (byte-compile-out 'byte-call (length (cdr form))))
2909
2910(defun byte-compile-variable-ref (base-op var)
ccb3c8de
CW
2911 (when (symbolp var)
2912 (byte-compile-set-symbol-position var))
6c2161c4
SM
2913 (if (or (not (symbolp var))
2914 (byte-compile-const-symbol-p var (not (eq base-op 'byte-varref))))
2915 (byte-compile-warn
1d5c17c0
RS
2916 (cond ((eq base-op 'byte-varbind) "attempt to let-bind %s `%s'")
2917 ((eq base-op 'byte-varset) "variable assignment to %s `%s'")
2918 (t "variable reference to %s `%s'"))
6c2161c4
SM
2919 (if (symbolp var) "constant" "nonvariable")
2920 (prin1-to-string var))
9290191f 2921 (if (and (get var 'byte-obsolete-variable)
cf637a34 2922 (byte-compile-warning-enabled-p 'obsolete)
6b61353c 2923 (not (eq var byte-compile-not-obsolete-var)))
20482b70
SM
2924 (let* ((ob (get var 'byte-obsolete-variable))
2925 (when (cdr ob)))
1d5c17c0 2926 (byte-compile-warn "`%s' is an obsolete variable%s; %s" var
f1953880 2927 (if when (concat " (as of Emacs " when ")") "")
20482b70
SM
2928 (if (stringp (car ob))
2929 (car ob)
1d5c17c0 2930 (format "use `%s' instead." (car ob))))))
cf637a34 2931 (if (byte-compile-warning-enabled-p 'free-vars)
1c393159 2932 (if (eq base-op 'byte-varbind)
6c2161c4 2933 (push var byte-compile-bound-variables)
1c393159
JB
2934 (or (boundp var)
2935 (memq var byte-compile-bound-variables)
2936 (if (eq base-op 'byte-varset)
2937 (or (memq var byte-compile-free-assignments)
2938 (progn
1d5c17c0 2939 (byte-compile-warn "assignment to free variable `%s'" var)
6c2161c4 2940 (push var byte-compile-free-assignments)))
1c393159
JB
2941 (or (memq var byte-compile-free-references)
2942 (progn
1d5c17c0 2943 (byte-compile-warn "reference to free variable `%s'" var)
6c2161c4 2944 (push var byte-compile-free-references))))))))
1c393159 2945 (let ((tmp (assq var byte-compile-variables)))
6c2161c4
SM
2946 (unless tmp
2947 (setq tmp (list var))
2948 (push tmp byte-compile-variables))
1c393159
JB
2949 (byte-compile-out base-op tmp)))
2950
2951(defmacro byte-compile-get-constant (const)
1639b803 2952 `(or (if (stringp ,const)
7fb4fa10
RS
2953 ;; In a string constant, treat properties as significant.
2954 (let (result)
2955 (dolist (elt byte-compile-constants)
2956 (if (equal-including-properties (car elt) ,const)
2957 (setq result elt)))
2958 result)
1639b803
DL
2959 (assq ,const byte-compile-constants))
2960 (car (setq byte-compile-constants
2961 (cons (list ,const) byte-compile-constants)))))
1c393159
JB
2962
2963;; Use this when the value of a form is a constant. This obeys for-effect.
2964(defun byte-compile-constant (const)
2965 (if for-effect
2966 (setq for-effect nil)
ccb3c8de
CW
2967 (when (symbolp const)
2968 (byte-compile-set-symbol-position const))
1c393159
JB
2969 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
2970
2971;; Use this for a constant that is not the value of its containing form.
2972;; This ignores for-effect.
2973(defun byte-compile-push-constant (const)
2974 (let ((for-effect nil))
2975 (inline (byte-compile-constant const))))
2976
2977\f
2978;; Compile those primitive ordinary functions
2979;; which have special byte codes just for speed.
2980
2981(defmacro byte-defop-compiler (function &optional compile-handler)
2982 ;; add a compiler-form for FUNCTION.
2983 ;; If function is a symbol, then the variable "byte-SYMBOL" must name
2984 ;; the opcode to be used. If function is a list, the first element
2985 ;; is the function and the second element is the bytecode-symbol.
3c9dc1cf 2986 ;; The second element may be nil, meaning there is no opcode.
1c393159
JB
2987 ;; COMPILE-HANDLER is the function to use to compile this byte-op, or
2988 ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2989 ;; If it is nil, then the handler is "byte-compile-SYMBOL."
2990 (let (opcode)
2991 (if (symbolp function)
2992 (setq opcode (intern (concat "byte-" (symbol-name function))))
2993 (setq opcode (car (cdr function))
2994 function (car function)))
2995 (let ((fnform
2996 (list 'put (list 'quote function) ''byte-compile
2997 (list 'quote
2998 (or (cdr (assq compile-handler
2999 '((0 . byte-compile-no-args)
3000 (1 . byte-compile-one-arg)
3001 (2 . byte-compile-two-args)
3002 (3 . byte-compile-three-args)
3003 (0-1 . byte-compile-zero-or-one-arg)
3004 (1-2 . byte-compile-one-or-two-args)
3005 (2-3 . byte-compile-two-or-three-args)
3006 )))
3007 compile-handler
3008 (intern (concat "byte-compile-"
3009 (symbol-name function))))))))
3010 (if opcode
3011 (list 'progn fnform
3012 (list 'put (list 'quote function)
3013 ''byte-opcode (list 'quote opcode))
3014 (list 'put (list 'quote opcode)
3015 ''byte-opcode-invert (list 'quote function)))
3016 fnform))))
3017
3018(defmacro byte-defop-compiler19 (function &optional compile-handler)
3019 ;; Just like byte-defop-compiler, but defines an opcode that will only
e27c3564 3020 ;; be used when byte-compile-compatibility is false.
1c393159 3021 (if (and (byte-compile-single-version)
e27c3564 3022 byte-compile-compatibility)
9e2b097b
JB
3023 ;; #### instead of doing nothing, this should do some remprops,
3024 ;; #### to protect against the case where a single-version compiler
3025 ;; #### is loaded into a world that has contained a multi-version one.
1c393159
JB
3026 nil
3027 (list 'progn
3028 (list 'put
3029 (list 'quote
3030 (or (car (cdr-safe function))
3031 (intern (concat "byte-"
3032 (symbol-name (or (car-safe function) function))))))
3033 ''emacs19-opcode t)
3034 (list 'byte-defop-compiler function compile-handler))))
3035
3036(defmacro byte-defop-compiler-1 (function &optional compile-handler)
3037 (list 'byte-defop-compiler (list function nil) compile-handler))
3038
3039\f
3040(put 'byte-call 'byte-opcode-invert 'funcall)
3041(put 'byte-list1 'byte-opcode-invert 'list)
3042(put 'byte-list2 'byte-opcode-invert 'list)
3043(put 'byte-list3 'byte-opcode-invert 'list)
3044(put 'byte-list4 'byte-opcode-invert 'list)
3045(put 'byte-listN 'byte-opcode-invert 'list)
3046(put 'byte-concat2 'byte-opcode-invert 'concat)
3047(put 'byte-concat3 'byte-opcode-invert 'concat)
3048(put 'byte-concat4 'byte-opcode-invert 'concat)
3049(put 'byte-concatN 'byte-opcode-invert 'concat)
3050(put 'byte-insertN 'byte-opcode-invert 'insert)
3051
1c393159
JB
3052(byte-defop-compiler point 0)
3053;;(byte-defop-compiler mark 0) ;; obsolete
3054(byte-defop-compiler point-max 0)
3055(byte-defop-compiler point-min 0)
3056(byte-defop-compiler following-char 0)
3057(byte-defop-compiler preceding-char 0)
3058(byte-defop-compiler current-column 0)
3059(byte-defop-compiler eolp 0)
3060(byte-defop-compiler eobp 0)
3061(byte-defop-compiler bolp 0)
3062(byte-defop-compiler bobp 0)
3063(byte-defop-compiler current-buffer 0)
3064;;(byte-defop-compiler read-char 0) ;; obsolete
3065(byte-defop-compiler interactive-p 0)
3066(byte-defop-compiler19 widen 0)
3067(byte-defop-compiler19 end-of-line 0-1)
3068(byte-defop-compiler19 forward-char 0-1)
3069(byte-defop-compiler19 forward-line 0-1)
3070(byte-defop-compiler symbolp 1)
3071(byte-defop-compiler consp 1)
3072(byte-defop-compiler stringp 1)
3073(byte-defop-compiler listp 1)
3074(byte-defop-compiler not 1)
3075(byte-defop-compiler (null byte-not) 1)
3076(byte-defop-compiler car 1)
3077(byte-defop-compiler cdr 1)
3078(byte-defop-compiler length 1)
3079(byte-defop-compiler symbol-value 1)
3080(byte-defop-compiler symbol-function 1)
3081(byte-defop-compiler (1+ byte-add1) 1)
3082(byte-defop-compiler (1- byte-sub1) 1)
3083(byte-defop-compiler goto-char 1)
b8ae93ad 3084(byte-defop-compiler char-after 0-1)
1c393159
JB
3085(byte-defop-compiler set-buffer 1)
3086;;(byte-defop-compiler set-mark 1) ;; obsolete
78642e03 3087(byte-defop-compiler19 forward-word 0-1)
1c393159
JB
3088(byte-defop-compiler19 char-syntax 1)
3089(byte-defop-compiler19 nreverse 1)
3090(byte-defop-compiler19 car-safe 1)
3091(byte-defop-compiler19 cdr-safe 1)
3092(byte-defop-compiler19 numberp 1)
3093(byte-defop-compiler19 integerp 1)
3094(byte-defop-compiler19 skip-chars-forward 1-2)
3095(byte-defop-compiler19 skip-chars-backward 1-2)
1c393159
JB
3096(byte-defop-compiler eq 2)
3097(byte-defop-compiler memq 2)
3098(byte-defop-compiler cons 2)
3099(byte-defop-compiler aref 2)
3100(byte-defop-compiler set 2)
3101(byte-defop-compiler (= byte-eqlsign) 2)
3102(byte-defop-compiler (< byte-lss) 2)
3103(byte-defop-compiler (> byte-gtr) 2)
3104(byte-defop-compiler (<= byte-leq) 2)
3105(byte-defop-compiler (>= byte-geq) 2)
3106(byte-defop-compiler get 2)
3107(byte-defop-compiler nth 2)
3108(byte-defop-compiler substring 2-3)
9e2b097b 3109(byte-defop-compiler19 (move-marker byte-set-marker) 2-3)
1c393159
JB
3110(byte-defop-compiler19 set-marker 2-3)
3111(byte-defop-compiler19 match-beginning 1)
3112(byte-defop-compiler19 match-end 1)
3113(byte-defop-compiler19 upcase 1)
3114(byte-defop-compiler19 downcase 1)
3115(byte-defop-compiler19 string= 2)
3116(byte-defop-compiler19 string< 2)
9e2b097b
JB
3117(byte-defop-compiler19 (string-equal byte-string=) 2)
3118(byte-defop-compiler19 (string-lessp byte-string<) 2)
1c393159
JB
3119(byte-defop-compiler19 equal 2)
3120(byte-defop-compiler19 nthcdr 2)
3121(byte-defop-compiler19 elt 2)
3122(byte-defop-compiler19 member 2)
3123(byte-defop-compiler19 assq 2)
9e2b097b
JB
3124(byte-defop-compiler19 (rplaca byte-setcar) 2)
3125(byte-defop-compiler19 (rplacd byte-setcdr) 2)
1c393159
JB
3126(byte-defop-compiler19 setcar 2)
3127(byte-defop-compiler19 setcdr 2)
3128(byte-defop-compiler19 buffer-substring 2)
3129(byte-defop-compiler19 delete-region 2)
3130(byte-defop-compiler19 narrow-to-region 2)
1c393159
JB
3131(byte-defop-compiler19 (% byte-rem) 2)
3132(byte-defop-compiler aset 3)
3133
3134(byte-defop-compiler max byte-compile-associative)
3135(byte-defop-compiler min byte-compile-associative)
3136(byte-defop-compiler (+ byte-plus) byte-compile-associative)
3137(byte-defop-compiler19 (* byte-mult) byte-compile-associative)
3138
3139;;####(byte-defop-compiler19 move-to-column 1)
3140(byte-defop-compiler-1 interactive byte-compile-noop)
3141
3142\f
3143(defun byte-compile-subr-wrong-args (form n)
ccb3c8de 3144 (byte-compile-set-symbol-position (car form))
1d5c17c0 3145 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
1c393159
JB
3146 (car form) (length (cdr form))
3147 (if (= 1 (length (cdr form))) "" "s") n)
3148 ;; get run-time wrong-number-of-args error.
3149 (byte-compile-normal-call form))
3150
3151(defun byte-compile-no-args (form)
3152 (if (not (= (length form) 1))
3153 (byte-compile-subr-wrong-args form "none")
3154 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3155
3156(defun byte-compile-one-arg (form)
3157 (if (not (= (length form) 2))
3158 (byte-compile-subr-wrong-args form 1)
3159 (byte-compile-form (car (cdr form))) ;; Push the argument
3160 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3161
3162(defun byte-compile-two-args (form)
3163 (if (not (= (length form) 3))
3164 (byte-compile-subr-wrong-args form 2)
3165 (byte-compile-form (car (cdr form))) ;; Push the arguments
3166 (byte-compile-form (nth 2 form))
3167 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3168
3169(defun byte-compile-three-args (form)
3170 (if (not (= (length form) 4))
3171 (byte-compile-subr-wrong-args form 3)
3172 (byte-compile-form (car (cdr form))) ;; Push the arguments
3173 (byte-compile-form (nth 2 form))
3174 (byte-compile-form (nth 3 form))
3175 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3176
3177(defun byte-compile-zero-or-one-arg (form)
3178 (let ((len (length form)))
3179 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3180 ((= len 2) (byte-compile-one-arg form))
3181 (t (byte-compile-subr-wrong-args form "0-1")))))
3182
3183(defun byte-compile-one-or-two-args (form)
3184 (let ((len (length form)))
3185 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3186 ((= len 3) (byte-compile-two-args form))
3187 (t (byte-compile-subr-wrong-args form "1-2")))))
3188
3189(defun byte-compile-two-or-three-args (form)
3190 (let ((len (length form)))
3191 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3192 ((= len 4) (byte-compile-three-args form))
3193 (t (byte-compile-subr-wrong-args form "2-3")))))
3194
3195(defun byte-compile-noop (form)
3196 (byte-compile-constant nil))
3197
3198(defun byte-compile-discard ()
3199 (byte-compile-out 'byte-discard 0))
3200
3201
3202;; Compile a function that accepts one or more args and is right-associative.
c0f43df5
RS
3203;; We do it by left-associativity so that the operations
3204;; are done in the same order as in interpreted code.
10809e0f
RS
3205;; We treat the one-arg case, as in (+ x), like (+ x 0).
3206;; in order to convert markers to numbers, and trigger expected errors.
1c393159
JB
3207(defun byte-compile-associative (form)
3208 (if (cdr form)
c0f43df5
RS
3209 (let ((opcode (get (car form) 'byte-opcode))
3210 (args (copy-sequence (cdr form))))
3211 (byte-compile-form (car args))
3212 (setq args (cdr args))
10809e0f
RS
3213 (or args (setq args '(0)
3214 opcode (get '+ 'byte-opcode)))
6c2161c4
SM
3215 (dolist (arg args)
3216 (byte-compile-form arg)
3217 (byte-compile-out opcode 0)))
1c393159
JB
3218 (byte-compile-constant (eval form))))
3219
3220\f
3221;; more complicated compiler macros
3222
ec448ae2 3223(byte-defop-compiler char-before)
a746fb65
GM
3224(byte-defop-compiler backward-char)
3225(byte-defop-compiler backward-word)
1c393159
JB
3226(byte-defop-compiler list)
3227(byte-defop-compiler concat)
3228(byte-defop-compiler fset)
3229(byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3230(byte-defop-compiler indent-to)
3231(byte-defop-compiler insert)
3232(byte-defop-compiler-1 function byte-compile-function-form)
3233(byte-defop-compiler-1 - byte-compile-minus)
3234(byte-defop-compiler19 (/ byte-quo) byte-compile-quo)
3235(byte-defop-compiler19 nconc)
1c393159 3236
ec448ae2
GM
3237(defun byte-compile-char-before (form)
3238 (cond ((= 2 (length form))
a746fb65
GM
3239 (byte-compile-form (list 'char-after (if (numberp (nth 1 form))
3240 (1- (nth 1 form))
3241 `(1- ,(nth 1 form))))))
3242 ((= 1 (length form))
3243 (byte-compile-form '(char-after (1- (point)))))
3244 (t (byte-compile-subr-wrong-args form "0-1"))))
3245
3246;; backward-... ==> forward-... with negated argument.
3247(defun byte-compile-backward-char (form)
3248 (cond ((= 2 (length form))
3249 (byte-compile-form (list 'forward-char (if (numberp (nth 1 form))
3250 (- (nth 1 form))
3251 `(- ,(nth 1 form))))))
3252 ((= 1 (length form))
3253 (byte-compile-form '(forward-char -1)))
3254 (t (byte-compile-subr-wrong-args form "0-1"))))
3255
3256(defun byte-compile-backward-word (form)
3257 (cond ((= 2 (length form))
3258 (byte-compile-form (list 'forward-word (if (numberp (nth 1 form))
3259 (- (nth 1 form))
3260 `(- ,(nth 1 form))))))
3261 ((= 1 (length form))
3262 (byte-compile-form '(forward-word -1)))
3263 (t (byte-compile-subr-wrong-args form "0-1"))))
ec448ae2 3264
1c393159
JB
3265(defun byte-compile-list (form)
3266 (let ((count (length (cdr form))))
3267 (cond ((= count 0)
3268 (byte-compile-constant nil))
3269 ((< count 5)
ed62683d 3270 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3271 (byte-compile-out
3272 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
e27c3564
JB
3273 ((and (< count 256) (not (byte-compile-version-cond
3274 byte-compile-compatibility)))
ed62683d 3275 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3276 (byte-compile-out 'byte-listN count))
3277 (t (byte-compile-normal-call form)))))
3278
3279(defun byte-compile-concat (form)
3280 (let ((count (length (cdr form))))
3281 (cond ((and (< 1 count) (< count 5))
ed62683d 3282 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3283 (byte-compile-out
3284 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3285 0))
3286 ;; Concat of one arg is not a no-op if arg is not a string.
3287 ((= count 0)
3288 (byte-compile-form ""))
e27c3564
JB
3289 ((and (< count 256) (not (byte-compile-version-cond
3290 byte-compile-compatibility)))
ed62683d 3291 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3292 (byte-compile-out 'byte-concatN count))
3293 ((byte-compile-normal-call form)))))
3294
3295(defun byte-compile-minus (form)
3296 (if (null (setq form (cdr form)))
3297 (byte-compile-constant 0)
3298 (byte-compile-form (car form))
3299 (if (cdr form)
3300 (while (setq form (cdr form))
3301 (byte-compile-form (car form))
3302 (byte-compile-out 'byte-diff 0))
3303 (byte-compile-out 'byte-negate 0))))
3304
3305(defun byte-compile-quo (form)
3306 (let ((len (length form)))
3307 (cond ((<= len 2)
3308 (byte-compile-subr-wrong-args form "2 or more"))
3309 (t
3310 (byte-compile-form (car (setq form (cdr form))))
3311 (while (setq form (cdr form))
3312 (byte-compile-form (car form))
3313 (byte-compile-out 'byte-quo 0))))))
3314
3315(defun byte-compile-nconc (form)
3316 (let ((len (length form)))
3317 (cond ((= len 1)
3318 (byte-compile-constant nil))
3319 ((= len 2)
3320 ;; nconc of one arg is a noop, even if that arg isn't a list.
3321 (byte-compile-form (nth 1 form)))
3322 (t
3323 (byte-compile-form (car (setq form (cdr form))))
3324 (while (setq form (cdr form))
3325 (byte-compile-form (car form))
3326 (byte-compile-out 'byte-nconc 0))))))
3327
3328(defun byte-compile-fset (form)
3329 ;; warn about forms like (fset 'foo '(lambda () ...))
3330 ;; (where the lambda expression is non-trivial...)
3331 (let ((fn (nth 2 form))
3332 body)
3333 (if (and (eq (car-safe fn) 'quote)
3334 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3335 (progn
3336 (setq body (cdr (cdr fn)))
3337 (if (stringp (car body)) (setq body (cdr body)))
3338 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3339 (if (and (consp (car body))
3340 (not (eq 'byte-code (car (car body)))))
3341 (byte-compile-warn
1d5c17c0 3342 "A quoted lambda form is the second argument of `fset'. This is probably
1c393159
JB
3343 not what you want, as that lambda cannot be compiled. Consider using
3344 the syntax (function (lambda (...) ...)) instead.")))))
3345 (byte-compile-two-args form))
3346
3347(defun byte-compile-funarg (form)
3348 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
eb8c3be9 3349 ;; for cases where it's guaranteed that first arg will be used as a lambda.
1c393159
JB
3350 (byte-compile-normal-call
3351 (let ((fn (nth 1 form)))
3352 (if (and (eq (car-safe fn) 'quote)
3353 (eq (car-safe (nth 1 fn)) 'lambda))
3354 (cons (car form)
3355 (cons (cons 'function (cdr fn))
3356 (cdr (cdr form))))
3357 form))))
3358
5a6037bb
RS
3359(defun byte-compile-funarg-2 (form)
3360 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
3361 ;; for cases where it's guaranteed that second arg will be used as a lambda.
3362 (byte-compile-normal-call
3363 (let ((fn (nth 2 form)))
3364 (if (and (eq (car-safe fn) 'quote)
3365 (eq (car-safe (nth 1 fn)) 'lambda))
3366 (cons (car form)
3367 (cons (nth 1 form)
3368 (cons (cons 'function (cdr fn))
3369 (cdr (cdr (cdr form))))))
3370 form))))
3371
1c393159
JB
3372;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3373;; Otherwise it will be incompatible with the interpreter,
3374;; and (funcall (function foo)) will lose with autoloads.
3375
3376(defun byte-compile-function-form (form)
3377 (byte-compile-constant
3378 (cond ((symbolp (nth 1 form))
3379 (nth 1 form))
3380 ;; If we're not allowed to use #[] syntax, then output a form like
3381 ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code.
3382 ;; In this situation, calling make-byte-code at run-time will usually
3383 ;; be less efficient than processing a call to byte-code.
52799cb8 3384 ((byte-compile-version-cond byte-compile-compatibility)
1c393159
JB
3385 (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form))))
3386 ((byte-compile-lambda (nth 1 form))))))
3387
3388(defun byte-compile-indent-to (form)
3389 (let ((len (length form)))
3390 (cond ((= len 2)
3391 (byte-compile-form (car (cdr form)))
3392 (byte-compile-out 'byte-indent-to 0))
3393 ((= len 3)
3394 ;; no opcode for 2-arg case.
3395 (byte-compile-normal-call form))
3396 (t
3397 (byte-compile-subr-wrong-args form "1-2")))))
3398
3399(defun byte-compile-insert (form)
3400 (cond ((null (cdr form))
3401 (byte-compile-constant nil))
e27c3564
JB
3402 ((and (not (byte-compile-version-cond
3403 byte-compile-compatibility))
1c393159 3404 (<= (length form) 256))
ed62683d 3405 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3406 (if (cdr (cdr form))
3407 (byte-compile-out 'byte-insertN (length (cdr form)))
3408 (byte-compile-out 'byte-insert 0)))
3409 ((memq t (mapcar 'consp (cdr (cdr form))))
3410 (byte-compile-normal-call form))
3411 ;; We can split it; there is no function call after inserting 1st arg.
3412 (t
3413 (while (setq form (cdr form))
3414 (byte-compile-form (car form))
3415 (byte-compile-out 'byte-insert 0)
3416 (if (cdr form)
3417 (byte-compile-discard))))))
3418
1c393159
JB
3419\f
3420(byte-defop-compiler-1 setq)
3421(byte-defop-compiler-1 setq-default)
3422(byte-defop-compiler-1 quote)
3423(byte-defop-compiler-1 quote-form)
3424
3425(defun byte-compile-setq (form)
3426 (let ((args (cdr form)))
3427 (if args
3428 (while args
3429 (byte-compile-form (car (cdr args)))
3430 (or for-effect (cdr (cdr args))
3431 (byte-compile-out 'byte-dup 0))
3432 (byte-compile-variable-ref 'byte-varset (car args))
3433 (setq args (cdr (cdr args))))
3434 ;; (setq), with no arguments.
3435 (byte-compile-form nil for-effect))
3436 (setq for-effect nil)))
3437
3438(defun byte-compile-setq-default (form)
ca38179a
RS
3439 (let ((args (cdr form))
3440 setters)
3441 (while args
3442 (setq setters
3443 (cons (list 'set-default (list 'quote (car args)) (car (cdr args)))
3444 setters))
3445 (setq args (cdr (cdr args))))
3446 (byte-compile-form (cons 'progn (nreverse setters)))))
1c393159
JB
3447
3448(defun byte-compile-quote (form)
3449 (byte-compile-constant (car (cdr form))))
3450
3451(defun byte-compile-quote-form (form)
3452 (byte-compile-constant (byte-compile-top-level (nth 1 form))))
3453
3454\f
3455;;; control structures
3456
3457(defun byte-compile-body (body &optional for-effect)
3458 (while (cdr body)
3459 (byte-compile-form (car body) t)
3460 (setq body (cdr body)))
3461 (byte-compile-form (car body) for-effect))
3462
52799cb8 3463(defsubst byte-compile-body-do-effect (body)
1c393159
JB
3464 (byte-compile-body body for-effect)
3465 (setq for-effect nil))
3466
52799cb8 3467(defsubst byte-compile-form-do-effect (form)
1c393159
JB
3468 (byte-compile-form form for-effect)
3469 (setq for-effect nil))
3470
3471(byte-defop-compiler-1 inline byte-compile-progn)
3472(byte-defop-compiler-1 progn)
3473(byte-defop-compiler-1 prog1)
3474(byte-defop-compiler-1 prog2)
3475(byte-defop-compiler-1 if)
3476(byte-defop-compiler-1 cond)
3477(byte-defop-compiler-1 and)
3478(byte-defop-compiler-1 or)
3479(byte-defop-compiler-1 while)
3480(byte-defop-compiler-1 funcall)
3481(byte-defop-compiler-1 apply byte-compile-funarg)
3482(byte-defop-compiler-1 mapcar byte-compile-funarg)
3483(byte-defop-compiler-1 mapatoms byte-compile-funarg)
3484(byte-defop-compiler-1 mapconcat byte-compile-funarg)
28bb2cef 3485(byte-defop-compiler-1 mapc byte-compile-funarg)
def9389a
DL
3486(byte-defop-compiler-1 maphash byte-compile-funarg)
3487(byte-defop-compiler-1 map-char-table byte-compile-funarg)
351697be
DL
3488(byte-defop-compiler-1 map-char-table byte-compile-funarg-2)
3489;; map-charset-chars should be funarg but has optional third arg
5a6037bb 3490(byte-defop-compiler-1 sort byte-compile-funarg-2)
1c393159
JB
3491(byte-defop-compiler-1 let)
3492(byte-defop-compiler-1 let*)
3493
3494(defun byte-compile-progn (form)
3495 (byte-compile-body-do-effect (cdr form)))
3496
3497(defun byte-compile-prog1 (form)
3498 (byte-compile-form-do-effect (car (cdr form)))
3499 (byte-compile-body (cdr (cdr form)) t))
3500
3501(defun byte-compile-prog2 (form)
3502 (byte-compile-form (nth 1 form) t)
3503 (byte-compile-form-do-effect (nth 2 form))
3504 (byte-compile-body (cdr (cdr (cdr form))) t))
3505
3506(defmacro byte-compile-goto-if (cond discard tag)
1639b803
DL
3507 `(byte-compile-goto
3508 (if ,cond
3509 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3510 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3511 ,tag))
1c393159 3512
70f41945
DN
3513;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3514;; Only return items that are not in ONLY-IF-NOT-PRESENT.
516b3653
JB
3515(defun byte-compile-find-bound-condition (condition-param
3516 pred-list
70f41945
DN
3517 &optional only-if-not-present)
3518 (let ((result nil)
3519 (nth-one nil)
516b3653 3520 (cond-list
70f41945
DN
3521 (if (memq (car-safe condition-param) pred-list)
3522 ;; The condition appears by itself.
3523 (list condition-param)
3524 ;; If the condition is an `and', look for matches among the
3525 ;; `and' arguments.
3526 (when (eq 'and (car-safe condition-param))
3527 (cdr condition-param)))))
516b3653 3528
70f41945
DN
3529 (dolist (crt cond-list)
3530 (when (and (memq (car-safe crt) pred-list)
3531 (eq 'quote (car-safe (setq nth-one (nth 1 crt))))
3532 ;; Ignore if the symbol is already on the unresolved
3533 ;; list.
3534 (not (assq (nth 1 nth-one) ; the relevant symbol
3535 only-if-not-present)))
3536 (push (nth 1 (nth 1 crt)) result)))
3537 result))
3538
6b61353c
KH
3539(defmacro byte-compile-maybe-guarded (condition &rest body)
3540 "Execute forms in BODY, potentially guarded by CONDITION.
82a726b4
RS
3541CONDITION is a variable whose value is a test in an `if' or `cond'.
3542BODY is the code to compile first arm of the if or the body of the
b2e948ee 3543cond clause. If CONDITION's value is of the form (fboundp 'foo)
ad50a502 3544or (boundp 'foo), the relevant warnings from BODY about foo's
82a726b4
RS
3545being undefined will be suppressed.
3546
b2e948ee 3547If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
ad50a502 3548that suppresses all warnings during execution of BODY."
6b61353c 3549 (declare (indent 1) (debug t))
516b3653
JB
3550 `(let* ((fbound-list (byte-compile-find-bound-condition
3551 ,condition (list 'fboundp)
70f41945 3552 byte-compile-unresolved-functions))
516b3653 3553 (bound-list (byte-compile-find-bound-condition
70f41945 3554 ,condition (list 'boundp 'default-boundp)))
6b61353c
KH
3555 ;; Maybe add to the bound list.
3556 (byte-compile-bound-variables
70f41945
DN
3557 (if bound-list
3558 (append bound-list byte-compile-bound-variables)
82a726b4 3559 byte-compile-bound-variables))
83b0af6e 3560 ;; Suppress all warnings, for code not used in Emacs.
70f41945
DN
3561 ;; FIXME: by the time this is executed the `featurep'
3562 ;; emacs/xemacs tests have been optimized away, so this is
3563 ;; not doing anything useful here, is should probably be
3564 ;; moved to a different place.
c01e3aa1
GM
3565 ;; It is doing _something_. If this is commented out, then
3566 ;; compiling a file which requires another file which
3567 ;; defines a defsubst that uses (featurep 'xemacs) results
3568 ;; in a spurious compilation warning about the xemacs code. Eg:
3569 ;; (defsubst foo () (if (featurep 'xemacs) (setq foo t)))
3570 ;; where foo is a free variable.
3571 (byte-compile-warnings
3572 (if (member ,condition '((featurep 'xemacs)
3573 (not (featurep 'emacs))))
3574 nil byte-compile-warnings))
70f41945 3575 )
82a726b4
RS
3576 (unwind-protect
3577 (progn ,@body)
3578 ;; Maybe remove the function symbol from the unresolved list.
70f41945
DN
3579 (dolist (fbound fbound-list)
3580 (when fbound
82a726b4
RS
3581 (setq byte-compile-unresolved-functions
3582 (delq (assq fbound byte-compile-unresolved-functions)
70f41945 3583 byte-compile-unresolved-functions)))))))
6b61353c 3584
1c393159
JB
3585(defun byte-compile-if (form)
3586 (byte-compile-form (car (cdr form)))
b8234c84
DL
3587 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3588 ;; and avoid warnings about the relevent symbols in the consequent.
6b61353c
KH
3589 (let ((clause (nth 1 form))
3590 (donetag (byte-compile-make-tag)))
b8234c84
DL
3591 (if (null (nthcdr 3 form))
3592 ;; No else-forms
3593 (progn
3594 (byte-compile-goto-if nil for-effect donetag)
6b61353c 3595 (byte-compile-maybe-guarded clause
b8234c84 3596 (byte-compile-form (nth 2 form) for-effect))
b8234c84
DL
3597 (byte-compile-out-tag donetag))
3598 (let ((elsetag (byte-compile-make-tag)))
3599 (byte-compile-goto 'byte-goto-if-nil elsetag)
6b61353c
KH
3600 (byte-compile-maybe-guarded clause
3601 (byte-compile-form (nth 2 form) for-effect))
b8234c84
DL
3602 (byte-compile-goto 'byte-goto donetag)
3603 (byte-compile-out-tag elsetag)
300f994a
RS
3604 (byte-compile-maybe-guarded (list 'not clause)
3605 (byte-compile-body (cdr (cdr (cdr form))) for-effect))
b8234c84 3606 (byte-compile-out-tag donetag))))
1c393159
JB
3607 (setq for-effect nil))
3608
3609(defun byte-compile-cond (clauses)
3610 (let ((donetag (byte-compile-make-tag))
3611 nexttag clause)
3612 (while (setq clauses (cdr clauses))
3613 (setq clause (car clauses))
3614 (cond ((or (eq (car clause) t)
3615 (and (eq (car-safe (car clause)) 'quote)
3616 (car-safe (cdr-safe (car clause)))))
3617 ;; Unconditional clause
3618 (setq clause (cons t clause)
3619 clauses nil))
3620 ((cdr clauses)
3621 (byte-compile-form (car clause))
3622 (if (null (cdr clause))
3623 ;; First clause is a singleton.
3624 (byte-compile-goto-if t for-effect donetag)
82a726b4
RS
3625 (setq nexttag (byte-compile-make-tag))
3626 (byte-compile-goto 'byte-goto-if-nil nexttag)
3627 (byte-compile-maybe-guarded (car clause)
3628 (byte-compile-body (cdr clause) for-effect))
3629 (byte-compile-goto 'byte-goto donetag)
3630 (byte-compile-out-tag nexttag)))))
1c393159 3631 ;; Last clause
6b61353c
KH
3632 (let ((guard (car clause)))
3633 (and (cdr clause) (not (eq guard t))
3634 (progn (byte-compile-form guard)
3635 (byte-compile-goto-if nil for-effect donetag)
3636 (setq clause (cdr clause))))
3637 (byte-compile-maybe-guarded guard
3638 (byte-compile-body-do-effect clause)))
1c393159
JB
3639 (byte-compile-out-tag donetag)))
3640
3641(defun byte-compile-and (form)
3642 (let ((failtag (byte-compile-make-tag))
3643 (args (cdr form)))
3644 (if (null args)
3645 (byte-compile-form-do-effect t)
8877fa6f
RS
3646 (byte-compile-and-recursion args failtag))))
3647
83b0af6e 3648;; Handle compilation of a nontrivial `and' call.
8877fa6f
RS
3649;; We use tail recursion so we can use byte-compile-maybe-guarded.
3650(defun byte-compile-and-recursion (rest failtag)
3651 (if (cdr rest)
3652 (progn
3653 (byte-compile-form (car rest))
1c393159 3654 (byte-compile-goto-if nil for-effect failtag)
8877fa6f
RS
3655 (byte-compile-maybe-guarded (car rest)
3656 (byte-compile-and-recursion (cdr rest) failtag)))
3657 (byte-compile-form-do-effect (car rest))
3658 (byte-compile-out-tag failtag)))
1c393159
JB
3659
3660(defun byte-compile-or (form)
3661 (let ((wintag (byte-compile-make-tag))
3662 (args (cdr form)))
3663 (if (null args)
3664 (byte-compile-form-do-effect nil)
83b0af6e
RS
3665 (byte-compile-or-recursion args wintag))))
3666
3667;; Handle compilation of a nontrivial `or' call.
3668;; We use tail recursion so we can use byte-compile-maybe-guarded.
3669(defun byte-compile-or-recursion (rest wintag)
3670 (if (cdr rest)
3671 (progn
3672 (byte-compile-form (car rest))
1c393159 3673 (byte-compile-goto-if t for-effect wintag)
83b0af6e
RS
3674 (byte-compile-maybe-guarded (list 'not (car rest))
3675 (byte-compile-or-recursion (cdr rest) wintag)))
3676 (byte-compile-form-do-effect (car rest))
3677 (byte-compile-out-tag wintag)))
1c393159
JB
3678
3679(defun byte-compile-while (form)
3680 (let ((endtag (byte-compile-make-tag))
3681 (looptag (byte-compile-make-tag)))
3682 (byte-compile-out-tag looptag)
3683 (byte-compile-form (car (cdr form)))
3684 (byte-compile-goto-if nil for-effect endtag)
3685 (byte-compile-body (cdr (cdr form)) t)
3686 (byte-compile-goto 'byte-goto looptag)
3687 (byte-compile-out-tag endtag)
3688 (setq for-effect nil)))
3689
3690(defun byte-compile-funcall (form)
ed62683d 3691 (mapc 'byte-compile-form (cdr form))
1c393159
JB
3692 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3693
3694
3695(defun byte-compile-let (form)
3696 ;; First compute the binding values in the old scope.
3697 (let ((varlist (car (cdr form))))
6c2161c4
SM
3698 (dolist (var varlist)
3699 (if (consp var)
3700 (byte-compile-form (car (cdr var)))
3701 (byte-compile-push-constant nil))))
1c393159
JB
3702 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3703 (varlist (reverse (car (cdr form)))))
6c2161c4
SM
3704 (dolist (var varlist)
3705 (byte-compile-variable-ref 'byte-varbind (if (consp var) (car var) var)))
1c393159
JB
3706 (byte-compile-body-do-effect (cdr (cdr form)))
3707 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3708
3709(defun byte-compile-let* (form)
3710 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3711 (varlist (copy-sequence (car (cdr form)))))
6c2161c4
SM
3712 (dolist (var varlist)
3713 (if (atom var)
1c393159 3714 (byte-compile-push-constant nil)
6c2161c4
SM
3715 (byte-compile-form (car (cdr var)))
3716 (setq var (car var)))
3717 (byte-compile-variable-ref 'byte-varbind var))
1c393159
JB
3718 (byte-compile-body-do-effect (cdr (cdr form)))
3719 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3720
3721
3722(byte-defop-compiler-1 /= byte-compile-negated)
3723(byte-defop-compiler-1 atom byte-compile-negated)
3724(byte-defop-compiler-1 nlistp byte-compile-negated)
3725
3726(put '/= 'byte-compile-negated-op '=)
3727(put 'atom 'byte-compile-negated-op 'consp)
3728(put 'nlistp 'byte-compile-negated-op 'listp)
3729
3730(defun byte-compile-negated (form)
3731 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3732
3733;; Even when optimization is off, /= is optimized to (not (= ...)).
3734(defun byte-compile-negation-optimizer (form)
3735 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
ccb3c8de 3736 (byte-compile-set-symbol-position (car form))
1c393159
JB
3737 (list 'not
3738 (cons (or (get (car form) 'byte-compile-negated-op)
3739 (error
52799cb8 3740 "Compiler error: `%s' has no `byte-compile-negated-op' property"
1c393159
JB
3741 (car form)))
3742 (cdr form))))
3743\f
3744;;; other tricky macro-like special-forms
3745
3746(byte-defop-compiler-1 catch)
3747(byte-defop-compiler-1 unwind-protect)
3748(byte-defop-compiler-1 condition-case)
3749(byte-defop-compiler-1 save-excursion)
f3e472b0 3750(byte-defop-compiler-1 save-current-buffer)
1c393159
JB
3751(byte-defop-compiler-1 save-restriction)
3752(byte-defop-compiler-1 save-window-excursion)
3753(byte-defop-compiler-1 with-output-to-temp-buffer)
6e8d0db7 3754(byte-defop-compiler-1 track-mouse)
1c393159
JB
3755
3756(defun byte-compile-catch (form)
3757 (byte-compile-form (car (cdr form)))
3758 (byte-compile-push-constant
3759 (byte-compile-top-level (cons 'progn (cdr (cdr form))) for-effect))
3760 (byte-compile-out 'byte-catch 0))
3761
3762(defun byte-compile-unwind-protect (form)
3763 (byte-compile-push-constant
3764 (byte-compile-top-level-body (cdr (cdr form)) t))
3765 (byte-compile-out 'byte-unwind-protect 0)
3766 (byte-compile-form-do-effect (car (cdr form)))
3767 (byte-compile-out 'byte-unbind 1))
3768
6e8d0db7 3769(defun byte-compile-track-mouse (form)
d7846e08 3770 (byte-compile-form
6c2161c4
SM
3771 `(funcall '(lambda nil
3772 (track-mouse ,@(byte-compile-top-level-body (cdr form)))))))
6e8d0db7 3773
1c393159
JB
3774(defun byte-compile-condition-case (form)
3775 (let* ((var (nth 1 form))
3776 (byte-compile-bound-variables
3777 (if var (cons var byte-compile-bound-variables)
3778 byte-compile-bound-variables)))
ccb3c8de
CW
3779 (byte-compile-set-symbol-position 'condition-case)
3780 (unless (symbolp var)
3781 (byte-compile-warn
1d5c17c0 3782 "`%s' is not a variable-name or nil (in condition-case)" var))
1c393159
JB
3783 (byte-compile-push-constant var)
3784 (byte-compile-push-constant (byte-compile-top-level
3785 (nth 2 form) for-effect))
3786 (let ((clauses (cdr (cdr (cdr form))))
3787 compiled-clauses)
3788 (while clauses
e27c3564
JB
3789 (let* ((clause (car clauses))
3790 (condition (car clause)))
2abcddce
RS
3791 (cond ((not (or (symbolp condition)
3792 (and (listp condition)
3793 (let ((syms condition) (ok t))
3794 (while syms
3795 (if (not (symbolp (car syms)))
3796 (setq ok nil))
3797 (setq syms (cdr syms)))
3798 ok))))
e27c3564 3799 (byte-compile-warn
1d5c17c0 3800 "`%s' is not a condition name or list of such (in condition-case)"
e27c3564 3801 (prin1-to-string condition)))
2abcddce
RS
3802;; ((not (or (eq condition 't)
3803;; (and (stringp (get condition 'error-message))
3804;; (consp (get condition 'error-conditions)))))
3805;; (byte-compile-warn
1d5c17c0 3806;; "`%s' is not a known condition name (in condition-case)"
2abcddce
RS
3807;; condition))
3808 )
1c393159 3809 (setq compiled-clauses
e27c3564 3810 (cons (cons condition
1c393159
JB
3811 (byte-compile-top-level-body
3812 (cdr clause) for-effect))
3813 compiled-clauses)))
3814 (setq clauses (cdr clauses)))
3815 (byte-compile-push-constant (nreverse compiled-clauses)))
3816 (byte-compile-out 'byte-condition-case 0)))
3817
3818
3819(defun byte-compile-save-excursion (form)
3820 (byte-compile-out 'byte-save-excursion 0)
3821 (byte-compile-body-do-effect (cdr form))
3822 (byte-compile-out 'byte-unbind 1))
3823
3824(defun byte-compile-save-restriction (form)
3825 (byte-compile-out 'byte-save-restriction 0)
3826 (byte-compile-body-do-effect (cdr form))
3827 (byte-compile-out 'byte-unbind 1))
3828
f3e472b0
RS
3829(defun byte-compile-save-current-buffer (form)
3830 (byte-compile-out 'byte-save-current-buffer 0)
3831 (byte-compile-body-do-effect (cdr form))
3832 (byte-compile-out 'byte-unbind 1))
3833
1c393159
JB
3834(defun byte-compile-save-window-excursion (form)
3835 (byte-compile-push-constant
3836 (byte-compile-top-level-body (cdr form) for-effect))
3837 (byte-compile-out 'byte-save-window-excursion 0))
3838
3839(defun byte-compile-with-output-to-temp-buffer (form)
3840 (byte-compile-form (car (cdr form)))
3841 (byte-compile-out 'byte-temp-output-buffer-setup 0)
3842 (byte-compile-body (cdr (cdr form)))
3843 (byte-compile-out 'byte-temp-output-buffer-show 0))
1c393159
JB
3844\f
3845;;; top-level forms elsewhere
3846
3847(byte-defop-compiler-1 defun)
3848(byte-defop-compiler-1 defmacro)
3849(byte-defop-compiler-1 defvar)
3850(byte-defop-compiler-1 defconst byte-compile-defvar)
3851(byte-defop-compiler-1 autoload)
3852(byte-defop-compiler-1 lambda byte-compile-lambda-form)
3853
3854(defun byte-compile-defun (form)
3855 ;; This is not used for file-level defuns with doc strings.
ccb3c8de
CW
3856 (if (symbolp (car form))
3857 (byte-compile-set-symbol-position (car form))
3858 (byte-compile-set-symbol-position 'defun)
eadd6444 3859 (error "defun name must be a symbol, not %s" (car form)))
d8c91258
RS
3860 (if (byte-compile-version-cond byte-compile-compatibility)
3861 (progn
3862 (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning.
3863 (list 'fset
3864 (list 'quote (nth 1 form))
3865 (byte-compile-byte-code-maker
4ec5239c 3866 (byte-compile-lambda (cdr (cdr form)) t))))
d8c91258 3867 (byte-compile-discard))
a81edd91
RS
3868 ;; We prefer to generate a defalias form so it will record the function
3869 ;; definition just like interpreting a defun.
d8c91258
RS
3870 (byte-compile-form
3871 (list 'defalias
3872 (list 'quote (nth 1 form))
3873 (byte-compile-byte-code-maker
4ec5239c 3874 (byte-compile-lambda (cdr (cdr form)) t)))
d8c91258 3875 t))
1c393159
JB
3876 (byte-compile-constant (nth 1 form)))
3877
3878(defun byte-compile-defmacro (form)
3879 ;; This is not used for file-level defmacros with doc strings.
3880 (byte-compile-body-do-effect
3881 (list (list 'fset (list 'quote (nth 1 form))
3882 (let ((code (byte-compile-byte-code-maker
4ec5239c 3883 (byte-compile-lambda (cdr (cdr form)) t))))
1c393159
JB
3884 (if (eq (car-safe code) 'make-byte-code)
3885 (list 'cons ''macro code)
3886 (list 'quote (cons 'macro (eval code))))))
3887 (list 'quote (nth 1 form)))))
3888
3889(defun byte-compile-defvar (form)
3890 ;; This is not used for file-level defvar/consts with doc strings.
1bc20d83
GM
3891 (let ((fun (nth 0 form))
3892 (var (nth 1 form))
1c393159
JB
3893 (value (nth 2 form))
3894 (string (nth 3 form)))
ccb3c8de 3895 (byte-compile-set-symbol-position fun)
6c2161c4
SM
3896 (when (or (> (length form) 4)
3897 (and (eq fun 'defconst) (null (cddr form))))
d0e07261
SM
3898 (let ((ncall (length (cdr form))))
3899 (byte-compile-warn
1d5c17c0 3900 "`%s' called with %d argument%s, but %s %s"
d0e07261
SM
3901 fun ncall
3902 (if (= 1 ncall) "" "s")
3903 (if (< ncall 2) "requires" "accepts only")
3904 "2-3")))
cf637a34 3905 (when (byte-compile-warning-enabled-p 'free-vars)
8898f44e 3906 (push var byte-compile-bound-variables)
6c2161c4
SM
3907 (if (eq fun 'defconst)
3908 (push var byte-compile-const-variables)))
1c393159 3909 (byte-compile-body-do-effect
1bc20d83
GM
3910 (list
3911 ;; Put the defined variable in this library's load-history entry
3912 ;; just as a real defvar would, but only in top-level forms.
3614fc84 3913 (when (and (cddr form) (null byte-compile-current-form))
1bc20d83
GM
3914 `(push ',var current-load-list))
3915 (when (> (length form) 3)
3916 (when (and string (not (stringp string)))
1d5c17c0 3917 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
1bc20d83
GM
3918 fun var string))
3919 `(put ',var 'variable-documentation ,string))
fef3407e 3920 (if (cddr form) ; `value' provided
6b61353c
KH
3921 (let ((byte-compile-not-obsolete-var var))
3922 (if (eq fun 'defconst)
3923 ;; `defconst' sets `var' unconditionally.
3924 (let ((tmp (make-symbol "defconst-tmp-var")))
3925 `(funcall '(lambda (,tmp) (defconst ,var ,tmp))
3926 ,value))
3927 ;; `defvar' sets `var' only when unbound.
3928 `(if (not (default-boundp ',var)) (setq-default ,var ,value))))
6c2161c4
SM
3929 (when (eq fun 'defconst)
3930 ;; This will signal an appropriate error at runtime.
3931 `(eval ',form)))
1bc20d83 3932 `',var))))
1c393159
JB
3933
3934(defun byte-compile-autoload (form)
ccb3c8de 3935 (byte-compile-set-symbol-position 'autoload)
1c393159
JB
3936 (and (byte-compile-constp (nth 1 form))
3937 (byte-compile-constp (nth 5 form))
3938 (eval (nth 5 form)) ; macro-p
3939 (not (fboundp (eval (nth 1 form))))
3940 (byte-compile-warn
c5091f25 3941 "The compiler ignores `autoload' except at top level. You should
1c393159
JB
3942 probably put the autoload of the macro `%s' at top-level."
3943 (eval (nth 1 form))))
3944 (byte-compile-normal-call form))
3945
c5091f25 3946;; Lambdas in valid places are handled as special cases by various code.
1c393159
JB
3947;; The ones that remain are errors.
3948(defun byte-compile-lambda-form (form)
ccb3c8de 3949 (byte-compile-set-symbol-position 'lambda)
1c393159
JB
3950 (error "`lambda' used as function name is invalid"))
3951
5286a842 3952;; Compile normally, but deal with warnings for the function being defined.
977b50fb
SM
3953(put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
3954(defun byte-compile-file-form-defalias (form)
5286a842
RS
3955 (if (and (consp (cdr form)) (consp (nth 1 form))
3956 (eq (car (nth 1 form)) 'quote)
3957 (consp (cdr (nth 1 form)))
a7a7ddf1
RS
3958 (symbolp (nth 1 (nth 1 form))))
3959 (let ((constant
3960 (and (consp (nthcdr 2 form))
3961 (consp (nth 2 form))
3962 (eq (car (nth 2 form)) 'quote)
3963 (consp (cdr (nth 2 form)))
3964 (symbolp (nth 1 (nth 2 form))))))
6c2161c4 3965 (byte-compile-defalias-warn (nth 1 (nth 1 form)))
977b50fb
SM
3966 (push (cons (nth 1 (nth 1 form))
3967 (if constant (nth 1 (nth 2 form)) t))
3968 byte-compile-function-environment)))
b7a5a208
SM
3969 ;; We used to jus do: (byte-compile-normal-call form)
3970 ;; But it turns out that this fails to optimize the code.
3971 ;; So instead we now do the same as what other byte-hunk-handlers do,
3972 ;; which is to call back byte-compile-file-form and then return nil.
3973 ;; Except that we can't just call byte-compile-file-form since it would
3974 ;; call us right back.
3975 (byte-compile-keep-pending form)
3976 ;; Return nil so the form is not output twice.
3977 nil)
5286a842
RS
3978
3979;; Turn off warnings about prior calls to the function being defalias'd.
3980;; This could be smarter and compare those calls with
3981;; the function it is being aliased to.
6c2161c4 3982(defun byte-compile-defalias-warn (new)
5286a842
RS
3983 (let ((calls (assq new byte-compile-unresolved-functions)))
3984 (if calls
3985 (setq byte-compile-unresolved-functions
3986 (delq calls byte-compile-unresolved-functions)))))
3c9dc1cf
RS
3987
3988(byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
3989(defun byte-compile-no-warnings (form)
3990 (let (byte-compile-warnings)
a4f66531 3991 (byte-compile-form (cons 'progn (cdr form)))))
01e4a4fa
SM
3992
3993;; Warn about misuses of make-variable-buffer-local.
3994(byte-defop-compiler-1 make-variable-buffer-local byte-compile-make-variable-buffer-local)
3995(defun byte-compile-make-variable-buffer-local (form)
15ce9dcf 3996 (if (and (eq (car-safe (car-safe (cdr-safe form))) 'quote)
cf637a34 3997 (byte-compile-warning-enabled-p 'make-local))
01e4a4fa
SM
3998 (byte-compile-warn
3999 "`make-variable-buffer-local' should be called at toplevel"))
4000 (byte-compile-normal-call form))
4001(put 'make-variable-buffer-local
4002 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
4003(defun byte-compile-form-make-variable-buffer-local (form)
4004 (byte-compile-keep-pending form 'byte-compile-normal-call))
4005
1c393159
JB
4006\f
4007;;; tags
4008
4009;; Note: Most operations will strip off the 'TAG, but it speeds up
4010;; optimization to have the 'TAG as a part of the tag.
4011;; Tags will be (TAG . (tag-number . stack-depth)).
4012(defun byte-compile-make-tag ()
4013 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
4014
4015
4016(defun byte-compile-out-tag (tag)
4017 (setq byte-compile-output (cons tag byte-compile-output))
4018 (if (cdr (cdr tag))
4019 (progn
4020 ;; ## remove this someday
4021 (and byte-compile-depth
4022 (not (= (cdr (cdr tag)) byte-compile-depth))
52799cb8 4023 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
1c393159
JB
4024 (setq byte-compile-depth (cdr (cdr tag))))
4025 (setcdr (cdr tag) byte-compile-depth)))
4026
4027(defun byte-compile-goto (opcode tag)
6c2161c4 4028 (push (cons opcode tag) byte-compile-output)
1c393159
JB
4029 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
4030 (1- byte-compile-depth)
4031 byte-compile-depth))
4032 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
4033 (1- byte-compile-depth))))
4034
4035(defun byte-compile-out (opcode offset)
6c2161c4 4036 (push (cons opcode offset) byte-compile-output)
1c393159
JB
4037 (cond ((eq opcode 'byte-call)
4038 (setq byte-compile-depth (- byte-compile-depth offset)))
4039 ((eq opcode 'byte-return)
4040 ;; This is actually an unnecessary case, because there should be
4041 ;; no more opcodes behind byte-return.
4042 (setq byte-compile-depth nil))
4043 (t
4044 (setq byte-compile-depth (+ byte-compile-depth
4045 (or (aref byte-stack+-info
4046 (symbol-value opcode))
4047 (- (1- offset))))
4048 byte-compile-maxdepth (max byte-compile-depth
4049 byte-compile-maxdepth))))
52799cb8 4050 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
1c393159
JB
4051 )
4052
4053\f
4054;;; call tree stuff
4055
4056(defun byte-compile-annotate-call-tree (form)
4057 (let (entry)
4058 ;; annotate the current call
4059 (if (setq entry (assq (car form) byte-compile-call-tree))
4060 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
4061 (setcar (cdr entry)
4062 (cons byte-compile-current-form (nth 1 entry))))
4063 (setq byte-compile-call-tree
4064 (cons (list (car form) (list byte-compile-current-form) nil)
4065 byte-compile-call-tree)))
4066 ;; annotate the current function
4067 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
4068 (or (memq (car form) (nth 2 entry)) ;called
4069 (setcar (cdr (cdr entry))
4070 (cons (car form) (nth 2 entry))))
4071 (setq byte-compile-call-tree
4072 (cons (list byte-compile-current-form nil (list (car form)))
4073 byte-compile-call-tree)))
4074 ))
4075
52799cb8
RS
4076;; Renamed from byte-compile-report-call-tree
4077;; to avoid interfering with completion of byte-compile-file.
fd5285f3 4078;;;###autoload
52799cb8
RS
4079(defun display-call-tree (&optional filename)
4080 "Display a call graph of a specified file.
4081This lists which functions have been called, what functions called
4082them, and what functions they call. The list includes all functions
4083whose definitions have been compiled in this Emacs session, as well as
4084all functions called by those functions.
1c393159 4085
52799cb8
RS
4086The call graph does not include macros, inline functions, or
4087primitives that the byte-code interpreter knows about directly \(eq,
4088cons, etc.\).
1c393159
JB
4089
4090The call tree also lists those functions which are not known to be called
52799cb8
RS
4091\(that is, to which no calls have been compiled\), and which cannot be
4092invoked interactively."
1c393159
JB
4093 (interactive)
4094 (message "Generating call tree...")
4095 (with-output-to-temp-buffer "*Call-Tree*"
4096 (set-buffer "*Call-Tree*")
4097 (erase-buffer)
47cf9d3a 4098 (message "Generating call tree... (sorting on %s)"
1c393159
JB
4099 byte-compile-call-tree-sort)
4100 (insert "Call tree for "
4101 (cond ((null byte-compile-current-file) (or filename "???"))
4102 ((stringp byte-compile-current-file)
4103 byte-compile-current-file)
4104 (t (buffer-name byte-compile-current-file)))
4105 " sorted on "
4106 (prin1-to-string byte-compile-call-tree-sort)
4107 ":\n\n")
4108 (if byte-compile-call-tree-sort
4109 (setq byte-compile-call-tree
4110 (sort byte-compile-call-tree
4111 (cond ((eq byte-compile-call-tree-sort 'callers)
4112 (function (lambda (x y) (< (length (nth 1 x))
4113 (length (nth 1 y))))))
4114 ((eq byte-compile-call-tree-sort 'calls)
4115 (function (lambda (x y) (< (length (nth 2 x))
4116 (length (nth 2 y))))))
4117 ((eq byte-compile-call-tree-sort 'calls+callers)
4118 (function (lambda (x y) (< (+ (length (nth 1 x))
4119 (length (nth 2 x)))
4120 (+ (length (nth 1 y))
4121 (length (nth 2 y)))))))
4122 ((eq byte-compile-call-tree-sort 'name)
4123 (function (lambda (x y) (string< (car x)
4124 (car y)))))
52799cb8 4125 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
1c393159
JB
4126 byte-compile-call-tree-sort))))))
4127 (message "Generating call tree...")
4128 (let ((rest byte-compile-call-tree)
4129 (b (current-buffer))
4130 f p
4131 callers calls)
4132 (while rest
4133 (prin1 (car (car rest)) b)
4134 (setq callers (nth 1 (car rest))
4135 calls (nth 2 (car rest)))
4136 (insert "\t"
4137 (cond ((not (fboundp (setq f (car (car rest)))))
4138 (if (null f)
4139 " <top level>";; shouldn't insert nil then, actually -sk
4140 " <not defined>"))
4141 ((subrp (setq f (symbol-function f)))
4142 " <subr>")
4143 ((symbolp f)
4144 (format " ==> %s" f))
ed015bdd 4145 ((byte-code-function-p f)
1c393159
JB
4146 "<compiled function>")
4147 ((not (consp f))
4148 "<malformed function>")
4149 ((eq 'macro (car f))
ed015bdd 4150 (if (or (byte-code-function-p (cdr f))
1c393159
JB
4151 (assq 'byte-code (cdr (cdr (cdr f)))))
4152 " <compiled macro>"
4153 " <macro>"))
4154 ((assq 'byte-code (cdr (cdr f)))
4155 "<compiled lambda>")
4156 ((eq 'lambda (car f))
4157 "<function>")
4158 (t "???"))
4159 (format " (%d callers + %d calls = %d)"
4160 ;; Does the optimizer eliminate common subexpressions?-sk
4161 (length callers)
4162 (length calls)
4163 (+ (length callers) (length calls)))
4164 "\n")
4165 (if callers
4166 (progn
4167 (insert " called by:\n")
4168 (setq p (point))
4169 (insert " " (if (car callers)
4170 (mapconcat 'symbol-name callers ", ")
4171 "<top level>"))
4172 (let ((fill-prefix " "))
78bba1c8
TTN
4173 (fill-region-as-paragraph p (point)))
4174 (unless (= 0 (current-column))
4175 (insert "\n"))))
1c393159
JB
4176 (if calls
4177 (progn
4178 (insert " calls:\n")
4179 (setq p (point))
4180 (insert " " (mapconcat 'symbol-name calls ", "))
4181 (let ((fill-prefix " "))
78bba1c8
TTN
4182 (fill-region-as-paragraph p (point)))
4183 (unless (= 0 (current-column))
4184 (insert "\n"))))
1c393159
JB
4185 (setq rest (cdr rest)))
4186
4187 (message "Generating call tree...(finding uncalled functions...)")
4188 (setq rest byte-compile-call-tree)
4189 (let ((uncalled nil))
4190 (while rest
4191 (or (nth 1 (car rest))
4192 (null (setq f (car (car rest))))
a7a7ddf1 4193 (functionp (byte-compile-fdefinition f t))
1c393159
JB
4194 (commandp (byte-compile-fdefinition f nil))
4195 (setq uncalled (cons f uncalled)))
4196 (setq rest (cdr rest)))
4197 (if uncalled
4198 (let ((fill-prefix " "))
4199 (insert "Noninteractive functions not known to be called:\n ")
4200 (setq p (point))
4201 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
4202 (fill-region-as-paragraph p (point)))))
4203 )
4204 (message "Generating call tree...done.")
4205 ))
4206
4207\f
814c447f 4208;;;###autoload
7e7d0f8b
RS
4209(defun batch-byte-compile-if-not-done ()
4210 "Like `byte-compile-file' but doesn't recompile if already up to date.
4211Use this from the command line, with `-batch';
4212it won't work in an interactive Emacs."
4213 (batch-byte-compile t))
4214
1c393159
JB
4215;;; by crl@newton.purdue.edu
4216;;; Only works noninteractively.
fd5285f3 4217;;;###autoload
7e7d0f8b 4218(defun batch-byte-compile (&optional noforce)
52799cb8
RS
4219 "Run `byte-compile-file' on the files remaining on the command line.
4220Use this from the command line, with `-batch';
4221it won't work in an interactive Emacs.
4222Each file is processed even if an error occurred previously.
7e7d0f8b
RS
4223For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4224If NOFORCE is non-nil, don't recompile a file that seems to be
4225already up-to-date."
1c393159
JB
4226 ;; command-line-args-left is what is left of the command line (from startup.el)
4227 (defvar command-line-args-left) ;Avoid 'free variable' warning
4228 (if (not noninteractive)
52799cb8 4229 (error "`batch-byte-compile' is to be used only with -batch"))
1c393159
JB
4230 (let ((error nil))
4231 (while command-line-args-left
4232 (if (file-directory-p (expand-file-name (car command-line-args-left)))
7e7d0f8b 4233 ;; Directory as argument.
1c393159
JB
4234 (let ((files (directory-files (car command-line-args-left)))
4235 source dest)
d90a41e8
SS
4236 (dolist (file files)
4237 (if (and (string-match emacs-lisp-file-regexp file)
4238 (not (auto-save-file-name-p file))
4239 (setq source (expand-file-name file
1c393159
JB
4240 (car command-line-args-left)))
4241 (setq dest (byte-compile-dest-file source))
4242 (file-exists-p dest)
4243 (file-newer-than-file-p source dest))
4244 (if (null (batch-byte-compile-file source))
d90a41e8 4245 (setq error t)))))
7e7d0f8b
RS
4246 ;; Specific file argument
4247 (if (or (not noforce)
4248 (let* ((source (car command-line-args-left))
4249 (dest (byte-compile-dest-file source)))
4250 (or (not (file-exists-p dest))
4251 (file-newer-than-file-p source dest))))
4252 (if (null (batch-byte-compile-file (car command-line-args-left)))
4253 (setq error t))))
1c393159 4254 (setq command-line-args-left (cdr command-line-args-left)))
1c393159
JB
4255 (kill-emacs (if error 1 0))))
4256
4257(defun batch-byte-compile-file (file)
6b61353c 4258 (if debug-on-error
1c57117e 4259 (byte-compile-file file)
6b61353c
KH
4260 (condition-case err
4261 (byte-compile-file file)
4262 (file-error
4263 (message (if (cdr err)
4264 ">>Error occurred processing %s: %s (%s)"
d09b1c02 4265 ">>Error occurred processing %s: %s")
6b61353c
KH
4266 file
4267 (get (car err) 'error-message)
4268 (prin1-to-string (cdr err)))
4269 (let ((destfile (byte-compile-dest-file file)))
4270 (if (file-exists-p destfile)
4271 (delete-file destfile)))
4272 nil)
4273 (error
4274 (message (if (cdr err)
4275 ">>Error occurred processing %s: %s (%s)"
1c393159 4276 ">>Error occurred processing %s: %s")
6b61353c
KH
4277 file
4278 (get (car err) 'error-message)
4279 (prin1-to-string (cdr err)))
4280 nil))))
1c393159 4281
e9681c45 4282;;;###autoload
6f8e3590 4283(defun batch-byte-recompile-directory (&optional arg)
4f6d5bf0 4284 "Run `byte-recompile-directory' on the dirs remaining on the command line.
79c6071d 4285Must be used only with `-batch', and kills Emacs on completion.
defe3b41
EZ
4286For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4287
4288Optional argument ARG is passed as second argument ARG to
516b3653 4289`byte-recompile-directory'; see there for its possible values
defe3b41 4290and corresponding effects."
e27c3564
JB
4291 ;; command-line-args-left is what is left of the command line (startup.el)
4292 (defvar command-line-args-left) ;Avoid 'free variable' warning
4293 (if (not noninteractive)
4294 (error "batch-byte-recompile-directory is to be used only with -batch"))
4295 (or command-line-args-left
4296 (setq command-line-args-left '(".")))
4297 (while command-line-args-left
6f8e3590 4298 (byte-recompile-directory (car command-line-args-left) arg)
e27c3564
JB
4299 (setq command-line-args-left (cdr command-line-args-left)))
4300 (kill-emacs 0))
4301
1c393159 4302(provide 'byte-compile)
200503bb 4303(provide 'bytecomp)
1c393159
JB
4304
4305\f
4306;;; report metering (see the hacks in bytecode.c)
4307
08d21785 4308(defvar byte-code-meter)
52799cb8 4309(defun byte-compile-report-ops ()
52799cb8
RS
4310 (with-output-to-temp-buffer "*Meter*"
4311 (set-buffer "*Meter*")
4312 (let ((i 0) n op off)
4313 (while (< i 256)
4314 (setq n (aref (aref byte-code-meter 0) i)
4315 off nil)
4316 (if t ;(not (zerop n))
4317 (progn
4318 (setq op i)
4319 (setq off nil)
4320 (cond ((< op byte-nth)
4321 (setq off (logand op 7))
4322 (setq op (logand op 248)))
4323 ((>= op byte-constant)
4324 (setq off (- op byte-constant)
4325 op byte-constant)))
4326 (setq op (aref byte-code-vector op))
4327 (insert (format "%-4d" i))
4328 (insert (symbol-name op))
4329 (if off (insert " [" (int-to-string off) "]"))
4330 (indent-to 40)
4331 (insert (int-to-string n) "\n")))
4332 (setq i (1+ i))))))
1c393159
JB
4333\f
4334;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4335;; itself, compile some of its most used recursive functions (at load time).
4336;;
4337(eval-when-compile
591655c7
SM
4338 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4339 (assq 'byte-code (symbol-function 'byte-compile-form))
4340 (let ((byte-optimize nil) ; do it fast
4341 (byte-compile-warnings nil))
86da2828
GM
4342 (mapc (lambda (x)
4343 (or noninteractive (message "compiling %s..." x))
4344 (byte-compile x)
4345 (or noninteractive (message "compiling %s...done" x)))
4346 '(byte-compile-normal-call
4347 byte-compile-form
4348 byte-compile-body
4349 ;; Inserted some more than necessary, to speed it up.
4350 byte-compile-top-level
4351 byte-compile-out-toplevel
4352 byte-compile-constant
4353 byte-compile-variable-ref))))
591655c7 4354 nil)
fd5285f3 4355
3433c43f
DL
4356(run-hooks 'bytecomp-load-hook)
4357
977b50fb 4358;; arch-tag: 9c97b0f0-8745-4571-bfc3-8dceb677292a
fd5285f3 4359;;; bytecomp.el ends here