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