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